Source documentation/de

Die (englischsprachige) Sourcecode-Dokumentation ist online unter api zu finden.

Der FreeCAD-Quellcode ist kommentiert, um eine automatische HTML-Dokumentation-Generierung mit Doxygen zu ermöglichen. Dies gilt sowohl für die C++- als auch die Python-Teile des FreeCAD-Quellcodes.

Für diejenigen, die die letzten Entwicklungsversionen von FreeCAD hautnah verfolgen wollen und diejenigen, die einen Blick auf die C++- und Python-Teile werfen wollen, kann der erste Einblick in den Quellcode die Empfindung erzeugen, einen Igel (hedgehog) anzusehen: Sie können den Kopf nicht vom Schwanz unterscheiden und wissen nicht wirklich, wie Sie ihn packen sollen!

Im Gegensatz zu diesem Wiki kann die Source-Code-Dokumentation hoffentlich diese Empfindung mildern, indem sie einen Einstiegspunkt bietet und das einfache Überfliegen der Dutzenden Dateien und Verzeichnisse erlaubt.

Die Source-Code-Dokumentation erzeugen
Wenn Sie Doxygen installiert haben, ist die Erzeugung der Dokumentation sehr einfach. Wechseln Sie in das build-Verzeichnis, konfigurieren Sie den Quellcode mit CMake, und tippen Sie

und konsultieren Sie die erzeuten HTML-Dateien, indem Sie mit Doc/SourceDocu/html/index.html starten.

Wenn graphviz auf Ihrem System installiert ist, wird  make DevDoc  mehr als 2Gb Daten erzeugen. Eine alternative, kleinere Version (~500Mb) - das ist die auf api benutzte Version - kann stattdessen erzeugt werden durch

Naturgemäß ist Quellcode, und wird es immer sein, eine fortlaufende Arbeit sein. Zögern Sie also nicht, die Erzeugung so oft wie nötig zu wiederholen. Falls Sie offenkundige Unzulänglichkeiten feststellen, können Sie das gerne im Forum beitragen (Anmerkung: es ist wirklich vollständig mit dem cMake-Build-Prozess geprüft worden).

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

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)

doxygen: http://www.vtk.org/doc/nightly/html/classvtkArrayCoordinates.html

source: https://github.com/Kitware/VTK/blob/master/Common/Core/vtkArrayCoordinates.h