Source documentation/fr

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

Le code source de FreeCAD est commenté de manière à permettre la génération automatique de la documentation html avec Doxygen. C'est le cas pour les parties C++ et Python du code source FreeCAD.

Pour ceux qui souhaitent suivre de près les dernières versions de développement de FreeCAD et consulter les parties C++ ou Python, le premier aperçu des sources peut donner l’impression de regarder un hérisson : vous ne pouvez pas distinguer la tête de la queue et ne pas savoir vraiment comment l'attraper !

En complément de ce wiki, la documentation du code source pourrait, espérons le, atténuer ce sentiment, en fournissant un point d'entrée et en facilitant la navigation dans des 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.

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 :

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 sur sourceforge ici.

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)

doxygen : http://www.vtk.org/doc/nightly/html/classvtkArrayCoordinates.html

source : https://github.com/Kitware/VTK/blob/master/Common/Core/vtkArrayCoordinates.h