PDA

View Full Version : documentation tips




whitehexagon
Jan 26, 2008, 01:19 PM
Hi all,

I'm doing some Java development under OSX and looking for some tools (preferably free) and tips for documenting the design.

Mostly I'm thinking something to capture some class diagrams in UML format, some DB schema or ERD capture and something just for documenting the design. Although for the last items I'm kinda of happy using a wiki approach. So would need the above to export PNG for import into the wiki pages.

What are other people using?

Cheers

Peter



Eraserhead
Jan 26, 2008, 01:22 PM
its Java so javadoc (http://java.sun.com/j2se/javadoc/).

whitehexagon
Jan 26, 2008, 01:43 PM
I find javadoc a bit limiting, fine for class level documentation, but not the best beyond that. And I still need something for the diagramming.

Cheers
Peter

PS something eclipse compatible would also be a bonus :)

yeroen
Jan 26, 2008, 02:31 PM
Doxygen and Graphiz are what you want. Both of them have plugin frontends for Eclipse.

crees!
Jan 27, 2008, 09:04 AM
You try GModeler (http://www.gmodeler.com). It's web-based and you can export it as XML. May or may not be all you're looking for.

whitehexagon
Jan 27, 2008, 10:50 AM
Thanks for the tips all! GraphWiz looked useful but gave a bad number in class file error. Someone also suggested Draw from open office which I trying out as well. cheers.