JavaDocu in eigener Bibliothek

[gbunge]

Hallo,
wie kann man die Documentation einer eigenen Bibliothek so in die
Bibliothek einbinden, dass sie in den Projekten erreichbar ist? Bei der Instanziierung einer
Bibliotheksklasse soll sie die in den EDI's aufpoppenden Hilfen darstellen.
Gruss GBunge

 

[httpdigest]

In so ziemlich jeder Integrated Development Environment (IDE) kannst du ein Verzeichnis oder eine JAR-Datei als Träger für JavaDoc und/oder Quelldateien einer anderen Binär-JAR-Datei (welche .class Dateien enthält) einstellen.
Du müsstest also mit dem javadoc Tool (Teil des JDK) deine JavaDoc-Dateien bauen und mit dem jar Tool in eine JAR-Datei zippen. Meistens bietet dir deine IDE das auch mit ein paar Klicks an oder du erledigst das mit Build-Tools wie Maven oder Gradle, falls du diese eh schon verwendest.
Derjenige, der die JavaDocs dann nutzen möchte, muss in seiner IDE dann entsprechend die JavaDoc-JAR-Datei als JavaDoc-Quelle für deine Bibliotheks-JAR-Datei einstellen. Auch das kann man mittels Build-Tools wie Maven und Gradle und deren Integrationen in die IDEs automatisieren.

 

[gbunge]

ich habe mit JavaDoc die Dokumentationerstellt und daraus eine jar-Datei gebildet( zip ).
Diese dann in den Library-Ordner kopiert.
Im Projekt, das die Library benutzt habe icj die Library und die Docu eingebunden.
Allerdings war, bei Instanziierung einer LibraryKlasse, die Documentation nicht sichtbar.
Das Hilfe-Popup in NetBeans kam zwar mit den Methoden und Atrtibuten, aber auch mit dem Meldung
'JavaDocu nicht vorhanden' oder sowas ähnliches.
Macht es Sinn die Docu-Dateien ind den Ordner mit den Klasse zu kopieren?