Java Documentation

ravian · #1 (**permalink**) 12-02-2007, 11:51 PM

Hi everyone,

I got a project and it has java documentation which is very much like Java API specifications at:
Java 2 Platform SE v1.4.2

I am not sure how this was done? Is there some HTML tool for this?

Thanks for your help/time.

wsaryada · #2 (**permalink**) 12-03-2007, 03:30 PM

You can generate such documentation using javadoc tools. Most IDE have this functionality integrated. But to make the documentation generated you need add the document inside your java code. For further detail how to document your code see How to Write Doc Comments for the Javadoc Tool

mew · #3 (**permalink**) 12-03-2007, 07:19 PM

where to find javadoc tool? It comes with IDE or JDK?

wsaryada · #4 (**permalink**) 12-04-2007, 02:19 AM

Yes it comes with the JDK under the bin folder you'll find the javadoc tool. If you use eclipse you can find it in the Project sub menu.

ravian · #5 (**permalink**) 12-04-2007, 11:45 AM

Thank you all of you.
Javadoc sure is a good tool.