Richard has posted 4 posts at DZone. View Full User Profile

Markdown-Doclet (GPL2)

  • submit to reddit

Markdown-Doclet is a replacement for the standard Sun Java Doclet which allows developers to use Markdown syntax (which is friendly and human readable) in their Javadoc comments rather than embedding unreadable HTML.

Another advantage of Markdown is that the syntax allows for HTML to be passed through, allowing the Markdown doclet to be applied to any existing codebase which may contain HTML Javadoc comments.

The doclet also writes a more modern stylesheet for more attractive Javadocs and includes a patched version of UMLGraph which calls the Markdown Doclet instead of the Sun standard doclet.

Published at DZone with permission of its author, Richard Nichols.

(Note: Opinions expressed in this article and its replies are the opinions of their respective authors and not those of DZone, Inc.)