Win a copy of Murach's Python Programming this week in the Jython/Python forum!
  • Post Reply Bookmark Topic Watch Topic
  • New Topic

Help - Java docs  RSS feed

 
Roberto Favaro
Greenhorn
Posts: 24
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
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
Posts: 1392
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
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
Posts: 24
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Thanks.Any idea how to use it .Make it read my code and then print the docs?
 
Hentay Duke
Ranch Hand
Posts: 198
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
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
Posts: 3061
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
If you follow the link that Joyce gave, there is plenty of information to get you started using this tool.

Layne
 
Don't get me started about those stupid light bulbs.
  • Post Reply Bookmark Topic Watch Topic
  • New Topic
Boost this thread!