54 lines
5.3 KiB
HTML
54 lines
5.3 KiB
HTML
<html><head><title>Source documentation/fr</title><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><link type='text/css' href='wiki.css' rel='stylesheet'></head><body><h1>Source documentation/fr</h1></div>
|
|
|
|
<div id="mw-content-text" lang="fr" dir="ltr" class="mw-content-ltr"><hr/>
|
|
<div class="mw-parser-output"><p>The online source documentation is located at <a rel="nofollow" class="external free" href="http://www.freecadweb.org/api/">http://www.freecadweb.org/api/</a>
|
|
</p><p>The FreeCAD source code is commented to allow automatic html documentation generation with <a rel="nofollow" class="external text" href="http://www.doxygen.org">Doxygen</a>. This is the case for both the C++ and Python parts of the FreeCAD source code.
|
|
</p><p>For those wanting to follow closely the latest development versions of FreeCAD, and who try to have a look at the C++ or Python parts, the first insight in the sources can give the feeling you're looking at an hedgehog: you can't discriminate head from tail and don't really know how to catch it!
|
|
</p><p>In complement to this Wiki, the <a rel="nofollow" class="external text" href="http://www.freecadweb.org/api/">Source Documentation</a> can hopefully alleviate this feeling, providing an entry point, and allowing for easy browsing through the dozens of files and directories.
|
|
</p>
|
|
<h3><span class="mw-headline" id="Build_source_documentation">Build source documentation</span></h3>
|
|
<p>Si vous avez installé <b>Doxygen</b>, il est très facile de compiler la doc. Accédez au répertoire de compilation de FreeCAD, et configurez vos sources avec <b>CMake</b> comme ceci :
|
|
</p>
|
|
<pre>make DevDoc </pre>
|
|
<p>et consultez les fichiers HTML résultants à partir de <b>Doc/SourceDocu/html/index.html</b>.
|
|
</p><p>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 <a rel="nofollow" class="external free" href="http://www.freecadweb.org/api/">http://www.freecadweb.org/api/</a> can also be generated by issuing instead:
|
|
</p>
|
|
<pre>make WebDoc </pre>
|
|
<p>Par nature, le <b>doc</b> source est, et sera toujours, le travail en cours. N'hésitez pas à recompiler aussi souvent que nécessaire.
|
|
</p><p>Si vous tombez sur des incohérences, n'hésitez pas à poster sur le <a rel="nofollow" class="external text" href="http://forum.freecadweb.org/index.php?sid=ad857735d732a972847711694ac67a92">forum</a> (PS : Vérifiez bien le processus de compilation avec CMake).
|
|
</p><p>As an alternative, the doc is generated from time to time and accessible on sourceforge <a rel="nofollow" class="external text" href="http://free-cad.sf.net/SrcDocu/index.html">here</a>.
|
|
</p><p>Here is another FreeCAD Doxygen <a rel="nofollow" class="external text" href="http://iesensor.com/FreeCADDoc/0.16-dev/">documentation</a> generate by <a rel="nofollow" class="external text" href="http://forum.freecadweb.org/viewtopic.php?t=12613">qingfeng.xia</a>.
|
|
</p>
|
|
<h3><span class="mw-headline" id="Integrate_Coin3D_documentation">Integrate Coin3D documentation</span></h3>
|
|
<p>Sur les systèmes Unix, il est possible de lier les documents sources <b>Coin3D</b> avec <b>FreeCAD</b>.
|
|
</p><p>Il permet une navigation plus facile dans l'arborescence des diagrammes, pour les classes <b>Coin</b> dérivées.
|
|
</p>
|
|
<ul><li> Sur les systèmes Debian et dérivés :</li></ul>
|
|
<dl><dd> - Installez le paquet <b>libcoin60-doc</b>.</dd>
|
|
<dd> - Décompressez le fichier <b>/usr/share/doc/libcoin60-doc/html/coin.tag.gz</b>.</dd>
|
|
<dd> - Régénérer le source de la documentation.</dd>
|
|
<dd> Vous êtes prêt pour la navigation hors ligne.</dd></dl>
|
|
<ul><li> Si vous ne voulez pas, ou ne pouvez pas installer <b>Coin doc package</b>, les liens seront générés pour accéder à <b>Coin doc</b> en ligne, sur <b><a rel="nofollow" class="external text" href="http://doc.coin3d.org/">doc.coin3D.org</a></b>, si le fichier <b>doxygen tag</b> peut être téléchargé au moment de la configuration (wget).</li></ul>
|
|
<h2><span class="mw-headline" id="How_to_integrate_doxygen_in_to_the_FreeCAD_source_code">How to integrate doxygen in to the FreeCAD source code</span></h2>
|
|
<div id="itsfree" style="text-align:center;color:black;background:#FDE0A8;margin:1em 7em;padding:0.5em 2em;border:2px solid #FF5706;">This is a Work In Progress. See <a href="Doxygen.html" title="Doxygen">Doxygen</a></div>
|
|
<p>Example of a complete doxygen page: (from another project)
|
|
</p><p>doxygen: <a rel="nofollow" class="external free" href="http://www.vtk.org/doc/nightly/html/classvtkArrayCoordinates.html">http://www.vtk.org/doc/nightly/html/classvtkArrayCoordinates.html</a>
|
|
</p><p>source: <a rel="nofollow" class="external free" href="https://github.com/Kitware/VTK/blob/master/Common/Core/vtkArrayCoordinates.h">https://github.com/Kitware/VTK/blob/master/Common/Core/vtkArrayCoordinates.h</a>
|
|
</p>
|
|
|
|
<div style="clear:both"></div>
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div><div class="printfooter">
|
|
Online version: "<a dir="ltr" href="https://www.freecadweb.org/wiki/index.php?title=Source_documentation/fr&oldid=223287">http://www.freecadweb.org/wiki/index.php?title=Source_documentation/fr&oldid=223287</a>"</div>
|
|
<div id="catlinks" class="catlinks" data-mw="interface"></div><div class="visualClear"></div>
|
|
</div>
|
|
</div>
|
|
<div id="mw-navigation">
|
|
<h2>Navigation menu</h2>
|
|
|
|
</body></html> |