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.

Suivez ensuite les mêmes étapes que pour compiler FreeCAD, comme décrit à la page Compiler sous Unix, et résumées ici pour plus de commodité.
 * Obtenez le code source de FreeCAD et placez-le dans son propre répertoire.
 * Créez un autre répertoire dans lequel vous compilerez FreeCAD et sa documentation.
 * Configurez les sources avec, en vous assurant d'indiquer le répertoire source et de spécifier les options requises pour votre construction.
 * Déclenchez la création de la documentation avec.

Pendant que vous êtes dans le répertoire de compilation, émettez les instructions suivantes pour ne créer que la documentation.

Comme mentionné dans Compilation (Accélération), l'option  définit le nombre de cœurs de processeur utilisés pour la compilation. Les fichiers de documentation résultants apparaîtront dans le répertoire

Le point d’entrée de la documentation est le fichier, que vous pouvez ouvrir avec un navigateur Web:

La cible générera une quantité importante de données, environ 5 Go de nouveaux fichiers, en raison notamment des diagrammes créés par Graphviz.

Une autre version plus petite de la documentation, qui ne nécessite qu'environ 600 Mo, peut être générée avec une cible différente. Ceci est la version affichée sur le site Web de l'API FreeCAD.

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

FreeCAD 0.16 development documentation construite par qingfeng.xia.

FreeCAD 0.19 development documentation construite par qingfeng.xia.

Intégrer la documentation Coin3D
Sur les systèmes Unix, il est possible de lier la documentation source Coin3D avec FreeCAD. Cela facilite la navigation et complète les diagrammes d'héritage pour les classes dérivées de Coin.


 * Installez le, , ou un paquetage similaire.
 * Décompressez l'archive située dans ; les fichiers sont peut-être déjà décompressés dans votre système.
 * Générez à nouveau la documentation source.

Si vous n'installez pas le package de documentation pour Coin, les liens seront générés pour accéder à la documentation en ligne à l'adresse BitBucket. Cela se produira si un fichier de balise Doxygen peut être téléchargé au moment de la configuration avec.

Comment intégrer doxygen dans le code source de FreeCAD
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