Doxygen muestra una advertencia Compound ? is not documented. al construir. Para un proyecto específico, no quiero documentar Compuestos. Para eliminar el desorden, quiero ver todas las otras advertencias excepto esa. ¿Hay alguna forma de limpiar la salida de Doxygen?¿Es posible elegir qué advertencia de Doxygen mostrar?
No creo que esto sea posible, excepto al escribir su propio post-procesador para filtrar la salida de Doxygen. En su caso, esto no debería ser demasiado difícil, un simple grep debería ser suficiente:
doxygen <config_file> | grep -v "warning: Compound .* is not documented"
No estoy realmente seguro de por qué Doxygen no proporciona esta función: tal vez requeriría demasiado opciones, o más complicado opciones. Otra posibilidad es que asuman que, dado que desea que se lo advierta cuando algo no está documentado, no debe haber excepciones excepto cuando se especifique explícitamente en el código fuente (usando \cond y \endcond, por ejemplo), con el argumento de que este tipo de omisión solo se debe decidir caso por caso. O tal vez nadie les pidió que incluyeran esta función: siéntase libre de completar un feature request.
Creo que lo que estás buscando son los comandos if, ifnot y endif. Simplemente decida una etiqueta apropiada y luego use la etiqueta correcta. Ej .:
/*
* \if DISPLAY_COMPOUND
* Compound doc.
* ...
* \endif
*/
doxygen evaluará si se sabe de esta etiqueta y si no lo hace, va a ignorar cualquier comentario hasta el comando \endif en el mismo bloque de comentario
Luego hay que defina (o no) esa etiqueta en su archivo doxy en ENABLED_SECTIONS.
#comment the next line if you don't want to document Compound
ENABLED_SECTIONS = DISPLAY_COMPOUND
Tener un vistazo a los comandos \cond y \endcond también que son similares pero no exactamente lo mismo (que activan o desactivan secciones enteras de un archivo, no sólo un único bloque de comentario).
Puede desactivar las advertencias en la configuración de doxygen. Ver aquí: doxygen documenation
Mi favorito es: WARN_IF_UNDOCUMENTED = NO
¿dónde pones esta opción? No puedo entender ... –
Mi Doxyfile dice '' ENABLED_SECTIONS = (en blanco). Tu respuesta no cubre mi problema. No quiero habilitar o deshabilitar la generación de doc compuesto. Quiero desactivar las advertencias solo para compuestos. –