external documentation for JAVA program

[graham]

I need to write some external documentation for a JAVA program.

can anyone give me some pointers, or otherwise point me to a website that has some examples of such documentation, etc.

Thanks in advance :)

[lg_alucard]

pffft, who needs to write external documentation for a java program??? ;p

use the javadoc utility, you use it like javac only javadoc PROGRAMNAME.java... you just have to type up your comments in a certain way (I don't use it but its something like /**...*/) and it makes a neat HTML documentation table thingy... named PROGRAMNAME.html.

I'm fairly certain that javadoc comes w/ the stuff you dled to be able to compile java and is in the same bin directory as the javac file.

[dustpuppy]

If you have a Linux box, or are using Fink, use your download bi*ch to get doxygen.  I am not sure if the Fink version is already built to use graphvis.  If it is, you are in luck.

Why Doxygen.  It owns any type of auto documenting system out there incluiding JavaDoc.  If you need to build UML diagrams including class diagrams, sequences, etc. It can automatically build them based upon your source files.  It is a little more difficult to use than javadoc, but then again, javadoc blows goats for a living.

[Panda]

bi*ch

 :shock: *twitches*  :shock:
Either say it or don't damnit!!! :evil:

[dustpuppy]

Sorry, was feeling in a strange mood.

It's work.  A strange place where the management believe development should be run by commitee and developers, such as myself, can't possibly understand the issues.  Worse than that, we seem to have raided the idiot farm to get management consultants in.  E.g. 3 developers 30 managers.

[Panda]

Sorry, was feeling in a strange mood.

It's okay, it's just that you unknowingly stumbled accross one of my pet peeves. It's like, "Yeah, I know this is offensive to some people", instead of "I'm using this word, but I don't mean it in an offensive manner or I wouldn't have used it". To me, anyways.

It's work.  A strange place where the management believe development should be run by commitee and developers, such as myself, can't possibly understand the issues.  Worse than that, we seem to have raided the idiot farm to get management consultants in.  E.g. 3 developers 30 managers.

Heh. Sounds like most situations. Just remind em that they depend on you, not you on them ;-).