Source documentation/ro

Extra python modules

List of Commands

Index

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 .

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)

This section explains how to comment your source code so that it can be processed by Doxygen to automatically create the documentation.

This is an example of how source code is documented. It looks into the source code of VTK, a 3D visualization library used to present multi-physics simulation results.

A class to store a collection of coordinates is defined in a C++ header file. The top part of the file is commented, and a few keywords are used, like @class, @brief, @sa, and @par to indicate important parts. Inside the class, before a function is called, a block of commented text explains what the function does, and its arguments.

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