As far as I can see from the front page (Roadmap panel) it doesn't yet
support JavaDoc as a style, which is a shame...

   What doesn't it support?

This is cut and pasted directly from the NaturalDocs documentation:

--------------------------------------------------
/*
* Function: Multiply
* Multiplies two integers and returns the result.
*/

and

/*
  Function: Multiply

  Multiplies two integers.

  Parameters:

     x - The first integer.
     y - The second integer.

  Returns:

     The two integers multiplied together.

  See Also:

     <Divide>
*/
--------------------------------------------------

   This was cut and pasted directly from the Sun spec on javadoc comments:

--------------------------------------------------
   /**
    * Registers the text to display in a tool tip.   The text
    * displays when the cursor lingers over the component.
    *
    * @param text  the string to display.  If the text is null,
    *              the tool tip is turned off for this component.
    */
--------------------------------------------------

The whole idea of NaturalDocs is that it doesn't care what style of comments you use, it will work with almost any style.

All that said, if you look around I'm sure you can find a number of open source documentation generators based on the javadoc comment style.

ryanm
_______________________________________________
Flashcoders mailing list
[email protected]
http://chattyfig.figleaf.com/mailman/listinfo/flashcoders

Reply via email to