Source documentation

Other languages:

Extra python modules

List of Commands

FreeCADs källkod är kommenterad för att tillåta automatisk generering av html dokumentation med Doxygen.

The online source documentation is located at the FreeCAD API website. Please note that this documentation is not always kept to date; if you have pressing questions about the code please ask in the developer section of the FreeCAD forum.

Bygga källkodsdokumentation

Om du har Doxygen installerat, så är det mycket enkelt att bygga dokumentationen. Gå till din FreeCAD byggkatalog, konfigurera din källkod med CMake, skriv

sudo apt install doxygen graphviz

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 freecad-source.
Create another directory freecad-build in which you will compile FreeCAD and its documentation.
Configure the sources with cmake, making sure you indicate the source directory, and specify the required options for your build.
Trigger the creation of the documentation using 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

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

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

och konsultera de resulterande html filerna med start i Doc/SourceDocu/html/index.html (Notera: DevDoc målet är inte giltigt för autotools byggningar)

freecad-build/doc/SourceDocu/html/

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

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

The DevDoc target will generate a significant amount of data, around 5 GB of new files, particularly due to the diagrams created by Graphviz.

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.

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

Som ett alternativ, så genereras dokumentationen då och då och finns här

FreeCAD 0.16 development documentation built by qingfeng.xia.

FreeCAD 0.19 development documentation built by qingfeng.xia.

Integrera Coin3D dokumentationen

På unix system, så är det möjligt att länka Coin3D's källk0dsdokumentation med FreeCAD's. Det innebär lättare navigering och kompletta släktträd för Coin relaterade klasser.

På Debian och relaterade system:

- Installera paketet libcoin60-doc

- Packa upp filen /usr/share/doc/libcoin60-doc/html/coin.tag.gz

- Generera om källkodsdokumentationen

Du är klar för offline läsning.

Om du inte vill eller inte kan installera Coin dokumentationspaketet, så kommer länkar att genereras för att komma åt coindokumentationen online på doc.coin3D.org, om doxygen tag filen kan laddas ned under konfigureringen (wget).

How to integrate doxygen in to the FreeCAD source code

This is a work in progress. See Doxygen

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 @class, @brief, @sa, and @par 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.