Source documentation/es

Vista general
El código fuente de FreeCAD se comenta para permitir la generación automática de documentación de programación usando Doxygen, un popular sistema de documentación de código fuente. Doxygen puede documentar tanto la parte C++ como la parte Python de FreeCAD, dando como resultado páginas HTML con hipervínculos a cada función y clase documentada.

La documentación está alojada en línea en el Sitio web de FreeCAD API. Tenga en cuenta que esta documentación puede no estar siempre actualizada; si necesita más detalles, descargue el último código fuente de FreeCAD y compile la documentación usted mismo. Si tienes preguntas urgentes sobre el código, por favor, pregúntalas en la sección de desarrolladores del Foro de FreeCAD.

La compilación de la documentación de la API sigue los mismos pasos generales que la compilación del ejecutable de FreeCAD, como se indica en la página Compilar en Linux.



Complete documentation
Si tienes Doxygen instalado, es muy fácil construir la documentación. También instala Graphviz para poder producir diagramas que muestren las relaciones entre las diferentes clases y bibliotecas en el código de FreeCAD. Graphviz también es utilizado por Gráfico de dependencia de FreeCAD para mostrar las relaciones entre diferentes objetos.

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.
 * Create another directory in which you will compile FreeCAD and its documentation.
 * Configure the sources with, making sure you indicate the source directory, and specify the required options for your build.
 * Trigger the creation of the documentation using.

Mientras estás dentro del directorio de construcción, da la siguiente instrucción para crear sólo la documentación.

Como se mencionó en Compilación (aceleración), la opción establece el número de núcleos de CPU utilizados para la compilación. Los archivos de documentación resultantes aparecerán en el directorio.

El punto de entrada a la documentación es el archivo, que se puede abrir con un navegador web:

El objetivo generará una cantidad significativa de datos, alrededor de 5 GB de nuevos archivos, particularmente debido a los diagramas creados por Graphviz.

Reduced documentation
Se puede generar una versión alternativa y más pequeña de la documentación, que sólo requiere unos 600 MB, con un objetivo diferente. Esta es la versión que se muestra en el sitio web de FreeCAD API.

The documentation on the FreeCAD API website is produced automatically from https://github.com/FreeCAD/SourceDoc. Anyone can rebuild it and submit a pull request:


 * Fork the repo at https://github.com/FreeCAD/SourceDoc
 * on your machine: clone the FreeCAD code (if you haven't yet), create a build dir for the doc, and clone the above SourceDoc repo inside. That SourceDoc will be updated when you rebuild the doc, and you'll be able to commit & push the results afterwards:


 * Go to your fork online, and create a pull request.

Otras versiones
FreeCAD 0.12 documentación alojada en Sourceforge.

Desarrollo de FreeCAD 0.16 documentación construida por qingfeng.xia.

Desarrollo de FreeCAD 0.19 documentación construida por qingfeng.xia.

Integrar la documentación de Coin3D
En los sistemas Unix es posible vincular la documentación de origen de Coin3D con la de FreeCAD. Esto permite una navegación más fácil y diagramas de herencia completos para las clases derivadas de Coin.


 * Instale el paquete, , o un paquete de nombre similar.
 * Descomprima el archivo ubicado en ; los archivos pueden estar ya descomprimidos en su sistema.
 * Genera de nuevo la documentación de fuente.

Si no instalas el paquete de documentación de Coin, se generarán los enlaces para acceder a la documentación en línea en BitBucket. Esto sucederá si un archivo de etiquetas de Doxygen puede ser descargado en tiempo de configuración con.

Usando Doxygen
Vea la página Doxygen para una extensa explicación sobre cómo comentar el código fuente de C++ y Python para que pueda ser procesado por Doxygen para crear automáticamente la documentación.

Esencialmente, un bloque de comentarios, comenzando con o  para C++, o  para Python, debe aparecer antes de cada definición de clase o función, para que sea recogido por Doxygen. Muchos comandos especiales, que comienzan con o, pueden ser usados para definir partes del código y dar formato a la salida. Markdown sintaxis también se entiende dentro del bloque de comentarios, lo que hace conveniente enfatizar ciertas partes de la documentación.