¿Puede Doxygen configurarse fácilmente para reconocer líneas TODO y FIXME?

Question

que acaba de instalar y configurar una instancia de Doxygen, pero fuera de la caja en la que sólo encuentra en las etiquetas TODO código cuando marcó en un bloque como:

/** 
* @todo Foo 
*/ 

No parece encontrar:

// TODO Foo 
// FIXME Bar 
// @todo Baz 

La mayoría de los IDE y rastreadores de errores que manejan el análisis están bien con ellos, ¿hay alguna manera fácil de configurar Doxygen para encontrarlos y listarlos como elementos pendientes?

Answer 1

Hay una serie de ejemplos y métodos que puede utilizar:

• Para un comentario de una sola línea con Doxygen válida comandos (por ejemplo \todo) que usaría

  /// \todo Some (optional) text 
  

  Nota los tres hacia adelante barras, no las dos habituales. Vea el punto tres en la segunda lista en la sección special documentation blocks de la documentación de Doxygen. Esto se puede usar para agregar nuevos elementos de tareas a tu código fuente.

• Generalmente se pueden definir etiquetas personalizadas (como FIXME) definiendo un alias en el archivo de configuración de Doxygen. Por ejemplo

  ALIASES += FIXME="\todo" 
  

  que permitirá escribir \FIXME en el código fuente y los comentarios con el prefijo \FIXME serán incluidos en la lista de tareas que en la documentación final. El problema aquí es que tiene que ponerle un prefijo a sus alias con el símbolo \ (o @) y comenzar el comentario con tres barras diagonales avanzadas que, si desea dejar el FIXME s en su código como están, no es una opción.

• Finalmente, un método alternativo, y lo que creo que está buscando, sería preprocesar sus archivos de origen utilizando la opción de archivo de configuración INPUT_FILTER. Esta opción define un comando que se aplica a cada uno de sus archivos fuente antes de que Doxygen construya la documentación, por lo que podemos definir un comando que reemplace las instancias de TODO y FIXME con marcado Doxygen válido.

  INPUT_FILTER = "sed -e 's/\/\/.*FIXME/\/\/\/ \\todo/'" 
  

  Este filtro reemplaza todas las instancias de // FIXME (con cualquier cantidad (o ninguno) de los espacios en blanco entre // y FIXME) con /// \todo. Esta sustitución se realiza internamente solo por Doxygen: sus archivos de origen no se modifican en el disco.

Nota: Este último punto se inspiró en la respuesta aceptada a la pregunta Getting Doxygen and MSVC TODO tags to work together. Sin embargo, esa respuesta utilizó la opción de configuración FILE_VERSION_FILTER en lugar de INPUT_FILTER. Creo que este último (INPUT_FILTER) es más apropiado aquí. Además, el comando sed utilizado en esa respuesta no funciona para mí.