Source documentation/de

Die (englischsprachige) Sourcecode-Dokumentation ist online unter 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.

For those wanting to follow closely the latest development versions of FreeCAD, and who try to have a look at the C++ or Python parts, the first insight in the sources can give the feeling you're looking at an hedgehog: you can't discriminate head from tail and don't really know how to catch it!

Im Gegensatz zu diesem Wiki kann die Source-Code-Dokumentation hoffentlich diese Empfindung erleichtern, 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.

The DevDoc make target above will, if graphviz is installed on your system, generate a 2Gb+ volume of data. An alternative, smaller version (~500Mb), that is the version used on http://www.freecadweb.org/api/ can also be generated by issuing instead:

By nature, source doc is, and will ever be, work in progress. Don't hesitate to rebuild as often as needed. If you fall upon blatant inadequacies, feel free to post on the forum (note: It is really fully checked with cMake build process only).

As an alternative, the doc is generated from time to time and accessible on sourceforge here.

Here is another FreeCAD Doxygen documentation generate by qingfeng.xia.

Integrate Coin3D documentation
On unix systems, it is possible to link Coin3D source documentation with FreeCAD's. It allows easier navigation and complete inheritance diagrams for Coin derived classes.


 * On Debian and derived systems:
 * - Install the package libcoin60-doc
 * - Uncompress the file /usr/share/doc/libcoin60-doc/html/coin.tag.gz
 * - Regenerate source documentation
 * You are up for offline browsing.


 * If you don't want to or can't install Coin doc package, the links will be generated to access coin doc online at doc.coin3D.org, if doxygen tag file can be downloaded at configure time (wget).

How to integrate doxygen in to the FreeCAD source code
Example of a complete doxygen page: (from another project)

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

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