Source documentation/ro: Difference between revisions
(Created page with "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 navigare...") |
(Created page with "=== Construiți documentația sursă ===") |
||
| Line 8: | Line 8: | ||
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. |
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. |
||
=== |
=== Construiți documentația sursă === |
||
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 |
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 |
||
Revision as of 11:01, 8 August 2018
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 sursă
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
make DevDoc
and consult the resulting html files starting from Doc/SourceDocu/html/index.html .
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:
make WebDoc
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).
As an alternative, the doc is generated from time to time and accessible on sourceforge here.
Here is another FreeCAD Doxygen documentation generate by qingfeng.xia.
Integrate Coin3D documentation
On unix systems, it is possible to link Coin3D source documentation with FreeCAD's. It allows easier navigation and complete inheritance diagrams for Coin derived classes.
- On Debian and derived systems:
- - 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.
- 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).
How to integrate doxygen in to the FreeCAD source code
Example of a complete doxygen page: (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
