Overview (SinjDoc 0.5 documentation)

This document is the API specification for version 0.3 of the SinjDoc tool, which is a javadoc replacement that handles JSR-14 (generic java) source code.

Packages
net.cscott.sinjdoc	Javadoc tool for parameterized java (JSR-14, aka "Java 1.5").
net.cscott.sinjdoc.html	This package contains the "standard" HTML `Doclet` for the SinjDoc tool.
net.cscott.sinjdoc.lexer	This package contains a lexer for java source which supports the parser in the `net.cscott.sinjdoc.parser` package.
net.cscott.sinjdoc.parser	This package contains the main java source file parsing code for the SinjDoc tool.

Description:

This document is the API specification for version 0.3 of the SinjDoc tool, which is a javadoc replacement that handles JSR-14 (generic java) source code. SinjDoc defines a 'Doclet' and 'Taglet' interface similar to, but not identical with, that defined by Sun's javadoc tool. Some incompatibilities are forced by the addition of parameterized types, and others were introduced to clean up or restructure the interface in places where I found it lacking.

More information about SinjDoc can be found at http://cag.lcs.mit.edu/~cananian/Projects/GJ/.

Author: C. Scott Ananian (cscott@cscott.net)