# 14.5. Dokumentation

## 14.5.1. Verzeichnisse

Damit der Dokumentationsbrowser korrekt arbeiten kann, braucht KDevelop einige Informationen bezüglich des Pfades, in dem die HTML-Dokumentation auf Ihrem System installiert ist. Daher ist es notwendig sowohl den Pfad zu Ihre Qt Onlinedokumentation, als auch den zu Ihrer KDE Bibliothekendokumentation anzugeben.

Normalerweise wird die Qt-Dokumentation im gleichen Verzeichnis wie Qt selber abgelegt; wenn sich z.B. Qt in /usr/local/qt befindet, ist der einzugebende Pfad /usr/local/qt/html. Für die KDE-Dokumentation müssen Sie das Wurzelverzeichnis aller Dokumentationen angeben, wobei angenommen wird, daß sich die KDE-Bibliothekendokumentation im selben Verzeichnis befindet. Beide Pfade können durch Betätigen der entsprechenden Knöpfe selektiert werden, die eine Pfadauswahl anzeigen. Wenn sich keine Dokumentation der KDE Bibliotheken auf Ihrem System befindet, sollten Sie zuerst im nächsten Dialog "KDE Dokumentation aktualisieren" wählen. Dadurch wird die Dokumentation in einem Pfad Ihrer Wahl erzeugt und es wird automatisch der richtige Pfad in KDevelop gesetzt.

## 14.5.2. Optionen

### 14.5.2.1. KDE-Dokumentation aktualisieren

Für Benutzer die keine aktuelle Dokumentation der KDE Bibliotheken haben, insbesondere die Dokumentation der auf Ihrem System installierten Dateien, erzeugt dieser Dialog eine neue oder aktualisiert eine bestehende Dokumentation. Diese Funktion erfordert, daß kdoc und qt2kdoc auf Ihrem System instaliert sind, welche Teil des kdesdk Paketes sind. Zuerst müssen Sie den Pfad zu den aktuellen Quellen der KDE Bibliotheken setzen. Dies ist nicht der include Pfad von KDE ! Geben Sie nur den Pfad zu den Qelldateien ein, wie /home/rnolden/kdelibs-1.1/.

Sie können dann zwischen drei verschieden Installationsmodi wählen:

- Alte Dokumentation löschen und in aktuellem Doku-Verzeichnis installieren: Es wird davon ausgegangen, daß Sie bereits eine Dokumentation installiert haben. Wenn Sie dies ankreuzen, wird die aktuelle Dokumentation gelöscht und mit der neu erzeugten überschrieben.

- Alte Dokumentation löschen und in neues Doku-Verzeichnis installieren: Wenn Sie dies ankreuzen, wird die aktuelle Dokumentation wie oben gelöscht. Sie können jedoch im Eingabefeld einen Pfad wählen, in dem die neu erzeugte Dokumentation installiert wird.

- Alte Dokumentation nicht ändern und in neues Doku-Verzeichnis installieren: Hiermit wird Ihre aktuelle Dokumentation nicht gelöscht und Sie können einen neuen Pfad für die Kdelibs-Dokumentation eingeben. Achtung: Bitte geben Sie nicht den Pfad an, wo Ihre jetzige Dokumentation installiert ist - dadurch könnten alte und neue Dateien vermischt werden!

Der "neue" Pfad zu den KDE Bibliotheksdokumentationen muß für die Optionen 2 und 3 angegeben werden. Es ist außerdem empfohlen für Benutzer, die eine komplett neue Dokumentation generieren wollen.

Nachdem Sie OK gedrückt haben, wird KDevelop ein Unterverzeichnis "kdoc-reference" im Dokumentationspfad erzeugen, das die kdoc Referenzdateien enthält. Als erstes wird die Qt Klassendokumentation indiziert, so daß eine Verbindung zur Dokumentation der KDE Bibliotheken erstellt werden kann. Daher ist es wichtig, das Sie vorher den Pfad zur Qt Dokumentation eingegeben haben, damit qt2kdoc die Dateien finden kann. Schließlich werden die KDE Bibliotheken indiziert und die Dokumentation wird mit den Querverweisen erstellt, um so ein Höchstmaß an Funktionalität beim Browsen zur Verfügung zu stellen.

BEACHTE: Wenn Sie KDoc 2 verwenden, können Sie einen Dokumentationssatz für die Bibliotheken des KDE Basispakets und für KOffice hinzufügen. Um dies zu tun, erstellen Sie die KDE Bibliotheksdokumentation wie oben beschrieben. Dann öffnen Sie den Dialog erneut und wählen im Stammverzeichnis der Quelldateien den Pfad zur `kdoc.rules` Datei des KDEbase- bzw. KOfficepakets (für KDEBase ist dies das Verzeichnis der Quellen, für KOffice ist es koffice/lib). Wählen Sie die Option 3 (Alte Dokumentation unverändert lassen) und lassen Sie den Ausgabepfad so wie er ist. Dadurch bleibt die KDE Bibliotheksdokumentation erhalten und die neue Dokumentation der KDE Bibliotheken (bzw. der KOffice Bibliotheken) wird in diesem Pfad hinzugefügt. Nach der Erstellung, stehen die Dokumentationen automatisch im DOC Baum zur Verfügung. Für weitere KDE Pakete, die mit weiteren Bibliotheken ausgeliefert werden, sollten Sie nach der `kdoc.rules` suchen und die Dokumentation ebenso erzeugen.

### 14.5.2.2. Suchdatenbank erstellen

Der Dialog "Suchdatenbank erstellen", der über den "Erzeugen" Knopf erreicht werden kann, erlaubt es dem Programmierer eine Suchdatenbank zu erstellen, in der interaktiv nach Schlüsselworten gesucht werden kann. Zum Erzeugen der Datenbank und zur Benutzung der Suchfunktionalität muß entweder glimpse oder ht://Dig installiert sein. Voreingestellt ist sowohl die Indizierung der KDE Bibliotheksdokumentation, als auch die der Qt Dokumentation, wobei davon ausgegangen wird, daß die Pfade korrekt eingestellt wurden. Es können auch noch zusätzlich zu indizierende Verzeichnisse angegeben werden. Nach Eingabe eines zusätzlichen Pfades muß die Hinzufügen Taste betätigt werden. Ein so gesetzter Pfad kann durch Auswählen des Eintrages und Betätigen der Entfernen Taste wieder aus der Liste entfernt werden. Außerdem werden dem Benutzer drei verschiedene Indexgrößen zur Auswahl angeboten: winzig, klein und mittel. Je höher die Indexgröße gewählt wird, um so größer werden auch die Indexdateien. Auf der anderen Seite wird die Suche in einer größeren Suchdatenbank beschleunigt und die Trefferquote ist höher, so daß wir eine mittlere Größe empfehlen. Zur Verwendung der Suchfunktion, sehen Sie unter Benutzung des Dokumentationsbrowsers nach.

### 14.5.2.3. Auch KDOC-Referenz Ihres Projektes erstellen

Diese Option ermöglicht es, eine Crossreferenz für Ihr Projekt zu erstellen, wenn Sie die API Dokumentation mit KDoc erzeugen. Diese Datei wird im Referenzverzeichnis erstellt und stellt Ihr Projekt im Dokumentationsbaum zur Verfügung. Wenn Sie im Referenzverzeichnis kein Schreibrecht haben, müssen Sie diese Option ausschalten, damit Sie Ihre API Dokumentation fehlerfrei generieren können.