Source documentation: Difference between revisions

From FreeCAD Documentation
(FreeCAD API website)
(Also install Graphviz to be able to produce graphics showing the relationships between different software libraries and classes. <translate> guards surrounding code. Removed old sentences)
Line 13: Line 13:


<!--T:5-->
<!--T:5-->
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.
If you have Doxygen installed, it is very easy to build the documentation. Also install Graphviz to be able to produce diagrams showing the relationships between different classes and libraries in the code.
</translate>
{{Code|code=
sudo apt install doxygen graphviz
}}
<translate>

Then follow the same steps you would do to compile FreeCAD, as described on the [[CompileOnUnix|compile on Unix]] page, and summarized here for convenience.
* Get the source code of FreeCAD and place it in its own directory {{incode|freecad-source}}.
* 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.
* 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.
* Configure the sources with {{incode|cmake}}, making sure you indicate the source directory, and specify the required options for your build.
* Trigger the creation of the documentation using {{incode|make}}.
* Trigger the creation of the documentation using {{incode|make}}.
</translate>
{{Code|code=
{{Code|code=
git clone https://github.com/FreeCAD/FreeCAD.git freecad-source
git clone https://github.com/FreeCAD/FreeCAD.git freecad-source
Line 24: Line 32:
cmake -DBUILD_QT5=ON -DPYTHON_EXECUTABLE=/usr/bin/python3 ../freecad-source
cmake -DBUILD_QT5=ON -DPYTHON_EXECUTABLE=/usr/bin/python3 ../freecad-source
}}
}}
<translate>


While you are inside the build directory issue the following instruction to create only the documentation.
While you are inside the build directory issue the following instruction to create only the documentation.
</translate>
</translate>
{{Code|code=
{{Code|code=
make DevDoc
make -j$(nproc --ignore=2) DevDoc
}}
}}
<translate>
<translate>
<!--T:6-->
<!--T:6-->
The resulting documentation files will appear in the directory
As mentioned in [[Compiling (Speeding up)|compiling (speeding up)]], the {{incode|-j}} option helps shorten compilation time. The resulting documentation files will appear in the directory
{{Code|code=
{{Code|code=
freecad-build/doc/SourceDocu/html/
freecad-build/doc/SourceDocu/html/
Line 39: Line 48:
The point of entrance to the documentation is the {{incode|index.html}} file, which you can open with your web browser:
The point of entrance to the documentation is the {{incode|index.html}} file, which you can open with your web browser:
{{Code|code=
{{Code|code=
xdg-open doc/SourceDocu/html/index.html
xdg-open freecad-build/doc/SourceDocu/html/index.html
}}
}}


<!--T:17-->
<!--T:17-->
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:
The {{incode|DevDoc}} target will generate a significant amount of data, around 2 GB of new files, particularly due to the diagrams created by Graphviz.

An alternative, smaller version of the documentation which takes only around 500 MB can be generated with a different target. This is the version displayed on the [http://www.freecadweb.org/api/ FreeCAD API] website.
</translate>
</translate>
{{Code|code=
{{Code|code=
make WebDoc
make -j$(nproc --ignore=2) WebDoc
}}
}}
<translate>
<translate>

<!--T:7-->
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).


<!--T:8-->
<!--T:8-->
As an alternative, the doc is generated from time to time and accessible on sourceforge [http://free-cad.sf.net/SrcDocu/index.html here].
Old FreeCAD 0.12 API documentation is [http://free-cad.sf.net/SrcDocu/index.html here].


<!--T:15-->
<!--T:15-->

Revision as of 03: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 the FreeCAD API website. 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 is very easy to build the documentation. Also install Graphviz to be able to produce diagrams showing the relationships between different classes and libraries in the code.

sudo apt install doxygen graphviz

Then follow the same steps you would do to compile FreeCAD, as described on the compile on Unix page, and 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 indicate 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 -j$(nproc --ignore=2) DevDoc

As mentioned in compiling (speeding up), the -j option helps shorten compilation time. 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 freecad-build/doc/SourceDocu/html/index.html

The DevDoc target will generate a significant amount of data, around 2 GB of new files, particularly due to the diagrams created by Graphviz.

An alternative, smaller version of the documentation which takes only around 500 MB can be generated with a different target. This is the version displayed on the FreeCAD API website.

make -j$(nproc --ignore=2) WebDoc

Old FreeCAD 0.12 API documentation is 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