Source documentation/ro

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 Unix page.



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

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.
 * Create another directory in which you will compile FreeCAD and its documentation.
 * Configure the sources with, making sure you indicate the source directory, and specify the required options for your build.
 * Trigger the creation of the documentation using.

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

și consultați fișierele html rezultate pornind de la Doc/SourceDocu/html/index.html.

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

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.

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