Documentando funciones en C++ con Doxygen

Question

Tengo un proyecto que estoy usando Doxygen para generar documentación. La documentación de las clases está bien, pero también tengo algunas funciones que uso en main() para crear objetos, etc. También me gustaría tenerlas en mi documentación, pero no he pensado cómo hacerlo. ¿Alguna sugerencia?

Answer 1

Uso \fn donde de lo contrario utiliza \class en su \\*!*\ bloque

http://www.doxygen.nl/docblocks.html
aspecto de "Documentación en otros lugares"

http://www.doxygen.nl/commands.html#cmdfn
Funciona de manera similar como la documentación de las funciones miembro

Answer 2

Este patrón funcionó bien para nosotros.

/*! Convert counts to kg for the reservoir. 
    \param counts The A/D counts to convert.` 
    \return The calculated kg based on the parameter. 
*/ 
float RES_ConvertCountsToValue(uint_16 counts); 

Answer 3

Me gusta este patrón

/////////////////////////////////////////////////////////////////////// 
    /// \brief setX 
    /// \param x offset of the image. 
    /// \return a new image as an QImage. 
    ///////////////////////////////////////////////////////////////////////// 
    QImage setX(int x); 

Answer 4

entidades que son miembros de clases solamente se documentan si se documenta su clase. Las entidades declaradas en el ámbito del espacio de nombres solo se documentan si su espacio de nombre está documentado. Las entidades declaradas en el alcance del archivo solo se documentan si su archivo está documentado.

Así que para documentar una función libre en el espacio de nombres global también necesita una línea como esta en algún lugar en el archivo de cabecera en la que se declara:

/** @file */ 

O así:

/*! \file */