Source documentation/ro: Difference between revisions

Revision as of 10:17, 13 July 2019

Other languages:

Extra python modules

List of Commands

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/

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 .

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

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

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)

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

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

Extra python modules

List of Commands

Index

User documentation

Getting started
Installation: Download, Windows, Linux, Mac, Additional components, Docker, AppImage, Ubuntu Snap
Basics: About FreeCAD, Interface, Mouse navigation, Selection methods, Object name, Preferences, Workbenches, Document structure, Properties, Help FreeCAD, Donate

Help: Tutorials, Video tutorials
Workbenches: Std Base, Arch, Assembly, CAM, Draft, FEM, Inspection, Mesh, OpenSCAD, Part, PartDesign, Points, Reverse Engineering, Robot, Sketcher, Spreadsheet, Start, Surface, TechDraw, Test Framework, Web

Addons: Addon Manager, External workbenches, Scripting and macros

Hubs: User hub, Power users hub, Developer hub

@@ Line 2: / Line 2: @@
 {{docnav|Extra python modules|List of Commands}}
+<div class="mw-translate-fuzzy">
-Documentația online este localizată la http://www.freecadweb.org/api/
 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">
-Pentru cei care doresc să urmărească îndeaproape ultimele versiuni de dezvoltare ale FreeCAD și care încearcă să se uite la părțile C ++ sau Python, prima viziune a surselor poate da sentimentul că te uiți la un arici: nu poți distinge capul de coada si nu știu cum să o prinda!
+Documentația online este localizată la http://www.freecadweb.org/api/
+</div>
-In completareala acest Wiki, the [http://www.freecadweb.org/api/ Source Documentation] poate să ușureze acest sentiment, oferind un punct de intrare și permițând navigarea ușoară prin zeci de fișiere și directoare.
+<div class="mw-translate-fuzzy">
 === Construiți documentația codului sursă ===
+</div>
+<div class="mw-translate-fuzzy">
 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=
+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">
 și consultați fișierele html rezultate pornind de la 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:
-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:
 {{Code|code=
+xdg-open freecad-build/doc/SourceDocu/html/index.html
-make WebDoc
 }}
+<div class="mw-translate-fuzzy">
-Prin natura sa, documentul sursă este și va fi mereu în dezvoltare. Nu ezitați să reconstruiți cât de des este nevoie. Dacă vă întâlniți cu  inadvertențe flagrante, nu ezitați să postați pe forum (nota: Este într-adevăr verificată în întregime doar cu procesul de construire a cMake).
+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 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">
 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].
+</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">
@@ Line 31: / Line 65: @@
 </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
@@ Line 41: / Line 80: @@
 : - Regenerate source documentation
 : You are up for offline browsing.
+</div>
+<div class="mw-translate-fuzzy">
 * 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>
 == Cum se integrează doxygen în codul sursă al FreeCAD ==