Source documentation/de

Der FreeCAD Quellcode ist kommentiert, um eine automatische Generierung der Programmierdokumentation mit Doxygen, einem beliebten Quellcode Dokumentationssystem, zu ermöglichen. Doxygen kann sowohl die C++ als auch die Python Teile von FreeCAD dokumentieren, was zu HTML Seiten mit Hyperlinks zu jeder dokumentierten Funktion und Klasse führt.

Die Dokumentation ist online auf der FreeCAD API Website verfügbar. Bitte beachte, dass diese Dokumentation möglicherweise nicht immer auf dem neuesten Stand ist; wenn Du mehr Details benötigst, lade den neuesten Quellcode von FreeCAD herunter und erstelle die Dokumentation selbst. Wenn Du dringende Fragen zum Code hast, stelle diese bitte im Entwicklerbereich des FreeCAD Forum.

Die Kompilierung der API Dokumentation folgt den gleichen allgemeinen Schritten wie die Kompilierung der FreeCAD Ausführdatei, wie auf der Seite Kompilieren auf Unix angegeben.



Quelldokumentation erstellen
Wenn du Doxygen installiert hast, ist es sehr einfach, die Dokumentation zu erstellen. Installiere auch Graphviz, um Diagramme erstellen zu können, die die Beziehungen zwischen verschiedenen Klassen und Bibliotheken im FreeCAD Code zeigen. Graphviz wird auch von FreeCADs Abhängigkeitsgraph verwendet, um die Beziehungen zwischen verschiedenen Objekten anzuzeigen.

Folge dann den gleichen Schritten, die Du bei der Kompilierung von FreeCAD durchführen würdest, wie auf der Seite Kompilieren auf Unix beschrieben, und hier aus Gründen der Übersichtlichkeit zusammengefasst.
 * Hole Dir den Quellcode von FreeCAD und lege ihn in ein eigenes Verzeichnis.
 * Erstelle ein anderes Verzeichnis, in dem Du FreeCAD und seine Dokumentation kompilieren wirst.
 * Konfiguriere die Quellen mit, stelle sicher, dass Du das Quellverzeichnis angibst und die erforderlichen Optionen für Dein Build angibst.
 * Triggere die Erstellung der Dokumentation mit.

Während Du Dich im Build-Verzeichnis befindest, gib die folgende Anweisung aus, um nur die Dokumentation zu erstellen.

Wie unter Kompilieren (Beschleunigen) erwähnt, legt die Option die Anzahl der CPU Kerne fest, die für die Kompilierung verwendet werden. Die resultierenden Dokumentationsdateien erscheinen im Verzeichnis

Der Einstiegspunkt in die Dokumentation ist die Datei, die du mit einem Webbrowser öffnen kannst:

Das Ziel erzeugt eine beträchtliche Datenmenge, etwa 5 GB neue Dateien, insbesondere aufgrund der von Graphviz erstellten Diagramme.

Eine alternative, kleinere Version der Dokumentation, die nur ca. 600 MB benötigt, kann mit einem anderen Ziel erstellt werden. Dies ist die Version, die auf der FreeCAD API Webseite angezeigt wird.

Alternativ wird die Dokumentation von Zeit zu Zeit generiert und auf Sourceforge hier zur Verfügung gestellt.

FreeCAD 0.16 development documentation built by qingfeng.xia.

Hier gibt es eine weitere FreeCAD-Doxygen Dokumentation generiert von qingfeng.xia.

Die Coin3D-Dokumentation integrieren
Auf Unix-Systemen ist es möglich, die Coin3D-Quellcode-Dokumentation mit der von FreeCAD zu verbinden. Es erlaubt einfachere Navigation und komplette Vererbungsdiagramme für Coin-abgeleitete Klassen.


 * Auf Debian und davon abgeleiteten Systemen:
 * - installieren Sie das Package libcoin60-doc
 * - entpacken Sie die Datei /usr/share/doc/libcoin60-doc/html/coin.tag.gz
 * - Regenerieren Sie die Quellcode-Dokumentation
 * Sie sind bereit für das Offline-betrachten.


 * Wenn Sie das Coin-Doc-Package nicht installieren wollen oder können, werden Links generiert, um die Coin-Dokumentation online auf doc.coin3D.org zu erreichen, wenn die doxygen-Tag-Datei (per wget) während der Ausführung von configure heruntergeladen werden kann.

Wie doxygen in den FreeCAD-Quellcode integriert werden kann
Beispiel einer kompletten doxygen-Seite: (eines anderen Projekts)

See the Doxygen page for an extensive explanation on how to comment C++ and Python source code so that it can be processed by Doxygen to automatically create the documentation.

Essentially, a comment block, starting with or  for C++, or  for Python, needs to appear before every class or function definition, so that it is picked up by Doxygen. Many special commands, which start with or, can be used to define parts of the code and format the output. Markdown syntax is also understood within the comment block, which makes it convenient to emphasize certain parts of the documentation.