Source documentation/es: Difference between revisions

Revision as of 10:17, 13 July 2019

Other languages:

Extra python modules

List of Commands

Index

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)

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

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

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

User documentation

Getting started
Installation: Download, Windows, Linux, Mac, Additional components, Docker, AppImage, Ubuntu Snap
Basics: About FreeCAD, Interface, Mouse navigation, Selection methods, Object name, Preferences, Workbenches, Document structure, Properties, Help FreeCAD, Donate

Help: Tutorials, Video tutorials
Workbenches: Std Base, Arch, Assembly, CAM, Draft, FEM, Inspection, Mesh, OpenSCAD, Part, PartDesign, Points, Reverse Engineering, Robot, Sketcher, Spreadsheet, Start, Surface, TechDraw, Test Framework, Web

Addons: Addon Manager, External workbenches, Scripting and macros

Hubs: User hub, Power users hub, Developer hub

@@ Line 1: / Line 1: @@
 <languages/>
 {{docnav|Extra python modules|List of Commands}}
-The online source documentation is located at http://www.freecadweb.org/api/
 <div class="mw-translate-fuzzy">
@@ Line 8: / Line 6: @@
 </div>
+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].
-<div class="mw-translate-fuzzy">
-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">
+==== Construcción de la documentación del código fuente ====
-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">
-==== 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
 </div>
+{{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.
-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
+* 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
-make DevDoc
+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.
+{{Code|code=
+make -j$(nproc --ignore=2) DevDoc
 }}
 <div class="mw-translate-fuzzy">
@@ Line 29: / Line 40: @@
 </div>
+The point of entrance to the documentation is the {{incode|index.html}} file, which you can open with your web browser:
-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:
 {{Code|code=
+xdg-open freecad-build/doc/SourceDocu/html/index.html
-make WebDoc
 }}
+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.
-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).
+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=
+make -j$(nproc --ignore=2) WebDoc
+}}
 <div class="mw-translate-fuzzy">
@@ Line 40: / Line 56: @@
 </div>
-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.16-dev/ FreeCAD 0.16 development] documentation built 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].
 <div class="mw-translate-fuzzy">
@@ Line 46: / Line 64: @@
 </div>
+<div class="mw-translate-fuzzy">
 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.
+</div>
+<div class="mw-translate-fuzzy">
 * En Debian y sistemas derivados:
 : - Instala el paquete libcoin60-doc
@@ Line 54: / Line 75: @@
 : - Regenera la documentación del código fuente
 : Ya estás listo para navegar offline.
+</div>
+<div class="mw-translate-fuzzy">
 * 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).
+</div>
 == How to integrate doxygen in to the FreeCAD source code ==