JavaDoc in JAR-File einbinden

Alles zur oder um die NetBeans IDE

Moderator: wegus

Antworten
GBunge
Beiträge: 28
Registriert: 25.05.2013, 12:54

JavaDoc in JAR-File einbinden

Beitrag von GBunge » 10.10.2015, 10:22

Hallo Fans,

habe eine Bibliothek geschrieben und diese in anderen Projekten eingebunden.
Alles funktioniert wie es soll.
Nun versuche ich die JavaDoc der Bibliothek mit in das JAR-File zu binden,
das aber will mir nicht gelingen.

Ich habe einiges gegoogelt und ausprobiert.
Für mich war das klarste http://wiki.netbeans.org/FaqJavaDoc
2. Adding Javadoc to a Project
2.1 Adding Javadoc via the Library Manager
2.2 Adding Javadoc via the Project Properties
Ich habe beide Möglichkeiten probiert, alles arbeitet ohne Fehlerausgabe, aber nichts hat Erfolg!
Im Bibliotheks-Jar steht kein JavaDoc.

Offensichtlich mache ich nocht etwas falsch.
Kann mir jemand helfen?
Gruss GBunge

Benutzeravatar
nigjo
Beiträge: 606
Registriert: 08.09.2009, 09:43
Wohnort: Aachen
Kontaktdaten:

Re: JavaDoc in JAR-File einbinden

Beitrag von nigjo » 13.10.2015, 07:46

Moin

In der Bibliotheks-Jar direkt solltest du auch keine JavaDocs hinein packen. Das macht die Jar-Datei nur unnötig groß. Es reicht in der Regel den Inhalt des "dist/javadoc" Verzeichnisses in eine ZIP zu packen und mit der Bibliotheks-Jar auszuliefern. Der Entwickler, der deine Bibliothek nutzen möchte kann dann in der IDE seiner Wahl diese ZIP als JavaDoc zur Jar eintragen (das ist bei jeder IDE anders).

Wie du die ZIP in NetBeans einträgst steht in deinem Link ja schon beschrieben. Das ist nicht unbedingt ein Automatismus. In einem JavaSE Projekt musst du das in den Projekteinstellungen machen, bei einem Library-Wrapper-Modul klappt das über die UI nur, wenn du die Jar gerade erst hinzufügst. (Wenn du keine RCP Anwendung erstellst, vergiss die letzte Aussage einfach)

Gruß
Jens
Man sollte seine Werkzeuge kennen. Ansonsten haut man sich mit dem Hammer nur auf die Finger.

--
NetBeans Certified Engineer - Java Getriebe

GBunge
Beiträge: 28
Registriert: 25.05.2013, 12:54

Re: JavaDoc in JAR-File einbinden

Beitrag von GBunge » 14.10.2015, 18:50

Hallo Jens,
Dank für schnelle Antwort.
Mittlerweile habe ich die Lösung gefunden, die Deinem Vorschlag mit der ZIP-Datei entspricht.
Gruß GBunge

Antworten