Source documentation/hr: Difference between revisions

From FreeCAD Documentation
(Updating to match new version of source page)
(Updating to match new version of source page)
Line 2: Line 2:
{{docnav|Extra python modules|List of Commands}}
{{docnav|Extra python modules|List of Commands}}


⚫
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.
The online source documentation is located at http://www.freecadweb.org/api/


The online source documentation is located at the [http://www.freecadweb.org/api/ 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 [https://forum.freecadweb.org/index.php FreeCAD forum].
⚫
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.


⚫
== Build source documentation ==
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!


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.
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.
{{Code|code=
sudo apt install doxygen graphviz
}}


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.
⚫
=== Build source documentation ===
* 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 indicate 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.
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
{{Code|code=
{{Code|code=
make DevDoc
make -j$(nproc --ignore=2) DevDoc
}}
}}
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
and consult the resulting html files starting from Doc/SourceDocu/html/index.html .
{{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 freecad-build/doc/SourceDocu/html/index.html
}}

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


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:
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].
{{Code|code=
{{Code|code=
make WebDoc
make -j$(nproc --ignore=2) WebDoc
}}
}}


== Other versions ==
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).
[http://free-cad.sf.net/SrcDocu/index.html FreeCAD 0.12] documentation hosted in Sourceforge.


[https://iesensor.com/FreeCADDoc/0.16-dev/ FreeCAD 0.16 development] documentation built by [http://forum.freecadweb.org/viewtopic.php?t=12613 qingfeng.xia].
As an alternative, the doc is generated from time to time and accessible on sourceforge [http://free-cad.sf.net/SrcDocu/index.html here].


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].
[https://iesensor.com/FreeCADDoc/0.19/ FreeCAD 0.19 development] documentation built by [http://forum.freecadweb.org/viewtopic.php?t=12613 qingfeng.xia].


=== Integrate Coin3D documentation ===
== Integrate Coin3D documentation ==


On unix systems, it is possible to link Coin3D source documentation with FreeCAD's.
On Unix systems it is possible to link Coin3D source documentation with FreeCAD's. This allows for easier navigation and complete inheritance diagrams for Coin derived classes.
It allows easier navigation and complete inheritance diagrams for Coin derived classes.


*Install the {{incode|libcoin-doc}}, {{incode|libcoin80-doc}}, or similarly named package.
* On Debian and derived systems:
*Unpack the archive {{incode|coin.tar.gz}} located in {{incode|/usr/share/doc/libcoin-doc/html}}; the files may be already unpacked in your system.
: - Install the package libcoin60-doc
⚫
*Generate again the source documentation.
: - 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).
If you don't install the documentation package for Coin, the links will be generated to access the online documentation at [https://coin3d.bitbucket.io/Coin/ BitBucket]. This will happen if a Doxygen tag file can be downloaded at configure time with {{incode|wget}}.


== How to integrate doxygen in to the FreeCAD source code ==
== How to integrate doxygen in to the FreeCAD source code ==

Revision as of 10:17, 13 July 2019

Other languages:
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 5 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

Other versions

FreeCAD 0.12 documentation hosted in Sourceforge.

FreeCAD 0.16 development documentation built by qingfeng.xia.

FreeCAD 0.19 development documentation built by qingfeng.xia.

Integrate Coin3D documentation

On Unix systems it is possible to link Coin3D source documentation with FreeCAD's. This allows for easier navigation and complete inheritance diagrams for Coin derived classes.

  • Install the libcoin-doc, libcoin80-doc, or similarly named package.
  • Unpack the archive coin.tar.gz located in /usr/share/doc/libcoin-doc/html; the files may be already unpacked in your system.
  • Generate again the source documentation.

If you don't install the documentation package for Coin, the links will be generated to access the online documentation at BitBucket. This will happen if a Doxygen tag file can be downloaded at configure time with 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/hr
List of Commands/hr
User documentation
Retrieved from "http://wiki.freecad.org/index.php?title=Source_documentation/hr&oldid=493553"