Source documentation

From FreeCAD Documentation
Revision as of 08:29, 12 October 2010 by Midgetfc (talk | contribs) (updates to source documentation build)

FreeCAD source is commented to allow automatic html documentation generation with Doxygen.

For those wanting to follow closely the latest svn versions of FreeCAD, and who try to have a look at the c++ part, 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!

In complement to the Wiki, source documentation can hopefully alleviate this feeling, providing an entry point, and allowing for easy browsing through the dozens of files and directories.

If you have Doxygen installed, it's very easy to build the doc. Go to your FreeCAD build directory, issue

make DevDoc

and consult the resulting html files starting from Doc/SourceDocu/html/index.html

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).

As an alternative, the doc is generated from time to time and accessible on sourceforge here

Extra python modules
List of Commands
Available translations of this page: Template:Se