Source documentation/fr

La documentation source en ligne est située àhttp://www.freecadweb.org/api/

Le source de FreeCAD, est commenté de manière à permettre la génération automatique de la documentation html avec Doxygen.

Pour ceux qui veulent suivre de près les dernières versions SVN de FreeCAD, et qui essayent de voir un aperçu des sources de la partie C++, peut donner le sentiment de chercher un hérisson, vous ne pouvez distinguer ni queue ni tête, et, vous ne savez pas comment l'attraper !

En complément du Wiki, documentation source vous pouvez espérer atténuer ce sentiment, en trouvant un point d'entrée, et permettre une navigation aisée à travers les dizaines de fichiers et de répertoires.

Compilation de la documentation
Si vous avez installé Doxygen, il est très facile de compiler la doc. Accédez au répertoire de compilation de FreeCAD, et configurez vos sources avec CMake comme ceci :

et consultez les fichiers HTML résultants à partir de 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:

Par nature, le doc source est, et sera toujours, le travail en cours. N'hésitez pas à recompiler aussi souvent que nécessaire.

Si vous tombez sur des incohérences, n'hésitez pas à poster sur le forum (PS : Vérifiez bien le processus de compilation avec CMake).

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

Here is another FreeCAD Doxygen documentation generate by 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).

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