Source documentation: Difference between revisions

From FreeCAD Documentation
m (update link to the latest doxygen doc)
(More complete inormation)
Line 3: Line 3:
<!--T:21-->
<!--T:21-->
{{docnav|Extra python modules|List of Commands}}
{{docnav|Extra python modules|List of Commands}}

<!--T:16-->
The online source documentation is located at http://www.freecadweb.org/api/


<!--T:1-->
<!--T:1-->
The FreeCAD source code is commented to allow automatic html documentation generation with [http://www.doxygen.org Doxygen]. This is the case for both the C++ and Python parts of the FreeCAD source code.
The FreeCAD source code is commented to allow automatic HTML documentation generation using [http://www.doxygen.org Doxygen], a popular source code documentation system. Doxygen can document both the C++ and Python parts of FreeCAD.


<!--T:2-->
<!--T:16-->
The online source documentation is located at http://www.freecadweb.org/api/. Please note that this documentation is not always kept to date; if you have pressing questions about the code please ask in the developer section of the [https://forum.freecadweb.org/index.php FreeCAD forum].
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!


<!--T:3-->
== Build source documentation == <!--T:4-->
In complement to this Wiki, the [http://www.freecadweb.org/api/ 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 === <!--T:4-->


<!--T:5-->
<!--T:5-->
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
If you have Doxygen installed, it's very easy to build the documentation. Follow the same steps you would do to compile FreeCAD, as described on the [[CompileOnUnix|compile on Unix]] page; these steps are summarized here for convenience.
* Get the source code of FreeCAD and place it in its own directory {{incode|freecad-source}}.
* Create another directory {{incode|freecad-build}} in which you will compile FreeCAD and its documentation.
* Configure the sources with {{incode|cmake}}, making sure you point to the source directory, and specify the required options for your build.
* Trigger the creation of the documentation using {{incode|make}}.
{{Code|code=
git clone https://github.com/FreeCAD/FreeCAD.git freecad-source
mkdir freecad-build
cd freecad-build
cmake -DBUILD_QT5=ON -DPYTHON_EXECUTABLE=/usr/bin/python3 ../freecad-source
}}

While you are inside the build directory issue the following instruction to create only the documentation.
</translate>
</translate>
{{Code|code=
{{Code|code=
Line 26: Line 32:
<translate>
<translate>
<!--T:6-->
<!--T:6-->
and consult the resulting html files starting from Doc/SourceDocu/html/index.html .
The resulting documentation files will appear in the directory
{{Code|code=
freecad-build/doc/SourceDocu/html/
}}

The point of entrance to the documentation is the {{incode|index.html}} file, which you can open with your web browser:
{{Code|code=
xdg-open doc/SourceDocu/html/index.html
}}


<!--T:17-->
<!--T:17-->
Line 45: Line 59:
Here is another FreeCAD 0.19dev Doxygen [https://iesensor.com/FreeCADDoc/0.19/ documentation] as well as a previous version [https://iesensor.com/FreeCADDoc/0.16-dev/ 0.16dev_documentation], generate by [http://forum.freecadweb.org/viewtopic.php?t=12613 qingfeng.xia].
Here is another FreeCAD 0.19dev Doxygen [https://iesensor.com/FreeCADDoc/0.19/ documentation] as well as a previous version [https://iesensor.com/FreeCADDoc/0.16-dev/ 0.16dev_documentation], generate by [http://forum.freecadweb.org/viewtopic.php?t=12613 qingfeng.xia].


=== Integrate Coin3D documentation === <!--T:9-->
== Integrate Coin3D documentation == <!--T:9-->


<!--T:10-->
<!--T:10-->

Revision as of 01:26, 13 July 2019

Extra python modules
List of Commands

The FreeCAD source code is commented to allow automatic HTML documentation generation using Doxygen, a popular source code documentation system. Doxygen can document both the C++ and Python parts of FreeCAD.

The online source documentation is located at http://www.freecadweb.org/api/. Please note that this documentation is not always kept to date; if you have pressing questions about the code please ask in the developer section of the FreeCAD forum.

Build source documentation

If you have Doxygen installed, it's very easy to build the documentation. Follow the same steps you would do to compile FreeCAD, as described on the compile on Unix page; these steps are summarized here for convenience.

  • Get the source code of FreeCAD and place it in its own directory freecad-source.
  • Create another directory freecad-build in which you will compile FreeCAD and its documentation.
  • Configure the sources with cmake, making sure you point to the source directory, and specify the required options for your build.
  • Trigger the creation of the documentation using make.
git clone https://github.com/FreeCAD/FreeCAD.git freecad-source
mkdir freecad-build
cd freecad-build
cmake -DBUILD_QT5=ON -DPYTHON_EXECUTABLE=/usr/bin/python3 ../freecad-source

While you are inside the build directory issue the following instruction to create only the documentation.

make DevDoc

The resulting documentation files will appear in the directory

freecad-build/doc/SourceDocu/html/

The point of entrance to the documentation is the index.html file, which you can open with your web browser:

xdg-open doc/SourceDocu/html/index.html

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 http://www.freecadweb.org/api/ can also be generated by issuing instead:

make WebDoc

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 0.19dev Doxygen documentation as well as a previous version 0.16dev_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 doc.coin3D.org, if doxygen tag file can be downloaded at configure time (wget).

How to integrate doxygen in to the FreeCAD source code

This is a Work In Progress. See Doxygen

Example of a complete doxygen page: (from another project)

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

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

Extra python modules
List of Commands