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

how to gernarate index.html

 
kevin chang
Ranch Hand
Posts: 64
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
i am working on my javadoc, i wrote all the pages connected to every class. but i still wondering how to gernarate an index page or a help page!
 
Andrew Monkhouse
author and jackaroo
Marshal Commander
Pie
Posts: 12014
220
C++ Firefox Browser IntelliJ IDE Java Mac Oracle
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi Kevin,
Have you looked at the documentation for the javadoc program?
This link (JavaDoc Tool Home Page) will give you the Sun FAQ on Javadoc, information on how to write doc comments, javadoc documentation for the different versions of the JDK, and lots more.
For others writing their code at the moment, you may be interested in looking at the DocCheck doclet (link is on the page above) - aparently it is what Sun use to verify that their javadoc comments are up to scratch - gives a very nice output showing where your errors are, from high level (package 'x' has 'y' critical and 'z' minor errors) down to the low level 'Class 'j', method 'k' has problem 'l'. You will get reports on issues you never even thought of.
The javadoc program should generate all your javadoc pages and indexes for you. You should not have to manually write any of them.
Your user help, on the other hand, does have to be manually written, but there is nothing to say that it has to be in HTML format - you could give a plain text file describing how to use your programs.
Regards, Andrew
 
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic