Wie funzt javadoc?

[Lin728]

ich bin gezwungen mein Projekt zu dokumentieren, wobei Javadoc sicher ein gutes Mittel dafür ist.

Was ich machen möchte ist, dass ich das Package palme, das sich in src/ befindet und alle subpackages darin analysiert und die HTML-Dateien ins verzeichnis javadoc/ erzeugt.

Ich krieg einfach nicht heraus wie das ganze gehen soll.
Entweder Javdoc regt sich uaf, dass es das package palme nicht finden kann, oder es sagt dass mein Kommand-synthax nicht stimmt :(
Natürlich könnte ich in jedes verzeichnis gehen und die Javadocs "händisch" generieren, aber naja, es sind halt doch schon etwas viele packagae ;)

[peschmae]

Tja, wenn du Eclipse benutzen würdest könntest du die Javadoc via File|Project|Export|Javadoc exportieren. :D

sonst hab ich das für SWT jeweils so gemacht:



javadoc -sourcepath . -d apidoc -windowstitle Titel -doctitle Titel `find -name "*.java"`


Da sind wir mal wieder Froh, dass wir so ne tolle shell haben. :)

MfG Peschmä

[Lin728]

Jo, danke vielmals!

[panzi]

Also ich verwend sowieso immer Doxygen. Das kann Qt-doc und Java-doc Syntax und ist für "C++, C, Java, IDL (Corba and Microsoft flavors) and to some extent PHP and C#" geeignet.
Da legt man einfach mit nen kleinen GUI App ne konfigurations Datei an und lässt doxygen entweder mit dem App gleich durchlaufen oder mit doxygen [config-file] aus der shell (bzw. Makefile).

Wenn man so'n Tool namens dot installiert hat kann man auch coole png abhängigkeits Graphen (Klassen, Includ-Datein, ...) generieren lassen.
Bsp für Doxygen docus:
http://developer.kde.org/documentation/library/cvs-api/kdevelop/html/index.html
http://devel-home.kde.org/~danimo/apidocs/index.html
http://www.alsa-project.org/alsa-doc/alsa-lib/
http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/index.html

Siehe: http://www.doxygen.org
(Für win gibt's kompelierte, statisch gelinkte, Bins.)