Are there some good and modern alternatives to Javadoc?

ivan_ivanovich_ivanoff picture ivan_ivanovich_ivanoff · Jun 22, 2009 · Viewed 15.1k times · Source

Let's face it: You don't need to be a designer to see that default Javadoc looks ugly.

There are some resources on the web which offer re-styled Javadoc. But the default behaviour represents the product and should be as reasonably good-looking.

Another problem is the fact that the usability of Javadoc is not up-to-date compared to other similar resources.

Especially huge projects are hard to navigate using Firefox's quick search.

Practical question:
Are there any standalone (desktop) applications which are able to browse existing Javadoc in a more usable way than a browser would?
I'm thinking about something like Mono's documentation browser.

Theoretical question:
Does anyone know, if there some plans to evolve Javadoc, in a somehow-standardized way?
EDIT: A useful link to Sun' wiki on this topic.

Answer

Richard Nichols picture Richard Nichols · Jun 25, 2009

I have created a Markdown (java) Doclet which will take source comments in Markdown formatted text and create the same HTML Javadocs.

The new doclet also does some restyling on the text, but the HTML generated is not changed at this stage.

That goes some way to address the HTML-in-java-commenting issues which is probably the biggest usability problem with current Javadoc.