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.

Quindi seguire gli stessi passi che si farebbero per compilare FreeCAD, come descritto nella pagina Compilazione in Linux, e riassunti qui di seguito per comodità.
 * Prendere il codice sorgente di FreeCAD e metterlo nella sua directory.
 * Creare un'altra directory in cui si compilerà FreeCAD e la sua documentazione.
 * Configurare i sorgenti con, assicurandosi di indicare la directory dei sorgenti, e specificare le opzioni richieste per la build.
 * Attivare la creazione della documentazione usando.

Mentre ci si trova all'interno della directory di build, dare le seguenti istruzioni per creare solo la documentazione.

Come accennato in velocizzare la compilazione, l'opzione imposta il numero di core della CPU utilizzati per la compilazione. I file di documentazione risultanti verranno visualizzati nella directory

Il punto di accesso alla documentazione è il file, che si può aprire con un browser web:

Il target genererà una notevole quantità di dati, circa 5 GB di nuovi file, in particolare grazie ai diagrammi creati da Graphviz.



Documentazione sintetica
La documentazione completa utilizza circa 3 GB di spazio su disco. Una versione alternativa e più piccola della documentazione che richiede solo circa 600 MB può essere generata con una destinazione diversa. Questa è la versione visualizzata sul sito web dell'API di FreeCAD.

La documentazione sul sito Web dell'API di FreeCAD viene prodotta automaticamente da https://github.com/FreeCAD/SourceDoc. Chiunque può ricostruirla e inviare una richiesta di pull:


 * Effettuare il fork del repository su https://github.com/FreeCAD/SourceDoc
 * sulla tua macchina: clonare il codice FreeCAD (se non è gia stato fatto), creare una build dir per il documento e clonare il suddetto repository SourceDoc all'interno. Quel SourceDoc verrà aggiornato quando si ricostruisce il documento e si sarà in grado di eseguire il commit ed inviare i risultati in seguito:


 * Vai al tuo fork online e crea una richiesta pull.

Altre versioni
FreeCAD 0.19 development documentazione creata da qingfeng.xia.



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.


 * Installare il pacchetto, o con nome simile.
 * Scompattare l'archivio che si trova in ; i file potrebbero essere già decompressi nel sistema.
 * Generare nuovamente la documentazione di origine.

Se non si installa il pacchetto di documentazione per Coin, verranno generati i collegamenti per accedere alla documentazione online su. Ciò accadrà se un file di tag Doxygen può essere scaricato al momento della configurazione con.



Usare Doxygen
Vedere la pagina Doxygen per un'ampia spiegazione su come commentare il codice sorgente C++ e Python in modo che possa essere elaborato da Doxygen per creare automaticamente la documentazione.

Essenzialmente, un blocco di commento, che inizia con o  per C++, o  per Python, deve apparire prima di ogni classe o funzione definizione, in modo che venga raccolto da Doxygen. Molti comandi speciali, che iniziano con o, possono essere usati per definire parti del codice e formattare l'output. Sintassi Markdown è compreso anche all'interno del blocco dei commenti, il che rende conveniente enfatizzare alcune parti della documentazione.