Source documentation/ro: Difference between revisions

From FreeCAD Documentation
(Updating to match new version of source page)
(Updating to match new version of source page)
(33 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<languages/>
{{Docnav
|[[Extra python modules|Extra python modules]]
|[[List of Commands|List of Commands]]
}}
{{TOCright}}
<div class="mw-translate-fuzzy">
Codul sursă al FreeCAD este comentat pentru a permite generarea automată a documentației html cu [http://www.doxygen.org Doxygen]. Acesta este cazul atât pentru părțile C ++ și Python ale codului sursă FreeCAD.
</div>


<div class="mw-translate-fuzzy">
The online source documentation is located at http://www.freecadweb.org/api/
Documentația online este localizată la http://www.freecadweb.org/api/
</div>


Compiling the API documentation follows the same general steps as compiling the FreeCAD executable, as indicated in the [[Compile_on_Linux|Compile on Linux]] page.
The FreeCAD source code is commented to allow automatic html documentation generation with [http://www.doxygen.org Doxygen]. This is the case for both the C++ and Python parts of the FreeCAD source code.


[[File:FreeCAD_documentation_compilation_workflow.svg|800px]]
For those wanting to follow closely the latest development versions of FreeCAD, and who try to have a look at the C++ or Python parts, 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!


{{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.}}
In complement to this Wiki, the [http://www.freecadweb.org/api/ Source Documentation] can hopefully alleviate this feeling, providing an entry point, and allowing for easy browsing through the dozens of files and directories.


<div class="mw-translate-fuzzy">
=== Build source documentation ===
=== Construiți documentația codului sursă ===
</div>


<div class="mw-translate-fuzzy">
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
Dacă aveți instalat Doxygen, este foarte ușor să construiți documentul. Duceți-vă la directorul dvs. de construire FreeCAD, configurați-vă sursele cu CMake, problema
</div>
{{Code|code=
{{Code|code=
sudo apt install doxygen graphviz
make DevDoc
}}
}}
and consult the resulting html files starting from Doc/SourceDocu/html/index.html .


Then follow the same steps you would do to compile FreeCAD, as described on the [[Compile_on_Linux/Unix|compile on Unix]] page, and summarized here for convenience.
The DevDoc make target above will, if graphviz is installed on your system, generate a 2Gb+ volume of data. An alternative, smaller version (~500Mb), that is the version used on http://www.freecadweb.org/api/ can also be generated by issuing instead:
* 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=
{{Code|code=
git clone https://github.com/FreeCAD/FreeCAD.git freecad-source
make WebDoc
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.
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).
{{Code|code=
make -j$(nproc --ignore=2) DevDoc
}}
<div class="mw-translate-fuzzy">
și consultați fișierele html rezultate pornind de la 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:
As an alternative, the doc is generated from time to time and accessible on sourceforge [http://free-cad.sf.net/SrcDocu/index.html here].
{{Code|code=
xdg-open freecad-build/doc/SourceDocu/html/index.html
}}


<div class="mw-translate-fuzzy">
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].
DevDoc are un target foarte ridicat, dacă graficviz este instalat pe sistemul dvs., acesta va genera un volum de date de peste 2Gb +. O versiune alternativă, mai mică (~ 500Mb), adică versiunea folosită http://www.freecadweb.org/api/ can also be generated by issuing instead:
</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].
=== Integrate Coin3D documentation ===
{{Code|code=
make -j$(nproc --ignore=2) WebDoc
}}


<div class="mw-translate-fuzzy">
On unix systems, it is possible to link Coin3D source documentation with FreeCAD's.
Ca alternativă, doc-ul este generat din când în când și accesibil pe sourceforge [http://free-cad.sf.net/SrcDocu/index.html here].
It allows easier navigation and complete inheritance diagrams for Coin derived classes.
</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].
* On Debian and derived systems:

<div class="mw-translate-fuzzy">
Un altă documentație FreeCAD Doxygen [http://iesensor.com/FreeCADDoc/0.16-dev/ documentation] generată de [http://forum.freecadweb.org/viewtopic.php?t=12613 qingfeng.xia].
</div>

<div class="mw-translate-fuzzy">
=== Integrați documentația Coin3D ===
</div>

<div class="mw-translate-fuzzy">
Pe sistemele unix, este posibilă legarea documentației sursă Coin3D de FreeCAD.
Permite navigare mai ușoară și diagrame complete de moștenire pentru clasele derivate din Coin.
</div>

<div class="mw-translate-fuzzy">
* Sub Debian și sistemele derivate:
: - Install the package libcoin60-doc
: - Install the package libcoin60-doc
: - Uncompress the file /usr/share/doc/libcoin60-doc/html/coin.tag.gz
: - Uncompress the file /usr/share/doc/libcoin60-doc/html/coin.tag.gz
: - Regenerate source documentation
: - Regenerate source documentation
: You are up for offline browsing.
: You are up for offline browsing.
</div>


<div class="mw-translate-fuzzy">
* 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).
* Dacă nu doriți sau nu puteți instala pachetul Coin doc, legăturile vor fi generate pentru a accesa coin doc online la doc.coin3D.org, if doxygen tag file can be downloaded at configure time (wget).
</div>


<div class="mw-translate-fuzzy">
== How to integrate doxygen in to the FreeCAD source code ==
== Cum se integrează doxygen în codul sursă al FreeCAD ==
{{VeryImportantMessage|This is a Work In Progress. See [[Doxygen]]}}
{{VeryImportantMessage|This is a Work In Progress. See [[Doxygen]]}}
Example of a complete doxygen page: (from another project)
Examplu de pagină completă doxygen: (from another project)
</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.
doxygen: http://www.vtk.org/doc/nightly/html/classvtkArrayCoordinates.html


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.
source: https://github.com/Kitware/VTK/blob/master/Common/Core/vtkArrayCoordinates.h
{{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);
}}


<div class="mw-translate-fuzzy">
{{docnav|Extra python modules|List of Commands}}
{{docnav|Extra python modules|List of Commands}}
</div>


{{Userdocnavi{{#translation:}}}}
[[Category:Developer Documentation/ro]]
[[Category:Developer Documentation{{#translation:}}]]
{{clear}}
{{clear}}
<languages/>

Revision as of 15:13, 25 August 2020

Codul sursă al FreeCAD este comentat pentru a permite generarea automată a documentației html cu Doxygen. Acesta este cazul atât pentru părțile C ++ și Python ale codului sursă FreeCAD.

Documentația online este localizată la 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 Linux 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.

Construiți documentația codului sursă

Dacă aveți instalat Doxygen, este foarte ușor să construiți documentul. Duceți-vă la directorul dvs. de construire FreeCAD, configurați-vă sursele cu CMake, problema

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

și consultați fișierele html rezultate pornind de la 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

DevDoc are un target foarte ridicat, dacă graficviz este instalat pe sistemul dvs., acesta va genera un volum de date de peste 2Gb +. O versiune alternativă, mai mică (~ 500Mb), adică versiunea folosită http://www.freecadweb.org/api/ can also be generated by issuing instead:

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

Ca alternativă, doc-ul este generat din când în când și accesibil pe sourceforge here.

FreeCAD 0.16 development documentation built by qingfeng.xia.

Un altă documentație FreeCAD Doxygen documentation generată de qingfeng.xia.

Integrați documentația Coin3D

Pe sistemele unix, este posibilă legarea documentației sursă Coin3D de FreeCAD. Permite navigare mai ușoară și diagrame complete de moștenire pentru clasele derivate din Coin.

  • Sub Debian și sistemele derivate:
- 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.
  • Dacă nu doriți sau nu puteți instala pachetul Coin doc, legăturile vor fi generate pentru a accesa coin doc online la doc.coin3D.org, if doxygen tag file can be downloaded at configure time (wget).

Cum se integrează doxygen în codul sursă al FreeCAD

This is a Work In Progress. See Doxygen

Examplu de pagină completă doxygen: (from another project)

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);
Extra python modules
List of Commands