Take the 2-minute tour ×
Programmers Stack Exchange is a question and answer site for professional programmers interested in conceptual questions about software development. It's 100% free, no registration required.

I want to automatically generate documentation for a java project, but I'd like to have my own custom styling for it.

As an example, take the stackoverflow api (method description page), can that be done by an automated tool? Can it "take me close" to that?
I wouldn't mind having to manually change a few things to achieve the result I want (ie: it doesn't have to be 100% automated)

share|improve this question
    
NaturalDocs and Doxygen are pretty configurable. I admit I never really stray past the default formatting because it's usually good enough, but it's probably possible. –  FrustratedWithFormsDesigner Jul 8 '11 at 19:44
    
Doxygen seems pretty good, have you used that one? Did you have any problems? –  jmfsg Jul 8 '11 at 20:02
    
I used it a long time ago for C++ (not Java). It was good, but I didn't try any customization, just ran it "out-of-the-box" and it was good enough. I haven't looked, but maybe you can even customize the output of javadoc, might be as simple as an XSL or CSS file... EDIT: here ya go! download.oracle.com/javase/1.4.2/docs/tooldocs/javadoc/… –  FrustratedWithFormsDesigner Jul 8 '11 at 20:04
    
@fru, nice options. Please submit it as an answer so I can accept it. –  jmfsg Jul 8 '11 at 20:11

2 Answers 2

up vote 3 down vote accepted

Doxygen and NaturalDocs are both customizable alternatives to Javadoc. Javadoc can also be customized, as is described here: http://download.oracle.com/javase/1.4.2/docs/tooldocs/javadoc/overview.html

...though be warned, I have never attempted this myself, I only found it via web search for "javadoc customize output".

share|improve this answer

As Frustrated notes, a Doclet allows you to customize the the existing Javadoc mechanisms. Doing "Javadoc with a twist" probably has some benefits in terms of IDE integration too.

In particular, given the use of markdown on stackexchange sites, you may want ot see this one that handles markdown, which may be some useful code to look at even if it isn't the formatting rules you want.

share|improve this answer

Your Answer

 
discard

By posting your answer, you agree to the privacy policy and terms of service.

Not the answer you're looking for? Browse other questions tagged or ask your own question.