Source documentation/it

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

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.

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

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

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 500 MB can be generated with a different target. This is the version displayed on the FreeCAD API website.

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
Esempio di una pagina doxygen completa: (da un altro progetto)

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

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