JavaDoc erzeugen

Das Erzeugen von JavaDoc geschieht leider in Eclipse nicht manuell. Man wählt das Projekt aus, für das man JavaDocs erzeugen will, und ruft im Menü "File" -> "Export..." auf. Im Export-Dialog wählt man "Java" -> "Javadoc" aus:
Export Javadoc
Alternativ wäre auch Menü "Project" => "Generate Javadoc..." möglich und würde zum selben nächsten Schritt führen.

Im nächsten Schritt wählt man die Projekt aus, für die man generieren will.
Hinweis: es kann sein, dass die Combobox "Javadoc command" leer ist und deshalb der "Next"-Button disabled ist.
Hier ist die Ursache, dass Eclipse zwar ein JRE gefunden hat, aber nicht das auf dem Rechner ebenfalls installierte JDK
Also geht man in "Preferences" unter "Java" -> "Installed JREs" und fügt eine neue Runtime zu. In dem sich öffnenden Assisten wählt man als "JRE Type" "Standard VM" aus und gibt im nächsten Schritt bei "JRE home" das Installationsverzeichnis des JDK an (z.B. "C:\Program Files\Java\jdk1.7.0_51").

Das Ergebnis sieht so aus (man muss die Runtime nicht in der Checkbox-Spalte abhaken, sie muss einfach nur vorhanden sein)
JDK

Außerdem wird die Option "Create Javadoc for members with Visibility" auf "Protected" gesetzt. Als Zielpfad empfehle ich ein Unterverzeichnis außerhalb des Projekts. Grund: ansonsten explodiert unsere Fehlerliste, weil das generierte HTML ebenfalls validiert wird.

Export Javadoc

In Schritt 3 setzen wir die "JRE source compatibility" auf "1.7" (stand bei mir im Default auf "1.6)
Außerdem können wir hier die Behandlung von Custom Tags wie "@pre" und "@post" definieren: dazu wird mit dem Parameter "-tag" definiert, wo die Tags erscheinen können ("cm" steht für "Constructor, Method"), und durch was für einen String sie ersetzt werden sollen.
Quelle:
http://cs.uni-muenster.de/sev/teaching/ws1213/sopra/javadoc_prepost_howto.html
Export Javadoc

In Schritt 4 können wir alles auf den Defaults lassen.

Die Ausgabe des Javadoc-Laufs erscheint auf einer Konsole, und hier sollten wir ein Auge auf Fehler oder Warnungen haben.


Stand 22.01.2014
Historie:
22.01.2014: Erstellt