Para todos aquellos que creen que doxygen es algo difícil o feo , cuando vean lo fácil que es y lo divertido que es generar documentación , seguro que cambiarán de opinión.

En GNU Xfree Fighter se genera dos documentaciones una en el directorio

gnu_xff/trunk/proyecto.cfg  para el funcionamiento del juego

y otra en

gnu_xff/trunk/library para el funcionamiento del motor gráfico de eventos, etc….

hay que situarse en la consola en los path indicados arriba y poner para cada uno de ellos

$> cd gnu_xff/trunk/

$>doxygen proyecto.cfg

$> cd gnu_xff/trunk/library

$>doxygen proyecto.cfg

Se  generará  una carpeta doc en donde en doc/html/index.html esta la documentación.

Empecemos con el  mini-tutorial:

1º Instalar doxygen http://www.stack.nl/~dimitri/doxygen/ ( en ubuntu sudo apt-get install doxygen )

2º Para que te aparezcan los grafos de las clases tienes que tener instalado esta aplicación:http://www.graphviz.org/   ( sudo apt-get install graphviz

Yo siempre uso un fichero con las opciones más básicas ( hay miles de opciones pa aburrirte )

—————————————- proyecto.cfg para un código php

PROJECT_NAME = OLDLASTPHP_FRAMEWORK
PROJECT_NUMER = 2.1
OUTPUT_DIRECTORY = doc
OUTPUT_LANGUAGE = Spanish
EXTRACT_ALL = YES
FILE_PATTERNS = *.php *.html
RECURSIVE = YES
PDF_HYPERLINKS = YES
USE_PDFLATEX   = YES
HAVE_DOT = YES

——————————-

Otro ejemplo de fichero de doxygen esta vez  selecciono que ficheros
documentar en vez de todos y que sean recursivos.

PROJECT_NAME = GNU XFREE FIGHTER
PROJECT_NUMER = 0.6
OUTPUT_DIRECTORY = doc
OUTPUT_LANGUAGE = Spanish
EXTRACT_ALL = YES
INPUT = clases/ia/ia.h clases/jugador/jugador.h clases/efectos/efectos.h clases/animacion/animacion.h clases/colision/colision.h clases/colision/T_colision.h clases/manager/manager.h  clases/acciones/acciones.h clases/combate/combate.h clases/tipo_juego/T_juego.h clases/input/input.h clases/menu/menu.h clases/magia/magia.h clases/special_mov/special_mov.h clases/Combate/Combate.cpp clases/luchador/luchador.h clases/escenario/escenario.h
RECURSIVE = NO
PDF_HYPERLINKS = YES
USE_PDFLATEX   = YES
HAVE_DOT = YES

————————-

Un pequeño programa:

///@brief esta clase esta guay <p> puedo meter html </p> <img src=”a.jpge”></img>
clase A{

public:
///@brief constructor
///@param x un entero
// @param y otro entero
A(int x,int y);

///@brief funcion absurda
///@return un entero
int dev_nada();

}

Espero que os  sirva de ayuda este manual si queréis generar ladocumentación del proyecto.
Un saludo a tod@s.

Resistir es Vencer.