Documentazione del codice sorgente

Other languages:

Il codice sorgente di FreeCAD è commentato per consentire la generazione automatica della documentazione html con Doxygen. Questo vale sia per la parte C++ che per la parte Python del codice sorgente di FreeCAD.

La documentazione online del sorgente si trova in http://www.freecadweb.org/api/

Costruire la documentazione del codice sorgente

Se Doxygen è già installato, è molto facile costruire il doc (la documentazione). Andare nella propria directory di compilazione di FreeCAD, configurare il sorgente con CMake, eseguendo

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

si possono consultare i file HTML risultanti iniziando da Doc/SourceDocu/html/index.html

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

La DevDoc è molto ingombrante, se graphviz è installato sul sistema, genera un volume dei dati maggiore di 2Gb. Un'alternativa, può invece essere generata una versione più piccola (~ 500Mb), che è la versione utilizzata in http://www.freecadweb.org/api/ e che si ottiene con:

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

In alternativa, la documentazione viene generata di volta in volta ed è accessibile su sourceforge quí

FreeCAD 0.16 development documentation built by qingfeng.xia.

Questo è un altro FreeCAD 0.19dev Doxygen documentation generato da qingfeng.xia così come una versione precedente 0.16dev_documentation .

Documentazione di Coin3D integrata

Sui sistemi Unix, è possibile collegare la documentazione del codice sorgente di Coin3D con quella di FreeCAD. Questo consente una navigazione più agevole e diagrammi di ereditarietà completi per le classi derivate da Coin.

Su Debian e sistemi derivati:

- Installare il pacchetto libcoin60-doc

- Decomprimere il file /usr/share/doc/libcoin60-doc/html/coin.tag.gz

- Rigenerare la documentazione del codice sorgente

E si è pronti per navigare offline.

Quando non si vuole o non si può installare il pacchetto della documentazione di Coin, vengono generati i collegamenti per accedere alla documentazione online di Coin in doc.coin3D.org se i file di tag doxygen possono essere scaricati al momento della configurazione (wget).

Come integrare doxygen in al codice sorgente di FreeCAD

Si tratta di un lavoro in corso. Vedere Doxygen

Esempio di una pagina doxygen completa: (da un altro progetto)

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.

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

Moduli extra di Python

Elenco dei comandi

Indice