Letzte Änderung 31.10.2013
Die Dokumentation der XDEV 5 Klassenbibliothek XAPI wird in dieser Dokumentation allgemein als Javadoc bezeichnet. Javadoc ist ein Software-Dokumentationswerkzeug, das aus Java-Quellcode automatisch eine Dokumentation in Form von HTML generieren kann und Bestandteil des Java Development Kit (JDK) ist. Mit Hilfe von Javadoc können auch Sie Ihre Dokumentation direkt in Ihren Quellcode schreiben und anschließend als HTML-Dokument generieren lassen.
Da die XDEV 5 Javadoc auf die Javadoc von Java aufsetzt, benötigen Sie für die Entwicklung mit XDEV 5 die komplette Javadoc von Java, die im JDK enthalten ist. Bei der Installation von XDEV 5 wird lediglich die Java Runtime Environment (JRE) installiert, das JDK jedoch nicht.
Falls XDEV 5 bei Ihnen die Javadoc nicht oder nur unvollständig anzeigt, liegt dies i.d.R. daran, dass die Javadoc Ihres JDK fehlt. In diesem Fall können Sie die Javadoc sehr leicht nachinstallieren.
JDK installieren |
1.Prüfen Sie, ob auf Ihrem Rechner ein Java Development Kit (JDK) vorhanden ist, das Sie im Ordner Java finden - unter Windows i.d.R. unter C:\Programme\Java. Falls auf Ihrem Rechner kein JDK vorhanden ist, laden Sie sich die Java Standard Edition (SE) für Ihr System herunter unter http://www.oracle.com/technetwork/java/javase/downloads/index.html.
2.Starten Sie die Installationsdatei und installieren Sie die Standard-Komponenten.
Javadoc in XDEV 5 einbinden |
1.Wählen Sie im Menü Bearbeiten > Einstellungen > Java > JREs und klicken Sie auf Neu. Haben Sie bereits ein JDK eingebunden, zu welchem Sie die JavaDoc einbinden möchten, so fahren Sie mit Punkt 3 fort.
2.Wählen Sie im folgenden Auswahldialog den Zielordner des einzubindenden JDKs aus und klicken Sie auf OK.
3.Das nachfolgende Fenster (welches Sie auch mit einem Klick auf das gewünschte, bereits angelegte JDK und danach über Bearbeiten öffnen können) gibt Ihnen die Möglichkeit, mit einem Klick auf + Sources die gewünschte JavaDoc-Source-Datei anzubinden. Wählen Sie dazu die src.zip Datei aus, welche im Ordner Ihres JDKs liegt und bestätigen Sie mit Öffnen.
4.Klicken Sie danach auf OK, um die Bibliothek einzubinden und abschließend auf OK, um die Einstellungen zu schließen.