Source documentation/es: Difference between revisions

From FreeCAD Documentation
(Updating to match new version of source page)
(Updating to match new version of source page)
(8 intermediate revisions by the same user not shown)
Line 1: Line 1:
<languages/>
<languages/>
{{Docnav

|[[Extra python modules|Extra python modules]]
The online source documentation is located at http://www.freecadweb.org/api/
|[[List of Commands|List of Commands]]

}}
{{TOCright}}
<div class="mw-translate-fuzzy">
<div class="mw-translate-fuzzy">
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].
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>


The documentation is hosted online at the [http://www.freecadweb.org/api/ FreeCAD API website]. Please note that this documentation may not always be up to date; if you need more details, download FreeCAD's latest source code and compile the documentation yourself. 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>


Compiling the API documentation follows the same general steps as compiling the FreeCAD executable, as indicated in the [[Compile_on_Linux/Unix|compile on Unix]] page.
<div class="mw-translate-fuzzy">

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.
[[File:FreeCAD_documentation_compilation_workflow.svg|800px]]
</div>

{{Caption|General workflow to compile FreeCAD's programming documentation. The Doxygen and Graphviz packages must be in the system, as well as the FreeCAD source code itself. CMake configures the system so that with a single make instruction the documentation for the the entire project is compiled into many HTML files with diagrams.}}


<div class="mw-translate-fuzzy">
<div class="mw-translate-fuzzy">
Line 19: Line 21:
</div>
</div>


<div class="mw-translate-fuzzy">
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
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 [[Compile_on_Linux/Unix|compile on Unix]] page, and summarized here for convenience.
* 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
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=
{{Code|code=
make DevDoc
make -j$(nproc --ignore=2) DevDoc
}}
}}
<div class="mw-translate-fuzzy">
<div class="mw-translate-fuzzy">
Line 27: Line 48:
(nota: el objetivo de DevDoc no es válido para la construcción con autotools)
(nota: el objetivo de DevDoc no es válido para la construcción con autotools)
</div>
</div>
{{Code|code=
freecad-build/doc/SourceDocu/html/
}}


The point of entrance to the documentation is the {{incode|index.html}} file, which you can open with a 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=
{{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 600 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">
<div class="mw-translate-fuzzy">
Line 39: Line 68:
</div>
</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].
[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">
<div class="mw-translate-fuzzy">
Line 45: Line 76:
</div>
</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.
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.
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:
* En Debian y sistemas derivados:
: - Instala el paquete libcoin60-doc
: - Instala el paquete libcoin60-doc
Line 53: Line 87:
: - Regenera la documentación del código fuente
: - Regenera la documentación del código fuente
: Ya estás listo para navegar offline.
: 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).
* 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>


== Using Doxygen ==
== How to integrate doxygen in to the FreeCAD source code ==
{{VeryImportantMessage|This is a Work In Progress. See [[Doxygen]]}}
Example of a complete doxygen page: (from another project)


See the [[Doxygen|Doxygen]] page for an extensive explanation on how to comment C++ and Python source code so that it can be processed by Doxygen to automatically create the documentation.
doxygen: http://www.vtk.org/doc/nightly/html/classvtkArrayCoordinates.html


Essentially, a comment block, starting with {{incode|/**}} or {{incode|///}} for C++, or {{incode|##}} for Python, needs to appear before every class or function definition, so that it is picked up by Doxygen. Many [[Doxygen#Doxygen markup|special commands]], which start with {{incode|\}} or {{incode|@}}, can be used to define parts of the code and format the output. [[Doxygen#Markdown support|Markdown syntax]] is also understood within the comment block, which makes it convenient to emphasize certain parts of the documentation.
source: https://github.com/Kitware/VTK/blob/master/Common/Core/vtkArrayCoordinates.h
{{Code|code=
/**
* Returns the name of the workbench object.
*/
std::string name() const;


/**
* Set the name to the workbench object.
*/
void setName(const std::string&);

/// remove the added TaskWatcher
void removeTaskWatcher(void);
}}

<div class="mw-translate-fuzzy">
{{docnav/es|Extra python modules/es|List of Commands/es}}
{{docnav/es|Extra python modules/es|List of Commands/es}}
</div>

{{Userdocnavi}}


[[Category:Developer Documentation/es]]
[[Category:Developer Documentation/es]]

Revision as of 21:43, 10 February 2020

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

The documentation is hosted online at the FreeCAD API website. Please note that this documentation may not always be up to date; if you need more details, download FreeCAD's latest source code and compile the documentation yourself. If you have pressing questions about the code please ask in the developer section of the FreeCAD forum.

Compiling the API documentation follows the same general steps as compiling the FreeCAD executable, as indicated in the compile on Unix page.

General workflow to compile FreeCAD's programming documentation. The Doxygen and Graphviz packages must be in the system, as well as the FreeCAD source code itself. CMake configures the system so that with a single make instruction the documentation for the the entire project is compiled into many HTML files with diagrams.

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

Using Doxygen

See the Doxygen page for an extensive explanation on how to comment C++ and Python source code so that it can be processed by Doxygen to automatically create the documentation.

Essentially, a comment block, starting with /** or /// for C++, or ## for Python, needs to appear before every class or function definition, so that it is picked up by Doxygen. Many special commands, which start with \ or @, can be used to define parts of the code and format the output. Markdown syntax is also understood within the comment block, which makes it convenient to emphasize certain parts of the documentation.

/**
 * Returns the name of the workbench object.
 */
std::string name() const;

/**
 * Set the name to the workbench object.
 */
void setName(const std::string&);

/// remove the added TaskWatcher
void removeTaskWatcher(void);
Extra python modules/es
List of Commands/es