[Javagit-devel] JavaDoc Information and

[James L. <jh...@ny...>]

Hi All,

Since we are writing an API and the API documentation is of great  
importance, I looked around for some information on how Sun does  
documentation for Java itself and for more detailed information on how  
to use JavaDocs.  The following links are quite good.


javadoc - The Java API Documentation Generator
  http://java.sun.com/j2se/1.5.0/docs/tooldocs/solaris/javadoc.html

How to Write Doc Comments for the Javadoc Tool
  http://java.sun.com/j2se/javadoc/writingdoccomments/index.html

Requirements for Writing Java API Specifications
  http://java.sun.com/j2se/javadoc/writingapispecs/index.html


Cheers,

James