Source documentation/es: Difference between revisions

From FreeCAD Documentation
m (template fr)
(Updating to match new version of source page)
Line 1: Line 1:
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].
FreeCAD source is commented to allow automatic html documentation generation with [http://www.doxygen.org Doxygen].


For those wanting to follow closely the latest svn versions of FreeCAD, and who try to have a look at the c++ part, 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!


In complement to the Wiki, ''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.


==== Build source documentation ====
==== 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
If you have Doxygen installed, it's very easy to build the doc. Go to your FreeCAD build directory, configure your sources with CMake, issue
<syntaxhighlight>
make DevDoc
make DevDoc
</syntaxhighlight>
y consulta los archivos html resultantes empezando por Doc/SourceDocu/html/index.html
and consult the resulting html files starting from Doc/SourceDocu/html/index.html
(nota: el objetivo de DevDoc no es válido para la construcción con autotools)
(note: the DevDoc target is not valid for autotools builds)


By nature, source doc is, and will ever be, work in progress. Don't hesitate to rebuild as often as needed. If you fall upon blatant inadequacies, feel free to post on the forum (note: It is really fully checked with cMake build process only).
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 [http://free-cad.sf.net/SrcDocu/index.html aquí]
As an alternative, the doc is generated from time to time and accessible on sourceforge [http://free-cad.sf.net/SrcDocu/index.html here]


==== Documentación de Coin3D integrada ====
==== Integrate Coin3D documentation ====


En sistemas unix, es posible vincular la documentación del código fuente de Coin3D con la de FreeCAD.
On unix systems, it is possible to link Coin3D source documentation with FreeCAD's.
It allows easier navigation and complete inheritance diagrams for Coin derived classes.
Esto permite una navegación más sencilla y diagramas de herencia completos para las clases derivadas de Coin.


* En Debian y sistemas derivados:
* On Debian and derived systems:
: - Instala el paquete libcoin60-doc
: - Install the package libcoin60-doc
: - Descomprime el archivo /usr/share/doc/libcoin60-doc/html/coin.tag.gz
: - Uncompress the file /usr/share/doc/libcoin60-doc/html/coin.tag.gz
: - Regenerate source documentation
: - Regenera la documentación del código fuente
: Ya estás listo para navegar offline.
: You are up for offline browsing.


* 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).
* If you don't want to or can't install Coin doc package, the links will be generated to access coin doc online at doc.coin3D.org, if doxygen tag file can be downloaded at configure time (wget).


{{docnav/es|Extra python modules/es|List of Commands/es}}
{{docnav|Extra python modules|List of Commands}}


[[Category:Developer Documentation]]
{{languages/es | {{en|Source documentation}} {{fr|Source documentation/fr}} {{it|Source documentation/it}} {{ru|Source documentation/ru}} {{se|Source documentation/se}} }}
{{clear}}

<languages/>
[[Category:Developer Documentation/es]]

Revision as of 18:22, 22 September 2014

FreeCAD source is commented to allow automatic html documentation generation with Doxygen.

For those wanting to follow closely the latest svn versions of FreeCAD, and who try to have a look at the c++ part, 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!

In complement to the Wiki, source documentation can hopefully alleviate this feeling, providing an entry point, and allowing for easy browsing through the dozens of files and directories.

Build source documentation

If you have Doxygen installed, it's very easy to build the doc. Go to your FreeCAD build directory, configure your sources with CMake, issue

 make DevDoc

and consult the resulting html files starting from Doc/SourceDocu/html/index.html (note: the DevDoc target is not valid for autotools builds)

By nature, source doc is, and will ever be, work in progress. Don't hesitate to rebuild as often as needed. If you fall upon blatant inadequacies, feel free to post on the forum (note: It is really fully checked with cMake build process only).

As an alternative, the doc is generated from time to time and accessible on sourceforge here

Integrate Coin3D documentation

On unix systems, it is possible to link Coin3D source documentation with FreeCAD's. It allows easier navigation and complete inheritance diagrams for Coin derived classes.

  • On Debian and derived systems:
- Install the package libcoin60-doc
- Uncompress the file /usr/share/doc/libcoin60-doc/html/coin.tag.gz
- Regenerate source documentation
You are up for offline browsing.
  • If you don't want to or can't install Coin doc package, the links will be generated to access coin doc online at doc.coin3D.org, if doxygen tag file can be downloaded at configure time (wget).
Extra python modules
List of Commands