Source documentation/it: Difference between revisions

From FreeCAD Documentation
mNo edit summary
(Updating to match new version of source page)
Line 1: Line 1:
FreeCAD source is commented to allow automatic html documentation generation with [http://www.doxygen.org Doxygen].
=Documentazione del codice sorgente=


For those wanting to follow closely the latest svn versions of FreeCAD, and who try to have a look at the c++ part, the first insight in the sources can give the feeling you're looking at an hedgehog: you can't discriminate head from tail and don't really know how to catch it!
Il codice sorgente di FreeCAD è commentato per consentire la generazione automatica della documentazione html con [http://www.doxygen.org Doxygen].


In complement to the Wiki, ''source documentation'' can hopefully alleviate this feeling, providing an entry point, and allowing for easy browsing through the dozens of files and directories.
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!


==== Build source documentation ====
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


If you have Doxygen installed, it's very easy to build the doc. Go to your FreeCAD build directory, configure your sources with CMake, issue
<syntaxhighlight>
make DevDoc
make DevDoc
</syntaxhighlight>
and consult the resulting html files starting from Doc/SourceDocu/html/index.html
(note: the DevDoc target is not valid for autotools builds)


By nature, source doc is, and will ever be, work in progress. Don't hesitate to rebuild as often as needed. If you fall upon blatant inadequacies, feel free to post on the forum (note: It is really fully checked with cMake build process only).
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 [http://free-cad.sf.net/SrcDocu/index.html quí]


As an alternative, the doc is generated from time to time and accessible on sourceforge [http://free-cad.sf.net/SrcDocu/index.html here]
==== Documentazione di Coin3D integrata ====


==== Integrate Coin3D documentation ====
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.


On unix systems, it is possible to link Coin3D source documentation with FreeCAD's.
* Su Debian e sistemi derivati:
It allows easier navigation and complete inheritance diagrams for Coin derived classes.
: - 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.


* On Debian and derived systems:
* 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).
: - Install the package libcoin60-doc
: - Uncompress the file /usr/share/doc/libcoin60-doc/html/coin.tag.gz
: - Regenerate source documentation
: 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).
{{docnav/it|[[Extra python modules/it|Moduli extra di Python]]|[[List of Commands/it|Elenco dei comandi]]}}


{{docnav|Extra python modules|List of Commands}}
{{languages/it | {{en|Source documentation}} {{fr|Source documentation/fr}} {{ru|Source documentation/ru}} {{se|Source documentation/se}} }}


[[Category:Developer Documentation/it]]
[[Category:Developer Documentation]]
{{clear}}
<languages/>

Revision as of 18:22, 22 September 2014

FreeCAD source is commented to allow automatic html documentation generation with Doxygen.

For those wanting to follow closely the latest svn versions of FreeCAD, and who try to have a look at the c++ part, the first insight in the sources can give the feeling you're looking at an hedgehog: you can't discriminate head from tail and don't really know how to catch it!

In complement to the Wiki, source documentation can hopefully alleviate this feeling, providing an entry point, and allowing for easy browsing through the dozens of files and directories.

Build source documentation

If you have Doxygen installed, it's very easy to build the doc. Go to your FreeCAD build directory, configure your sources with CMake, issue

 make DevDoc

and consult the resulting html files starting from Doc/SourceDocu/html/index.html (note: the DevDoc target is not valid for autotools builds)

By nature, source doc is, and will ever be, work in progress. Don't hesitate to rebuild as often as needed. If you fall upon blatant inadequacies, feel free to post on the forum (note: It is really fully checked with cMake build process only).

As an alternative, the doc is generated from time to time and accessible on sourceforge here

Integrate Coin3D documentation

On unix systems, it is possible to link Coin3D source documentation with FreeCAD's. It allows easier navigation and complete inheritance diagrams for Coin derived classes.

  • On Debian and derived systems:
- Install the package libcoin60-doc
- Uncompress the file /usr/share/doc/libcoin60-doc/html/coin.tag.gz
- Regenerate source documentation
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).
Extra python modules
List of Commands