Source documentation/it: Difference between revisions

From FreeCAD Documentation
No edit summary
(Updating to match new version of source page)
Line 2: Line 2:
{{docnav/it|[[Extra python modules/it|Moduli extra di Python]]|[[List of Commands/it|Elenco dei comandi]]}}
{{docnav/it|[[Extra python modules/it|Moduli extra di Python]]|[[List of Commands/it|Elenco dei comandi]]}}


<div class="mw-translate-fuzzy">
La documentazione online del sorgente si trova in http://www.freecadweb.org/api/

Il codice sorgente di FreeCAD è commentato per consentire la generazione automatica della documentazione html con [http://www.doxygen.org Doxygen]. Questo vale sia per la parte C++ che per la parte Python del codice sorgente di FreeCAD.
Il codice sorgente di FreeCAD è commentato per consentire la generazione automatica della documentazione html con [http://www.doxygen.org Doxygen]. Questo vale sia per la parte C++ che per la parte Python del codice sorgente di FreeCAD.
</div>


<div class="mw-translate-fuzzy">
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!
La documentazione online del sorgente si trova in http://www.freecadweb.org/api/

</div>
A complemento di questo Wiki, speriamo che la the [http://www.freecadweb.org/api/ 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.


<div class="mw-translate-fuzzy">
=== Costruire la documentazione del codice sorgente ===
=== Costruire la documentazione del codice sorgente ===
</div>


<div class="mw-translate-fuzzy">
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
</div>
{{Code|code=
{{Code|code=
sudo apt install doxygen graphviz
make DevDoc
}}
}}

Then follow the same steps you would do to compile FreeCAD, as described on the [[CompileOnUnix|compile on Unix]] page, and summarized here for convenience.
* Get the source code of FreeCAD and place it in its own directory {{incode|freecad-source}}.
* Create another directory {{incode|freecad-build}} in which you will compile FreeCAD and its documentation.
* Configure the sources with {{incode|cmake}}, making sure you indicate the source directory, and specify the required options for your build.
* Trigger the creation of the documentation using {{incode|make}}.
{{Code|code=
git clone https://github.com/FreeCAD/FreeCAD.git freecad-source
mkdir freecad-build
cd freecad-build
cmake -DBUILD_QT5=ON -DPYTHON_EXECUTABLE=/usr/bin/python3 ../freecad-source
}}

While you are inside the build directory issue the following instruction to create only the documentation.
{{Code|code=
make -j$(nproc --ignore=2) DevDoc
}}
<div class="mw-translate-fuzzy">
si possono consultare i file HTML risultanti iniziando da Doc/SourceDocu/html/index.html
si possono consultare i file HTML risultanti iniziando da Doc/SourceDocu/html/index.html
</div>


The point of entrance to the documentation is the {{incode|index.html}} file, which you can open with your web browser:
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 http://www.freecadweb.org/api/ e che si ottiene con:
{{Code|code=
{{Code|code=
xdg-open freecad-build/doc/SourceDocu/html/index.html
make WebDoc
}}
}}


<div class="mw-translate-fuzzy">
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).
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 http://www.freecadweb.org/api/ e che si ottiene con:
</div>


An alternative, smaller version of the documentation which takes only around 500 MB can be generated with a different target. This is the version displayed on the [http://www.freecadweb.org/api/ FreeCAD API website].
{{Code|code=
make -j$(nproc --ignore=2) WebDoc
}}

<div class="mw-translate-fuzzy">
In alternativa, la documentazione viene generata di volta in volta ed è accessibile su sourceforge [http://free-cad.sf.net/SrcDocu/index.html quí]
In alternativa, la documentazione viene generata di volta in volta ed è accessibile su sourceforge [http://free-cad.sf.net/SrcDocu/index.html quí]
</div>

[https://iesensor.com/FreeCADDoc/0.16-dev/ FreeCAD 0.16 development] documentation built by [http://forum.freecadweb.org/viewtopic.php?t=12613 qingfeng.xia].


<div class="mw-translate-fuzzy">
Questo è un altro FreeCAD 0.19dev Doxygen [https://iesensor.com/FreeCADDoc/0.19/ documentation] generato da [http://forum.freecadweb.org/viewtopic.php?t=12613 qingfeng.xia] così come una versione precedente [https://iesensor.com/FreeCADDoc/0.16-dev/ 0.16dev_documentation] .
Questo è un altro FreeCAD 0.19dev Doxygen [https://iesensor.com/FreeCADDoc/0.19/ documentation] generato da [http://forum.freecadweb.org/viewtopic.php?t=12613 qingfeng.xia] così come una versione precedente [https://iesensor.com/FreeCADDoc/0.16-dev/ 0.16dev_documentation] .
</div>


<div class="mw-translate-fuzzy">
=== Documentazione di Coin3D integrata ===
=== Documentazione di Coin3D integrata ===
</div>


<div class="mw-translate-fuzzy">
Sui sistemi Unix, è possibile collegare la documentazione del codice sorgente di Coin3D con quella di FreeCAD.
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.
Questo consente una navigazione più agevole e diagrammi di ereditarietà completi per le classi derivate da Coin.
</div>


<div class="mw-translate-fuzzy">
* Su Debian e sistemi derivati:
* Su Debian e sistemi derivati:
: - Installare il pacchetto libcoin60-doc
: - Installare il pacchetto libcoin60-doc
Line 39: Line 80:
: - Rigenerare la documentazione del codice sorgente
: - Rigenerare la documentazione del codice sorgente
: E si è pronti per navigare offline.
: E si è pronti per navigare offline.
</div>


<div class="mw-translate-fuzzy">
* 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).
* 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).
</div>


== Come integrare doxygen in al codice sorgente di FreeCAD ==
== Come integrare doxygen in al codice sorgente di FreeCAD ==

Revision as of 10:20, 13 July 2019

Il codice sorgente di FreeCAD è commentato per consentire la generazione automatica della documentazione html con Doxygen. Questo vale sia per la parte C++ che per la parte Python del codice sorgente di FreeCAD.

La documentazione online del sorgente si trova in http://www.freecadweb.org/api/

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

sudo apt install doxygen graphviz

Then follow the same steps you would do to compile FreeCAD, as described on the compile on Unix page, and summarized here for convenience.

  • Get the source code of FreeCAD and place it in its own directory freecad-source.
  • Create another directory freecad-build in which you will compile FreeCAD and its documentation.
  • Configure the sources with cmake, making sure you indicate the source directory, and specify the required options for your build.
  • Trigger the creation of the documentation using make.
git clone https://github.com/FreeCAD/FreeCAD.git freecad-source
mkdir freecad-build
cd freecad-build
cmake -DBUILD_QT5=ON -DPYTHON_EXECUTABLE=/usr/bin/python3 ../freecad-source

While you are inside the build directory issue the following instruction to create only the documentation.

make -j$(nproc --ignore=2) DevDoc

si possono consultare i file HTML risultanti iniziando da Doc/SourceDocu/html/index.html

The point of entrance to the documentation is the index.html file, which you can open with your web browser:

xdg-open freecad-build/doc/SourceDocu/html/index.html

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 http://www.freecadweb.org/api/ e che si ottiene con:

An alternative, smaller version of the documentation which takes only around 500 MB can be generated with a different target. This is the version displayed on the FreeCAD API website.

make -j$(nproc --ignore=2) WebDoc

In alternativa, la documentazione viene generata di volta in volta ed è accessibile su sourceforge quí

FreeCAD 0.16 development documentation built by qingfeng.xia.

Questo è un altro FreeCAD 0.19dev Doxygen documentation generato da qingfeng.xia così come una versione precedente 0.16dev_documentation .

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).

Come integrare doxygen in al codice sorgente di FreeCAD

Si tratta di un lavoro in corso. Vedere Doxygen

Esempio di una pagina doxygen completa: (da un altro progetto)

doxygen: http://www.vtk.org/doc/nightly/html/classvtkArrayCoordinates.html

sorgente: https://github.com/Kitware/VTK/blob/master/Common/Core/vtkArrayCoordinates.h