Möglichkeit, komfortabel JavaDocs zu erstellen

[kingofbrain]

Hallo zusammen.

Wir haben hier in der Arbeit ein etwas umfangreicheres Projekt, das wir in Java realisieren. Dazu wollen wir uns auch eine Online-Dokumentation à la Sun zaubern. Nun die Frage:

Wer von Euch kennt ein Tool, mit dem man komfortabel über eine ganze Dateistruktur die JavaDocs erstellt?

Idealerweise gibt man nur einen Startpunkt an und bekommt eine fertige Doku, die von vorn bis hinten verlinkt ist.

Wenn es sowas nicht geben sollte, oder keiner von Euch sowas kennt, wäre es gut, wenn Ihr mir den einen oder anderen Tipp geben könntet, wie man das mit dem Programm javadoc lösen kann, das bei Java mit dabei ist.

Oder vielleicht weiss ja einer von Euch ein Tutorial oder eine Doku zum Thema.

Ich bin für jede Hilfe dankbar und hoffe darauf, nicht jede einzelne .java-Datei durchs javadoc jagen zu müssen und am Schluss auch noch zu verlinken.

k.o.b

[Jaraz]

Hallo,

ist Javadoc bei JEdit nicht integriert?

Du kannst javadoc alle möglichen Parameter mitgeben.

Natürlich auch Package Listen oder Datei Listen.

Musste mal die Docu zu Javadoc durcharbeiten.

Allerdings mache ich das immer komfortabel über den Javadoc Wizard von Eclipse.

Die Dokus der einzelnen externen Packages lassen sich übrigens auch einbinden. Wodurch du dann z. B. direkt von deiner Doku einen Link zu java.util.Vector hast.

Gruß Jaraz

[kingofbrain]

Hallo Jaraz,

prompte Antwort...

Wie läuft denn das bei Eclipse? Der will doch bestimmt meine Sources erst kompilieren oder zumindest ein Projekt erstellen, bevor er die JavaDoc generiert, oder? Wenn nicht, dann wär das sogar noch eine Möglichkeit. Eclipse ist hier nämlich auch installiert.

Danke schonmal. Im schlimmsten Fall muss ich einfach eine Datei erstellen, in der ich alle Sources drinhabe. Die kann ich ja über die Kommandozeile erstellen lassen, wie ich vor einiger Zeit hier im Forum gelesen habe.

Erstellt JavaDoc eigentlich die Doc komplett verlinkt, d.h. merkt es, was zusammenghört und erstellt mir so eine komfortable index.htm?

k.o.b

[Snowghost]

Schau dir doch am besten mal das Tool ANT an (http://jakarta.apache.org/ant/).

Damit kannst du geniale Build-Files erstellen - und natürlich auch eine JavaDoc. Am Anfang ist es allerdings ein bisschen gewöhnungsbedürftig.....

[kingofbrain]

Also ich hab jetzt recht einfach mein Dateisystem ausgelesen, die java-Files in eine Textdatei geschrieben und diese dann javadoc übergeben.

Das Ergebnis ist genauso, wie ich es wollte.

Danke für Eure Hilfe.

k.o.b

[Jaraz]

Bei Eclipse musst du ein Projekt anlegen.

Bei den Projekteigenschaften kannst du dann die extern benötigten Libraries hinzufügen.

Der Javadoc Wizard bietet dann die Möglichkeit zu diesen Libs die entsprechen Links zu den Api Docs im Netz anzugeben.

In deiner Docu werden dann alle Klassen direkt verlinkt.

Aber wie gesagt, mit den entsprechenden Parametern für javadoc geht das ebenfalls.

Gruß Jaraz