52 lines
5.3 KiB
HTML
52 lines
5.3 KiB
HTML
<html><head><title>Source documentation/it</title><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><link type='text/css' href='wiki.css' rel='stylesheet'></head><body><h1>Source documentation/it</h1></div>
|
|
|
|
<div id="mw-content-text" lang="it" dir="ltr" class="mw-content-ltr"><hr/><div class="mw-parser-output"><p>La documentazione online del sorgente si trova in <a rel="nofollow" class="external free" href="http://www.freecadweb.org/api/">http://www.freecadweb.org/api/</a>
|
|
</p><p>Il codice sorgente di FreeCAD è commentato per consentire la generazione automatica della documentazione html con <a rel="nofollow" class="external text" href="http://www.doxygen.org">Doxygen</a>. Questo vale sia per la parte C++ che per la parte Python del codice sorgente di FreeCAD.
|
|
</p><p>A coloro che vogliono seguire da vicino le ultime versioni di sviluppo di FreeCAD o che vogliono esplorare la parte C++ o Python, il primo sguardo al codice sorgente può dare l'impressione di esplorare un riccio: non si riesce a distinguere la testa dalla coda e non si sa davvero come prenderlo!
|
|
</p><p>A complemento di questo Wiki, speriamo che la the <a rel="nofollow" class="external text" href="http://www.freecadweb.org/api/">Documentazione del codice sorgente</a> possa alleviare questa sensazione, fornendo un punto di partenza e consentendo una facile navigazione attraverso le decine di file e directory.
|
|
</p>
|
|
<h3><span class="mw-headline" id="Costruire_la_documentazione_del_codice_sorgente">Costruire la documentazione del codice sorgente</span></h3>
|
|
<p>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
|
|
</p>
|
|
<pre>make DevDoc </pre>
|
|
<p>poi consultare i file HTML risultanti iniziando da Doc/SourceDocu/html/index.html
|
|
</p><p>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 <a rel="nofollow" class="external free" href="http://www.freecadweb.org/api/">http://www.freecadweb.org/api/</a> e che si ottiene con:
|
|
</p>
|
|
<pre>make WebDoc </pre>
|
|
<p>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).
|
|
</p><p>In alternativa, la documentazione viene generata di volta in volta ed è accessibile su sourceforge <a rel="nofollow" class="external text" href="http://free-cad.sf.net/SrcDocu/index.html">quí</a>
|
|
</p><p>Questo è un altro FreeCAD Doxygen <a rel="nofollow" class="external text" href="http://iesensor.com/FreeCADDoc/0.16-dev/">documentation</a> generato da <a rel="nofollow" class="external text" href="http://forum.freecadweb.org/viewtopic.php?t=12613">qingfeng.xia</a>.
|
|
</p>
|
|
<h3><span class="mw-headline" id="Documentazione_di_Coin3D_integrata">Documentazione di Coin3D integrata</span></h3>
|
|
<p>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.
|
|
</p>
|
|
<ul><li> Su Debian e sistemi derivati:</li></ul>
|
|
<dl><dd> - Installare il pacchetto libcoin60-doc</dd>
|
|
<dd> - Decomprimere il file /usr/share/doc/libcoin60-doc/html/coin.tag.gz</dd>
|
|
<dd> - Rigenerare la documentazione del codice sorgente</dd>
|
|
<dd> E si è pronti per navigare offline.</dd></dl>
|
|
<ul><li> 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).</li></ul>
|
|
<h2><span class="mw-headline" id="Come_integrare_doxygen_in_al_codice_sorgente_di_FreeCAD">Come integrare doxygen in al codice sorgente di FreeCAD</span></h2>
|
|
<div id="itsfree" style="text-align:center;color:black;background:#FDE0A8;margin:1em 7em;padding:0.5em 2em;border:2px solid #FF5706;">Si tratta di un lavoro in corso. Vedere <a href="Doxygen.html" title="Doxygen">Doxygen</a></div>
|
|
<p>Esempio di una pagina doxygen completa: (da un altro progetto)
|
|
</p><p>doxygen: <a rel="nofollow" class="external free" href="http://www.vtk.org/doc/nightly/html/classvtkArrayCoordinates.html">http://www.vtk.org/doc/nightly/html/classvtkArrayCoordinates.html</a>
|
|
</p><p>sorgente: <a rel="nofollow" class="external free" href="https://github.com/Kitware/VTK/blob/master/Common/Core/vtkArrayCoordinates.h">https://github.com/Kitware/VTK/blob/master/Common/Core/vtkArrayCoordinates.h</a>
|
|
</p>
|
|
|
|
<div style="clear:both"></div>
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div><div class="printfooter">
|
|
Online version: "<a dir="ltr" href="https://www.freecadweb.org/wiki/index.php?title=Source_documentation/it&oldid=229973">http://www.freecadweb.org/wiki/index.php?title=Source_documentation/it&oldid=229973</a>"</div>
|
|
<div id="catlinks" class="catlinks" data-mw="interface"></div><div class="visualClear"></div>
|
|
</div>
|
|
</div>
|
|
<div id="mw-navigation">
|
|
<h2>Navigation menu</h2>
|
|
|
|
</body></html> |