Source documentation/it: Difference between revisions
Renatorivo (talk | contribs) No edit summary |
(Updating to match new version of source page) |
||
Line 5: | Line 5: | ||
A complemento del Wiki, speriamo che la ''documentazione del codice sorgente'' possa alleviare questa sensazione, fornendo un punto di partenza e consentendo una facile navigazione attraverso le decine di file e directory. |
A complemento del Wiki, speriamo che la ''documentazione del codice sorgente'' possa alleviare questa sensazione, fornendo un punto di partenza e consentendo una facile navigazione attraverso le decine di file e directory. |
||
=== Build source documentation === |
|||
==== 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 |
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 |
||
Line 16: | Line 16: | ||
In alternativa, la documentazione viene generata di volta in volta e è accessibile su sourceforge [http://free-cad.sf.net/SrcDocu/index.html quí] |
In alternativa, la documentazione viene generata di volta in volta e è accessibile su sourceforge [http://free-cad.sf.net/SrcDocu/index.html quí] |
||
Here is another FreeCAD Doxygen [http://iesensor.com/FreeCADDoc/0.16-dev/ documentation] generate by [http://forum.freecadweb.org/viewtopic.php?t=12613 qingfeng.xia]. |
|||
==== Documentazione di Coin3D integrata ==== |
==== Documentazione di Coin3D integrata ==== |
Revision as of 18:57, 21 June 2016
Il codice sorgente di FreeCAD è commentato per consentire la generazione automatica della documentazione html con Doxygen.
A coloro che vogliono seguire da vicino le ultime versioni SVN di FreeCAD o che provano a esplorare la parte C++, 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!
A complemento del Wiki, speriamo che la documentazione del codice sorgente possa alleviare questa sensazione, fornendo un punto di partenza e consentendo una facile navigazione attraverso le decine di file e directory.
Build source documentation
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
make DevDoc
poi consultare i file HTML risultanti iniziando da Doc/SourceDocu/html/index.html
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 e è accessibile su sourceforge quí
Here is another FreeCAD Doxygen documentation generate by 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).