Source documentation/fr

Le code source de FreeCAD est commenté pour permettre la génération automatique de documentation HTML à l'aide de Doxygen, un système de documentation de code source populaire. Doxygen peut documenter les parties C++ et Python de FreeCAD.

La documentation source en ligne est située sur web. Veuillez noter que cette documentation n'est pas toujours conservée à ce jour. si vous avez des questions urgentes sur le code, veuillez demander dans la section développeurs du FreeCAD forum.

Compilation de la documentation
Si vous avez installé Doxygen, il est très facile de construire la documentation. Installez également Graphviz pour pouvoir produire des diagrammes montrant les relations entre différentes classes et bibliothèques dans le code FreeCAD. Graphviz est également utilisé par graphe de dépendance de FreeCAD pour montrer les relations entre différents objets.

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.

et consultez les fichiers HTML résultants à partir de Doc/SourceDocu/html/index.html.

The point of entrance to the documentation is the file, which you can open with a web browser:

La cible DevDoc ci-dessus permettra, si graphviz est installé sur votre système, de générer un volume de données supérieur à 2 Go. Une version alternative plus petite (~ 500 Mo), qui est la version utilisée sur http://www.freecadweb.org/api/ peut également être générée en saisissant à la place :

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.

Comme alternative, la doc est générée de temps en temps, et accessible sur sourceforge ici.

FreeCAD 0.16 development documentation built by qingfeng.xia.

Voici une autre documentation FreeCAD 0.19dev Doxygen ainsi qu'une version précédente 0.16dev_documentation, générée par qingfeng.xia.

Intégrer la documentation Coin3D
Sur les systèmes Unix, il est possible de lier les documents sources Coin3D avec FreeCAD.

Il permet une navigation plus facile dans l'arborescence des diagrammes, pour les classes Coin dérivées.


 * Sur les systèmes Debian et dérivés :
 * - Installez le paquet libcoin60-doc.
 * - Décompressez le fichier /usr/share/doc/libcoin60-doc/html/coin.tag.gz.
 * - Régénérer le source de la documentation.
 * Vous êtes prêt pour la navigation hors ligne.


 * Si vous ne voulez pas, ou ne pouvez pas installer Coin doc package, les liens seront générés pour accéder à Coin doc en ligne, sur doc.coin3D.org, si le fichier doxygen tag peut être téléchargé au moment de la configuration (wget).

Comment intégrer doxygen dans le code source de FreeCAD
Exemple de page complète doxygen : (d'un autre projet)

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