Doxygen en el cuerpo comenta

Tengo algo de código que quiero documentar con comentarios en el cuerpo de esta manera:Doxygen en el cuerpo comenta

/*! \file best.cpp 
* \brief The best 
* 
* I am the best 
*/ 

/*! \fn void theBestFunction(int) 
* I'm the best blah blah blah 
*/ 
void theBestFunction(int ever) 
{ 
    doThings(); 
    /*! 
    * Does some more things 
    */ 
    doMoreThings(); 
    /*! 
    * Checks that the things it does are the best 
    */ 
    checkBest(); 
}

Pero cuando corro doxygen en esta parece dar formato a los bloques dentro en fragmentos de código, como si se hubieran usado los comandos @code o \code (que no). Me gustaría que los comentarios en el cuerpo tengan el formato del texto normal.

¿Alguien ha encontrado esto antes? Gracias.

Fuente

2012-06-25 Andrew Lee

Estoy bastante seguro de que Doxygen no puede hacer eso. –

¿Qué quiere decir @CatPlusPlus? ¿Qué parte no puede hacer Doxygen? –

Parece que un duplicado [http://stackoverflow.com/questions/758045/how-to-be-able-to-extract-comments-from-inside-a-function-in-doxygen](http:// stackoverflow.com/questions/758045/how-to-beable-to-extract-comments-from-inside-a-function-in-doxygen) – ekholm

me las arreglé para solucionar el problema. Resulta que de alguna manera Doxygen estaba procesando esos bloques como sangrados el uno con el otro, y la sangría en Markdown (al igual que en StackOverflow) indica un bloque de código (http://en.wikipedia.org/wiki/Markdown#Code) . Simplemente apagué Markdown y solucioné el problema.

Para cualquier persona que lea esta pregunta en el futuro, si aún desea el soporte de Markdown, tenga cuidado de no iniciar bloques de comentarios en la 2da línea - comience los comentarios de inmediato.

Cambiar mi mínima ejemplo de esto:

/*! \fn void theBestFunction(int) 
* I'm the best blah blah blah 
*/ 
void theBestFunction(int ever) 
{ 
    doThings(); 
    /*! Does some more things 
    */ 
    doMoreThings(); 
    /*! Checks that the things it does are the best 
    */ 
    checkBest(); 
}

(tenga en cuenta el principio de los comentarios en el cuerpo de inmediato, en lugar de una línea en blanco en primer lugar) resuelve el problema.

Fuente

2012-06-27 14:08:51

Doxygen en el cuerpo comenta

Respuesta

Cuestiones relacionadas