Java: How can I create good looking class docs with Javadoc?

Question

I'd like to create HTML documentation for a Java class library that includes

programming guide information - beyond just a class reference
code examples in the reference doc
collapsible regions

I want it to look well-styled. Something like this:

I think that Javadoc exposes a doclet API that allows other parties to provide doc generation integrated in Javadoc. Is there a doclet option that I can use (for free) that does something a little nicer than the standard javadoc output?

I tried googling for this but no luck. Suggestions?

Addendum
I found doclet.com but I don't know how to evaluate the options. Recommendations?

In particular, XHtmlDoclet sounds like it wants to address these issues. Anyone used it? I can't get it to work. Also the example offered by the XHTML Doclet guys doesn't look any better than the docs generated from c.1998 javadoc .

Related:
Why does Javadoc generate non-compliant XHTML?

score 1 · Answer 1 · edited Nov 23 '13 at 09:14

1

Perhaps you're thinking of Java doclet API:

http://www.oracle.com/technetwork/java/javase/documentation/index-jsp-135444.html

It appears that you're adding examples and some text. I think it's entirely possible with existing javadocs. The problem will be the content rather than the rendering.

Castor used doclet to ease its config burden. So did EJB 1.0. Take a look at those if you'd like.

edited Nov 23 '13 at 09:14

Afshin Moazami

2,092
5
33
55

answered Mar 28 '10 at 15:44

duffymo

305,152
44
369
561

Changing the CSS should be trivial too. – Donal Fellows Mar 28 '10 at 15:52
@dummymo: Well the doclet API allows additional doclet engines as far as I know. In other words the generation is pluggable. I'm asking, what other doclets have been produced for generating API and guidance docs? @donal, ok, sounds easy. How? – Cheeso Mar 28 '10 at 15:53
You've got the output files, and javadoc uses a single CSS file in the root directory of the generated tree. If you can't work it out from there, I despair... ;–) – Donal Fellows Mar 28 '10 at 16:21
@Cheeso, why the switch to "dummymo"? Not a good way to convince people to give you their best. – duffymo Mar 28 '10 at 16:30
sorry, typo. my mistake. not intentional. – Cheeso Mar 28 '10 at 16:32
I'm not buying it. "m" isn't close to "f" on my keyboard. – duffymo Mar 28 '10 at 16:36
Ah, it's your choice whether to believe me or not! – Cheeso Mar 28 '10 at 21:45
That's right, it is, and I don't. I've formulated another belief instead. – duffymo Mar 28 '10 at 22:56

score 1 · Accepted Answer · answered Mar 28 '10 at 18:24

1

This question got me thinking (ok, Googling) and I stumbled on this set of taglets. Never tried it, but it looks pretty promising.

answered Mar 28 '10 at 18:24

ig0774

39,669
3
55
57

Java: How can I create good looking class docs with Javadoc?

2 Answers2