Generar documentación con doxygen

$doxygen DOXYFILE

doxyfile

Ver log de errores generado por esta herramienta de documentación:

$cat doxygen.log

Doxygen

• Genera automáticamente documentación de código escrito en C, C++ o Java

• Analiza los comentarios que el programador ha puesto en su código

• Basada en línea de comando

doxygen –help

PARA GENERARLO:
1. Añadimos bloques especiales de documentación
2. doxygen –g
3. doxygen –g
4. Editar fichero de configuración.
5. doxygen

PARA ACTUALIZAR:
doxygen –u nombre_fich_actualizacion
Donde el formato del fichero de actualización es:
# Comentario hasta el final.
ETIQUETA = valor [valor, ...]
ETIQUETA += valor [valor, ...]

BLOQUES DE DOCUMENTACIÓN BÁSICOS:

AL PRINCIPIO DE CADA FICHERO ( después de los includes):
#include
#include
/** \file filename.ext
* \brief Breve descripción del fichero
*
* Descripción más extensa de filename.ext.
*/

AL PRINCIPIO DE CADA CLASE:
/** \brief Breve descripción de MyClass.
*
* Descripción más extensa de MyClass.
*/
class MyClass {

ANTES DE LOS PROCEDIMIENTOS:
/** \brief Breve descripción de myProcedure().
*
* Descripción más extensa de myProcedure().
* \param aParameter Breve descripción de aParameter.
* \return Breve descripción de lo que devuelve myProcedure() .
*/
string myProcedure(string aParameter);

ANTES DE LAS VARIABLES:
** \brief Breve descripción de myVariable.
*
* Descripción más extensa de myVariable.
*/
string myVariable;


+ INFO:
http://www.stack.nl/~dimitri/doxygen/commands.html