views:

96

answers:

3

I've a java project which needs some documentation, is Doxygen the only way to go ?

I would like to document the code but also the architecture, the Makefiles, in 3 words, the whole project.

Maybe I should orient myself to eclipsewiki or something like that.

Any help would be appreciated.

+4  A: 

The easiest thing to use is JavaDoc. It has always worked great for me.

ChadNC
Stuff that isn't directly related to a specific class or method can go in package or overview files.
Rasmus Kaj
+1  A: 

Javadoc would probably be a better choice. You can enhance it by writing custom doclets to perform the additional documentation tasks you require.

Matthew Murdoch
+1  A: 

You can use JavaDoc, and include an overview.html. Personally, I've started writing everything using Sphinx. It creates beautiful documentation. It can create API documentation for Python, but I've used it more for curreated, hand-written documentation for projects in other languages.

John Paulett