Source documentation/de

Überblick
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 Kompilieren auf Linux Seite angegeben.





Quelldokumentation erstellen


Komplette Dokumentation
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 Linux 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.



Gekürzte Dokumentation
Die komplette Dokumentation belegt etwa 3 GB Plattenplatz. 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.

The documentation on the FreeCAD API website is produced automatically from https://github.com/FreeCAD/SourceDoc. Anyone can rebuild it and submit a pull request:


 * Fork the repo at https://github.com/FreeCAD/SourceDoc
 * on your machine: clone the FreeCAD code (if you haven't yet), create a build dir for the doc, and clone the above SourceDoc repo inside. That SourceDoc will be updated when you rebuild the doc, and you'll be able to commit & push the results afterwards:


 * Go to your fork online, and create a pull request.

Andere Versionen
FreeCAD 0.19 development Dokumentation erstellt von qingfeng.xia.



Coin3D Dokumentation integrieren
Auf Unix Systemen ist es möglich, die Coin3D Quelldokumentation mit der von FreeCAD zu verknüpfen. Dies ermöglicht eine einfachere Navigation und vollständige Vererbungsdiagramme für Coin abgeleitete Klassen.


 * Installiere das, , oder ein ähnlich benanntes Paket.
 * Entpacke das Archiv, das sich in befindet; die Dateien sind möglicherweise bereits auf deinem System entpackt.
 * Erzeuge die Quelldokumentation erneut.

Wenn du das Dokumentationspaket für Coin nicht installierst, werden die Verknüpfungen generiert, um auf die Online Dokumentation unter BitBucket zuzugreifen. Dies geschieht, wenn eine Doxygen Kennzeichendatei zur Konfigurationszeit mit heruntergeladen werden kann.



Doxygen Anwenden
Auf der Seite Doxygen findest du eine ausführliche Erklärung, wie man C++- und Python Quellcode kommentiert, damit er von Doxygen zur automatischen Erstellung der Dokumentation verarbeitet werden kann.

Im Wesentlichen muss vor jeder Klassen- oder Funktionsdefinition ein Kommentarblock, beginnend mit oder  für C++ oder  für Python, erscheinen, damit er von Doxygen aufgenommen wird. Viele Spezielle Befehle, die mit oder  beginnen, können verwendet werden, um Teile des Codes zu definieren und die Ausgabe zu formatieren. Auch Markdown Syntax wird innerhalb des Kommentarblocks verstanden, was es bequem macht, bestimmte Teile der Dokumentation hervorzuheben.