Einbinden einer lokalen Javadoc API.

Demonstrationsumgebung: Eclipse Java EE IDE for Web Developers. Version: Kepler Service Release 1

Eclipse bietet die Möglichkeit, aus der Entwicklungsumgebung heraus, die Javadocs zu einer Methode oder zu einer Klasse durch die Wahl von Shift + F2 anzuzeigen. Hier wird demonstriert, wie ein lokaler Ablageort der API eingebunden werden kann.

Das Beispiel zeigt dies anhand der bereits in ein Projekt eingebundenen Joda-Time Bibliothek, einer Bibliothek, die den Umgang mit Datum- und Zeit-Werten erheblich vereinfacht. Die Einbindung einer Bibliothek in ein Projekt selbst erfolgt wie im Artikel Bibliothek einbinden ausgeführt.

Gehen Sie wie folgt vor:
Laden Sie zunächst die Javadocs, die Sie einbinden möchten aus dem Internet herunter und speichern Sie sie an einem beliebigen Ort auf der Festplatte.

Dialog zum Einstellen des Java Build Path
Rufen Sie durch einen Rechtsklick auf den Projektnamen im Package Explorer unter Properties den Einstellungs-Dialog auf und wählen Sie dort Java Build Path. (1)
Suchen Sie dort im Hauptfenster die Bibliothek, deren Javadoc Sie einbinden möchten und expandieren sie den Eintrag durch Klicken auf das Dreieck.
Markieren Sie den Eintrag Javadoc Location (2) und klicken Sie auf Edit (3):
Es öffnet sich ein Fenster, in dem Sie durch Klicken auf Browse… oben den Ort des Javadoc-Verzeichnisses eintragen können. (4)
Ein nettes Feature ist die Möglichkeit, durch Wählen von Validate… (5) anschließend die Gültigkeit des Eintrags prüfen zu lassen. Bestätigen Sie abschließend alle Dialoge mit OK.
Der Ort der Dokumentation ist anschließend im Fenster des Java Build Path eingetragen. Setzt man nun im Quelltext den Cursor auf ein entsprechendes Element, so kann man nun durch Wählen von Shift + F2 die zugehörige Java-Dokumentation aufrufen.