Source documentation/de

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.

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

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

Then follow the same steps you would do to compile FreeCAD, as described on the compile on Unix page, and summarized here for convenience.
 * Get the source code of FreeCAD and place it in its own directory.
 * Create another directory in which you will compile FreeCAD and its documentation.
 * Configure the sources with, making sure you indicate the source directory, and specify the required options for your build.
 * Trigger the creation of the documentation using.

While you are inside the build directory issue the following instruction to create only the documentation.

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

The point of entrance to the documentation is the file, which you can open with a web browser:

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

An alternative, smaller version of the documentation which takes only around 600 MB can be generated with a different target. This is the version displayed on the FreeCAD API website.

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)

This section explains how to comment your source code so that it can be processed by Doxygen to automatically create the documentation.

This is an example of how source code is documented. It looks into the source code of VTK, a 3D visualization library used to present multi-physics simulation results.

A class to store a collection of coordinates is defined in a C++ header file. The top part of the file is commented, and a few keywords are used, like, , , and to indicate important parts. Inside the class, before a function is called, a block of commented text explains what the function does, and its arguments.

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