Source documentation

From FreeCAD Documentation
Revision as of 04:58, 21 June 2016 by Randy19962 (talk | contribs)
Jump to navigation Jump to search

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.

Build source documentation

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

 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.

Here is another FreeCAD Doxygen documentation generate by qingfeng.xia.

Integrate Coin3D documentation

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.

  • On Debian and derived systems:
- Install the package libcoin60-doc
- Uncompress the file /usr/share/doc/libcoin60-doc/html/coin.tag.gz
- Regenerate source documentation
You are up for offline browsing.
  • If you don't want to or can't install Coin doc package, the links will be generated to access coin doc online at, if doxygen tag file can be downloaded at configure time (wget).
Other languages:
Deutsch • ‎English • ‎Türkçe • ‎español • ‎français • ‎hrvatski • ‎italiano • ‎polski • ‎română • ‎svenska • ‎русский • ‎中文(中国大陆)‎ • ‎日本語