wood burning stoves*
The moose likes Beginning Java and the fly likes Help - Java docs Big Moose Saloon
  Search | Java FAQ | Recent Topics | Flagged Topics | Hot Topics | Zero Replies
Register / Login


Win a copy of Spring in Action this week in the Spring forum!
JavaRanch » Java Forums » Java » Beginning Java
Bookmark "Help - Java docs" Watch "Help - Java docs" New topic
Author

Help - Java docs

Roberto Favaro
Greenhorn

Joined: Mar 23, 2004
Posts: 24
I hear there's a program which writes the documentation for a particular piece of code.

Anyone know what its called or where I can find it
Joyce Lee
Ranch Hand

Joined: Jul 11, 2003
Posts: 1392
Hi Roberto,

Is it the Javadoc Tool you're looking for? It is a tool for generating API documentation in HTML format from doc comments in source code.

Joyce
[ November 02, 2004: Message edited by: Joyce Lee ]
Roberto Favaro
Greenhorn

Joined: Mar 23, 2004
Posts: 24
Thanks.Any idea how to use it .Make it read my code and then print the docs?
Hentay Duke
Ranch Hand

Joined: Oct 27, 2004
Posts: 198
I believe you'll still have to write the javadoc comments yourself. The tool will use your comments to create an API looking html file I think (never actually used it myself).
Layne Lund
Ranch Hand

Joined: Dec 06, 2001
Posts: 3061
If you follow the link that Joyce gave, there is plenty of information to get you started using this tool.

Layne


Java API Documentation
The Java Tutorial
 
It is sorta covered in the JavaRanch Style Guide.
 
subject: Help - Java docs