Quellendokumentation

From FreeCAD Documentation
Jump to navigation Jump to search
This page is a translated version of the page Source documentation and the translation is 100% complete.
Other languages:
Deutsch • ‎English • ‎Türkçe • ‎español • ‎français • ‎hrvatski • ‎italiano • ‎polski • ‎română • ‎svenska • ‎русский • ‎中文(中国大陆)‎ • ‎日本語

Ü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.

FreeCAD documentation compilation workflow.svg

Allgemeiner Arbeitsablauf zur Erstellung der Programmierdokumentation von FreeCAD. Die Pakete Doxygen und Graphviz müssen sich im System befinden, ebenso wie der FreeCAD Quellcode selbst. CMake konfiguriert das System so, dass mit einer einzigen make Anweisung die Dokumentation für das gesamte Projekt in vielen HTML Dateien mit Diagrammen zusammengefasst wird.


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.

sudo apt install doxygen graphviz

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 freecad-source.
  • Erstelle ein anderes Verzeichnis freecad-build, in dem Du FreeCAD und seine Dokumentation kompilieren wirst.
  • Konfiguriere die Quellen mit cmake, stelle sicher, dass Du das Quellverzeichnis angibst und die erforderlichen Optionen für Dein Build angibst .
  • Triggere die Erstellung der Dokumentation mit make.
git clone https://github.com/FreeCAD/FreeCAD.git freecad-source
mkdir freecad-build
cd freecad-build
cmake -DBUILD_QT5=ON -DPYTHON_EXECUTABLE=/usr/bin/python3 ../freecad-source

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

make -j$(nproc --ignore=2) DevDoc

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

freecad-build/doc/SourceDocu/html/

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

xdg-open freecad-build/doc/SourceDocu/html/index.html

Das DevDoc 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.

make -j$(nproc --ignore=2) WebDoc

Andere Versionen

FreeCAD 0.12 Dokumentation, die in Sourceforge untergebracht ist.

FreeCAD 0.16 Entwicklung Dokumentation erstellt von qingfeng.xia.

FreeCAD 0.16 Entwicklung Dokumentation erstellt von qingfeng.xia.FreeCAD 0.19 Entwicklung 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 libcoin-doc, libcoin80-doc, oder ein ähnlich benanntes Paket.
  • Entpacke das Archiv coin.tar.gz, das sich in /usr/share/doc/libcoin-doc/html 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 wget 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.

/**
 * Returns the name of the workbench object.
 */
std::string name() const;

/**
 * Set the name to the workbench object.
 */
void setName(const std::string&);

/// remove the added TaskWatcher
void removeTaskWatcher(void);