52 lines
4.8 KiB
HTML
52 lines
4.8 KiB
HTML
<html><head><title>Source documentation/en</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/en</h1></div>
|
|
|
|
<div id="mw-content-text" lang="en" 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>If you have Doxygen installed, it's very easy to build the doc. Go to your FreeCAD build directory, configure your sources with CMake, issue
|
|
</p>
|
|
<pre>make DevDoc </pre>
|
|
<p>and consult the resulting html files starting from Doc/SourceDocu/html/index.html .
|
|
</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>By nature, source doc is, and will ever be, work in progress. Don't hesitate to rebuild as often as needed. If you fall upon blatant inadequacies, feel free to post on the forum (note: It is really fully checked with cMake build process only).
|
|
</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>On unix systems, it is possible to link Coin3D source documentation with FreeCAD's.
|
|
It allows easier navigation and complete inheritance diagrams for Coin derived classes.
|
|
</p>
|
|
<ul><li> On Debian and derived systems:</li></ul>
|
|
<dl><dd> - Install the package libcoin60-doc</dd>
|
|
<dd> - Uncompress the file /usr/share/doc/libcoin60-doc/html/coin.tag.gz</dd>
|
|
<dd> - Regenerate source documentation</dd>
|
|
<dd> You are up for offline browsing.</dd></dl>
|
|
<ul><li> If you don't want to or can't install Coin doc package, the links will be generated to access coin doc online at doc.coin3D.org, if doxygen tag file can be downloaded at configure time (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/en&oldid=223295">http://www.freecadweb.org/wiki/index.php?title=Source_documentation/en&oldid=223295</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> |