Win a copy of The Little Book of Impediments (e-book only) this week in the Agile and Other Processes forum!
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic

Javadoc

 
Rick Fortier
Ranch Hand
Posts: 147
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
I figured out how to run javadoc to create my documentation for a single directory. How do I get it to go into all of my directories and link them all together?
 
Rick Fortier
Ranch Hand
Posts: 147
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
I will answer my own post since I figured it out.
What I did was create a file which contained a list of all my classes named packages.txt.
Then my script was:
<pre><code>javadoc -author -version -link http://java.sun.com/j2se/1.3/docs/api -d docs -title MyTitle @packages.txt</code></pre>
This created an index.html in my docs directory, and created an html for each class under docs and then provided links to Sun for classes such as String, Object, Remote, etc...
Any comments? Good? Bad?
[This message has been edited by Rick Fortier (edited June 23, 2001).]
[This message has been edited by Rick Fortier (edited June 23, 2001).]
 
Anonymous
Ranch Hand
Posts: 18944
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
the -title option doesn�t work on javadoc 1.3. Other option I recommend is -overview overview.html (for example), which allows you to write a summary of all your packages. Check out "How to write javadoc comments" on Sun, for further information....
Hope this helps!!!
Benjam�n
[This message has been edited by Benjam�n Amodio (edited June 24, 2001).]
 
Kalichar Rangantittu
Ranch Hand
Posts: 240
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Do we need to javadoc private members/variables etc? I see its done in many of sun's code but dont know what the damn examiner would think. It is more informative documenting the variables but dont know the choice to make.
 
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic