Source documentation

From FreeCAD Documentation
Revision as of 09:46, 18 July 2019 by FuzzyBot (talk | contribs) (Updating to match new version of source page)
Jump to: navigation, search
Other languages:
Deutsch • ‎English • ‎español • ‎français • ‎hrvatski • ‎italiano • ‎日本語 • ‎polski • ‎română • ‎русский • ‎svenska • ‎Türkçe • ‎中文(中国大陆)‎

El código fuente de FreeCAD está comentado para permitir la generación automática de la documentación html con Doxygen.

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.

Construcción de la documentación del código fuente

Si tienes Doxygen instalado, es muy sencillo construir la documentación. Vete al directorio de construcción de FreeCAD, configura tu código fuente con CMake, ejecuta

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

y consulta los archivos html resultantes empezando por Doc/SourceDocu/html/index.html (nota: el objetivo de DevDoc no es válido para la construcción con autotools)

freecad-build/doc/SourceDocu/html/

The point of entrance to the documentation is the index.html file, which you can open with a 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 600 MB can be generated with a different target. This is the version displayed on the FreeCAD API website.

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

Como una alternativa, la documentación es generada de vez en cuando y accesible en sourceforge aquí

FreeCAD 0.16 development documentation built by qingfeng.xia.

FreeCAD 0.19 development documentation built by qingfeng.xia.

Documentación de Coin3D integrada

En sistemas unix, es posible vincular la documentación del código fuente de Coin3D con la de FreeCAD. Esto permite una navegación más sencilla y diagramas de herencia completos para las clases derivadas de Coin.

  • En Debian y sistemas derivados:
- Instala el paquete libcoin60-doc
- Descomprime el archivo /usr/share/doc/libcoin60-doc/html/coin.tag.gz
- Regenera la documentación del código fuente
Ya estás listo para navegar offline.
  • Si no quieres o no puedes instalar el paquete de documentación de Coin, los vínculos serán generados para acceder a la documentación online de Coin en doc.coin3D.org, si los archivos de etiquetas de doxygen pueden ser descargados y configurados en el momento de configuración (wget).

How to integrate doxygen in to the FreeCAD source code

This is a work in progress. See Doxygen


This section explains how to comment your source code so that it can be processed by Doxygen to automatically create the documentation.

This is an example of how source code is documented. It looks into the source code of VTK, a 3D visualization library used to present multi-physics simulation results.

A class to store a collection of coordinates is defined in a C++ header file. The top part of the file is commented, and a few keywords are used, like @class, @brief, @sa, and @par to indicate important parts. Inside the class, before a function is called, a block of commented text explains what the function does, and its arguments.