Source documentation/es: Difference between revisions
(Updating to match new version of source page) |
(Updating to match new version of source page) |
||
| Line 8: | Line 8: | ||
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 |
||
{{Code|code= |
|||
<syntaxhighlight> |
|||
make DevDoc |
|||
}} |
|||
</syntaxhighlight> |
|||
and consult the resulting html files starting from Doc/SourceDocu/html/index.html . |
and consult the resulting html files starting from Doc/SourceDocu/html/index.html . |
||
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). |
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). |
||
As an alternative, the doc is generated from time to time and accessible on sourceforge [http://free-cad.sf.net/SrcDocu/index.html here]. |
|||
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]. |
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]. |
||
=== Integrate Coin3D documentation === |
|||
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. |
||
Revision as of 20:35, 11 October 2016
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.
Build source documentation
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
and consult the resulting html files starting from Doc/SourceDocu/html/index.html .
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).
As an alternative, the doc is generated from time to time and accessible on sourceforge here.
Here is another FreeCAD Doxygen documentation generate by qingfeng.xia.
Integrate Coin3D documentation
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).
