Source documentation/it: Difference between revisions

From FreeCAD Documentation
(Created page with "==== Costruire la documentazione del codice sorgente ====")
(Updating to match new version of source page)
(39 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<languages/>
Il codice sorgente di FreeCAD è commentato per consentire la generazione automatica della documentazione html con [http://www.doxygen.org Doxygen].
{{docnav/it|[[Extra python modules/it|Moduli extra di Python]]|[[List of Commands/it|Elenco dei comandi]]}}


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


Compiling the API documentation follows the same general steps as compiling the FreeCAD executable, as indicated in the [[CompileOnUnix|compile on Unix]] page.
==== Costruire la documentazione del codice sorgente ====


[[File:FreeCAD_documentation_compilation_workflow.svg|800px]]
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
</syntaxhighlight>
and consult the resulting html files starting from Doc/SourceDocu/html/index.html
(note: the DevDoc target is not valid for autotools builds)


{{Caption|General workflow to compile FreeCAD's programming documentation. The Doxygen and Graphviz packages must be in the system, as well as the FreeCAD source code itself. CMake configures the system so that with a single make instruction the documentation for the the entire project is compiled into many HTML files with diagrams.}}
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).


<div class="mw-translate-fuzzy">
As an alternative, the doc is generated from time to time and accessible on sourceforge [http://free-cad.sf.net/SrcDocu/index.html here]
=== Costruire la documentazione del codice sorgente ===
</div>


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


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.
On unix systems, it is possible to link Coin3D source documentation with FreeCAD's.
* Get the source code of FreeCAD and place it in its own directory {{incode|freecad-source}}.
It allows easier navigation and complete inheritance diagrams for Coin derived classes.
* 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.
* On Debian and derived systems:
{{Code|code=
: - Install the package libcoin60-doc
make -j$(nproc --ignore=2) DevDoc
: - Uncompress the file /usr/share/doc/libcoin60-doc/html/coin.tag.gz
}}
: - Regenerate source documentation
<div class="mw-translate-fuzzy">
: You are up for offline browsing.
si possono consultare i file HTML risultanti iniziando da Doc/SourceDocu/html/index.html
</div>
{{Code|code=
freecad-build/doc/SourceDocu/html/
}}


The point of entrance to the documentation is the {{incode|index.html}} file, which you can open with a web browser:
* 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).
{{Code|code=
xdg-open freecad-build/doc/SourceDocu/html/index.html
}}


<div class="mw-translate-fuzzy">
{{docnav|Extra python modules|List of Commands}}
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 600 MB can be generated with a different target. This is the version displayed on the [http://www.freecadweb.org/api/ FreeCAD API website].
[[Category:Developer Documentation]]
{{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í]
</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] .
</div>

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

<div class="mw-translate-fuzzy">
== Come integrare doxygen in al codice sorgente di FreeCAD ==
{{VeryImportantMessage|Si tratta di un lavoro in corso. Vedere [[Doxygen]]}}
Esempio di una pagina doxygen completa: (da un altro progetto)
</div>

See the [[Doxygen|Doxygen]] page for an extensive explanation on how to comment C++ and Python source code so that it can be processed by Doxygen to automatically create the documentation.

Essentially, a comment block, starting with {{incode|/**}} or {{incode|///}} for C++, or {{incode|##}} for Python, needs to appear before every class or function definition, so that it is picked up by Doxygen. Many [[Doxygen#Doxygen markup|special commands]], which start with {{incode|\}} or {{incode|@}}, can be used to define parts of the code and format the output. [[Doxygen#Markdown support|Markdown syntax]] is also understood within the comment block, which makes it convenient to emphasize certain parts of the documentation.
{{Code|code=
/**
* Returns the name of the workbench object.
*/
std::string name() const;

/**
* Set the name to the workbench object.
*/
void setName(const std::string&);

/// remove the added TaskWatcher
void removeTaskWatcher(void);
}}

{{docnav/it|[[Extra python modules/it|Moduli extra di Python]]|[[List of Commands/it|Elenco dei comandi]]}}

{{Userdocnavi/it}}

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

Revision as of 20:48, 6 August 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/

Compiling the API documentation follows the same general steps as compiling the FreeCAD executable, as indicated in the compile on Unix page.

General workflow to compile FreeCAD's programming documentation. The Doxygen and Graphviz packages must be in the system, as well as the FreeCAD source code itself. CMake configures the system so that with a single make instruction the documentation for the the entire project is compiled into many HTML files with diagrams.

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

freecad-build/doc/SourceDocu/html/

The point of entrance to the documentation is the index.html file, which you can open with a 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 600 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)

See the Doxygen page for an extensive explanation on how to comment C++ and Python source code so that it can be processed by Doxygen to automatically create the documentation.

Essentially, a comment block, starting with /** or /// for C++, or ## for Python, needs to appear before every class or function definition, so that it is picked up by Doxygen. Many special commands, which start with \ or @, can be used to define parts of the code and format the output. Markdown syntax is also understood within the comment block, which makes it convenient to emphasize certain parts of the documentation.

/**
 * Returns the name of the workbench object.
 */
std::string name() const;

/**
 * Set the name to the workbench object.
 */
void setName(const std::string&);

/// remove the added TaskWatcher
void removeTaskWatcher(void);