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

Codul sursă al FreeCAD este comentat pentru a permite generarea automată a documentației html cu Doxygen. Acesta este cazul atât pentru părțile C ++ și Python ale codului sursă FreeCAD.

Documentația online este localizată la

Compiling the API documentation follows the same general steps as compiling the FreeCAD executable, as indicated in the Compile on Linux page.

FreeCAD documentation compilation workflow.svg

General workflow to compile FreeCAD's programming documentation. The Doxygen and Graphviz packages must be in the system, as well as the FreeCAD source code itself. CMake configures the system so that with a single make instruction the documentation for the the entire project is compiled into many HTML files with diagrams.

Construiți documentația codului sursă

Complete documentation

Dacă aveți instalat Doxygen, este foarte ușor să construiți documentul. Duceți-vă la directorul dvs. de construire FreeCAD, configurați-vă sursele cu CMake, problema

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

și consultați fișierele html rezultate pornind de la Doc/SourceDocu/html/index.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

DevDoc are un target foarte ridicat, dacă graficviz este instalat pe sistemul dvs., acesta va genera un volum de date de peste 2Gb +. O versiune alternativă, mai mică (~ 500Mb), adică versiunea folosită can also be generated by issuing instead:

Reduced documentation

The complete documentation uses around 3Gb of disk space. 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

The documentation on the FreeCAD API website is produced automatically from . Anyone can rebuild it and submit a pull request:

  • Fork the repo at
  • on your machine: clone the FreeCAD code (if you haven't yet), create a build dir for the doc, and clone the above SourceDoc repo inside. That SourceDoc will be updated when you rebuild the doc, and you'll be able to commit & push the results afterwards:
git clone
cd FreeCAD
mkdir build
cd build
mkdir -p doc/SourceDocu/html
cd doc/SourceDocu/html
git clone your-fork-url
cd ../../..
cmake -DBUILD_QT5=ON -DPYTHON_EXECUTABLE=/usr/bin/python3 ..
make WebDoc
cd doc/SourceDocu/html
git commit
git push
  • Go to your fork online, and create a pull request.

Ca alternativă, doc-ul este generat din când în când și accesibil pe sourceforge here.

Integrați documentația Coin3D

Pe sistemele unix, este posibilă legarea documentației sursă Coin3D de FreeCAD. Permite navigare mai ușoară și diagrame complete de moștenire pentru clasele derivate din Coin.

  • Sub Debian și sistemele derivate:
- 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.
  • Dacă nu doriți sau nu puteți instala pachetul Coin doc, legăturile vor fi generate pentru a accesa coin doc online la, if doxygen tag file can be downloaded at configure time (wget).

Cum se integrează doxygen în codul sursă al FreeCAD

This is a Work In Progress. See Doxygen

Examplu de pagină completă doxygen: (from another project)

See the Doxygen page for an extensive explanation on how to comment C++ and Python source code so that it can be processed by Doxygen to automatically create the documentation.

Essentially, a comment block, starting with /** or /// for C++, or ## for Python, needs to appear before every class or function definition, so that it is picked up by Doxygen. Many special commands, which start with \ or @, can be used to define parts of the code and format the output. Markdown syntax is also understood within the comment block, which makes it convenient to emphasize certain parts of the documentation.

 * 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);