Source documentation/it

Panoramica
Il codice sorgente di FreeCAD è commentato per consentire la generazione automatica della documentazione di programmazione utilizzando Doxygen, un popolare sistema di documentazione del codice sorgente. Doxygen può documentare entrambe le parti C++ e Python di FreeCAD, ottenendo pagine HTML con collegamenti ipertestuali a ciascuna funzione e classe documentata.

La documentazione è online sul sito web dell'API di FreeCAD. Si prega di notare che questa documentazione potrebbe non essere sempre aggiornata; se c'è bisogno di maggiori dettagli, scaricare l'ultimo codice sorgente di FreeCAD e compilare da sé la documentazione. Se ci sono domande urgenti sul codice, chiedere nella sezione sviluppatori del Forum di FreeCAD.

La compilazione della documentazione dell'API segue gli stessi passaggi generali della compilazione dell'eseguibile di FreeCAD, come indicato nella pagina Compilazione in Linux.





Costruire la documentazione del codice sorgente


Documentazione completa
Se si ha installato Doxygen, è molto facile costruire la documentazione. Installare anche Graphviz per poter produrre diagrammi che mostrino le relazioni tra le diverse classi e le librerie nel codice di FreeCAD. Graphviz è utilizzato anche dal grafico delle dipendenze di FreeCAD per mostrare le relazioni tra i diversi oggetti.

Then follow the same steps you would do to compile FreeCAD, as described on the compile on Linux 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 a 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:

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.

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


 * Fork the repo at https://github.com/FreeCAD/SourceDoc
 * 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:


 * Go to your fork online, and create a pull request.

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



Integrare la documentazione di Coin3D
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).



Usare Doxygen
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.