Source documentation/es: Difference between revisions

Revision as of 19:26, 8 August 2018

Other languages:

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

make 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)

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:

make WebDoc

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 Doxygen 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

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/es

List of Commands/es

Indice

@@ Line 1: / Line 1: @@
+<languages/>
 The online source documentation is located at http://www.freecadweb.org/api/
+<div class="mw-translate-fuzzy">
-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.
+El código fuente de FreeCAD está comentado para permitir la generación automática de la documentación html con [http://www.doxygen.org Doxygen].
+</div>
+<div class="mw-translate-fuzzy">
-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!
+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!
+</div>
+<div class="mw-translate-fuzzy">
-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.
+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.
+</div>
+<div class="mw-translate-fuzzy">
-=== Build source documentation ===
+==== Construcción de la documentación del código fuente ====
+</div>
 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
@@ Line 14: / Line 23: @@
 make DevDoc
 }}
+<div class="mw-translate-fuzzy">
-and consult the resulting html files starting from Doc/SourceDocu/html/index.html .
+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)
+</div>
 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:
@@ Line 23: / Line 35: @@
 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).
+<div class="mw-translate-fuzzy">
-As an alternative, the doc is generated from time to time and accessible on sourceforge [http://free-cad.sf.net/SrcDocu/index.html here].
+Como una alternativa, la documentación es generada de vez en cuando y accesible en sourceforge [http://free-cad.sf.net/SrcDocu/index.html aquí]
+</div>
 Here is another FreeCAD Doxygen [http://iesensor.com/FreeCADDoc/0.16-dev/ documentation] generate by  [http://forum.freecadweb.org/viewtopic.php?t=12613 qingfeng.xia].
+<div class="mw-translate-fuzzy">
-=== Integrate Coin3D documentation ===
+==== Documentación de Coin3D integrada ====
+</div>
 En sistemas unix, es posible vincular la documentación del código fuente de Coin3D con la de FreeCAD.
@@ Line 52: / Line 68: @@
 [[Category:Developer Documentation/es]]
 {{clear}}
-<languages/>