LesOlivex

Serveis informàtics




Generar documentacion externa con doxygen

Category : Documentación de código, doxygen, Programación des 21st, 2014

Doxygen ademas de documentar el código, nos permite una manera de crear documentación extra en archivos separados del código.

En caso de documentar para php añadir simbolos de comentarios para que doxygen los recoga.

Al inicio del archivo /** y al final */

Ejemplo:

Generamos archivos readme.dox para generar un manual de la aplicación.

@page manual Manual

@section lanzadores Lanzadores al inicio

Si encontramos "$HOME/.magtrabajos/$proyecto/lanzadores" el archivo lo añadimos
al iniciar el programa. Para automatizar el lanzamiento de aplicaciones que abrimos
al trabajar en el proyecto.

Ejemplos:

@code 
# Si hay sesión de vim anterior la abrimos y la borramos 
[[ -e Session.vim ]] && ( gvim -S Session.vim ; sleep 2s ; rm -f Session.vim )

# Lanzamos firefox con pagina del proyecto en local
$mt_navegador $mt_web_local &
@endcode

- @subpage plugins "Plugins"
- @subpage complementos "Complementos"

plugins/readme.dox

@page plugins Plugins

Para extender la aplicación.

Para que un plugin este activado debe estar en la lista de @see mt_plugins_activados, dentro 
de la configuración del proyecto.

@section estructura_plugins Estructura del directorio

<pre>
magsubversion/
|-- eventos
|   |-- pre_cerrar_movimiento
|   |   `-- 20-subversion.sh
|   `-- pre_cerrar_tarea
|       `-- 10-subversion.sh
|-- extension.sh
|-- magsubversion
`-- menu.sh
</pre>

@section eventos Eventos

Al ejecutarse un evento se buscara dentro de la carpeta de cada plugin si contiene un script para ser ejecutado
se tendrá en cuenta el orden según el nombre del script

@section extensiones Extensiones 

El archivo extension.sh es una porción de código que sera incluido dentro de la aplicación principal al ser lanzada.

@section menu_plugins Menú para los plugins

El archivo menu.sh si se encuentra se mostrará en la lista de componentes para ser lanzado si se selecciona.

 


Leave a Reply

Your email address will not be published. Required fields are marked *