Source documentation/ro

Documentația online are izvorul localizat la http://www.freecadweb.org/api/

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.

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!

In completareala acest Wiki, the 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.

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

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

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

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

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)

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

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