Source documentation/it

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

The FreeCAD source code is commented to allow automatic html documentation generation with Doxygen. This is the case for both the C++ and Python parts of the FreeCAD source code.

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!

In complement to this Wiki, the Source Documentation can hopefully alleviate this feeling, providing an entry point, and allowing for easy browsing through the dozens of files and directories.

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

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

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:

Per natura, la documentazione del codice sorgente è, e sarà sempre, un lavoro in corso. Non esitate a ricostruirla tutte le volte che è necessario. Se riscontrate delle carenze evidenti, non esitate a postarle sul forum (nota: Solo quando il processo di costruzione è effettivamente controllato per intero con CMake).

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

Questo è un altro FreeCAD Doxygen documentation generato da qingfeng.xia.

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