Source documentation/it: Difference between revisions

From FreeCAD Documentation
(Created page with "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 ere...")
(Created page with "* Su Debian e sistemi derivati: : - Installare il pacchetto libcoin60-doc : - Decomprimere il file /usr/share/doc/libcoin60-doc/html/coin.tag.gz : - Rigenerare la documentazio...")
Line 22: Line 22:
Questo consente una navigazione più agevole e diagrammi di ereditarietà completi per le classi derivate da Coin.
Questo consente una navigazione più agevole e diagrammi di ereditarietà completi per le classi derivate da Coin.


* On Debian and derived systems:
* Su Debian e sistemi derivati:
: - Install the package libcoin60-doc
: - Installare il pacchetto libcoin60-doc
: - Uncompress the file /usr/share/doc/libcoin60-doc/html/coin.tag.gz
: - Decomprimere il file /usr/share/doc/libcoin60-doc/html/coin.tag.gz
: - Rigenerare la documentazione del codice sorgente
: - Regenerate source documentation
: E si è pronti per navigare offline.
: You are up for offline browsing.


* If you don't want to or can't install Coin doc package, the links will be generated to access coin doc online at doc.coin3D.org, if doxygen tag file can be downloaded at configure time (wget).
* If you don't want to or can't install Coin doc package, the links will be generated to access coin doc online at doc.coin3D.org, if doxygen tag file can be downloaded at configure time (wget).

Revision as of 18:46, 22 September 2014

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.

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

 make DevDoc

poi consultare i file HTML risultanti iniziando da Doc/SourceDocu/html/index.html (nota: l'obiettivo DevDoc non è valido per le costruzioni con autotools)

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í

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.
  • If you don't want to or can't install Coin doc package, the links will be generated to access coin doc online at doc.coin3D.org, if doxygen tag file can be downloaded at configure time (wget).
Extra python modules
List of Commands