Source documentation/es

The online source documentation is located at http://www.freecadweb.org/api/

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

Para aquellos que quieran seguir de cerca las últimas versiones svn de FreeCAD, y que intenten echar un vistazo a la parte de c++, el primer vistazo al código fuente puede dar la sensación de que estas viendo a un erizo: no puedes discriminar de los pies a la cabeza y no sabes realmente como gogerlo!

En complemento a la wiki, la documentación del código fuente esperamos que pueda aliviar esta sensación, proporcionando un punto de entrada, y permitiendo de forma sencilla navegar a través de las docenas de archivos y directorios.

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

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)

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:

Por naturaleza, la documentación del código fuente es, y siempre será, un trabajo en curso. No dudes en reconstruirla tan frecuentemente como necesites. Si caes en una inadecuación obstensible, eres libre de publicarla en los foros (nota: Sólo está realmente comprobado por completo con el proceso de construcción con cMake).

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

Here is another FreeCAD 0.19dev Doxygen documentation as well as a previous version 0.16dev_documentation, generate 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
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