¿Hay alguna forma de evitar que Doxygen emita advertencias "no documentadas" en archivos específicos? Mi proyecto tiene varios encabezados de código generados automáticamente que hacen que arroje cientos o miles de errores que dificultan su revisión.Suprimir las advertencias de Doxygen
Se puede usar etiquetas de supresión de los ficheros generados:
//! @cond Doxygen_Suppress
code
//! @endcond
No es necesario el "Doxygen_Suppress" de allí, pero me gustaría que para mayor claridad.
Hay más opciones en el EDITAR doxygen FAQ
: Ok, yo debería haber hecho mi debida diligencia, no tengo una respuesta que es más apropiado para su situación. Creo que debes excluir los archivos por completo. Agregue esto a su archivo doxygen:
# The EXCLUDE tag can be used to specify files and/or directories that should
# excluded from the INPUT source files. This way you can easily exclude a
# subdirectory from a directory tree whose root is specified with the INPUT tag.
EXCLUDE = abc.cpp \
abc.h
La ironía es que he tenido este problema y lo resolvió, luego se olvidó todo sobre ella ... cerebro debe estar lleno de nuevo.
Extraje esta información del doxygen Configuration page, pero si eres flojo como yo, simplemente utiliza la herramienta de interfaz gráfica de usuario (doxywizard) y selecciona todas las cosas que quieras y guarda el archivo doxy para ti.
Hay una opción de configuración para que, como se indica en documentation
WARN_IF_UNDOCUMENTEDSi
WARN_IF_UNDOCUMENTEDse establece enYES, entonces doxygen generará advertencias para los miembros indocumentados. SiEXTRACT_ALLestá configurado enYES, este indicador estará automáticamente deshabilitado.
¿Puedo darle algún tipo de alcance para que advierta mis archivos e ignore otros? –
Hmmm .. no se parece a ti. Es posible excluir archivos por completo, pero no para suprimir advertencias de forma selectiva ... :( – Mchl
Si bien este vínculo puede responder la pregunta, es mejor incluir las partes esenciales de la respuesta aquí y proporcionar el enlace de referencia. Respuestas solo de enlace puede volverse inválido si la página vinculada cambia –
En mis encabezados generados automáticamente solo agrego la documentación doxygen en la rutina de autogeneración.
Esto significa que no queda nada sin documentar.
Si alguien está usando Eclipse, definitivamente sugiero que abra su archivo (* .doxyfile) con un editor de texto (tenga en cuenta que eclipse ábralo con "Doxyfile Editor" por defecto).
Así:
etiquetas Adición
//! @cond Doxygen_Suppress
code
//! @endcond
si tiene muchas clases deben ser aburrido y duro.
La documentación para las otras opciones de configuración está disponible here.
Los archivos generados son volados y vueltos a crear cada vez que realizo algún cambio en la configuración del proyecto. La herramienta me permite insertar comentarios en los archivos generados, pero están todos en un bloque, aunque los '' abiertos parecen abiertos para trabajar. Sin embargo, los peores delincuentes (un encabezado de mapa IO que enumera * cada registro individual y el campo de bits del procesador *) No puedo hacer eso con. –
Las etiquetas abiertas parece estar interfiriendo con la documentación de mi código en una segunda mirada; '# define' notablemente, pero principalmente documentación en los encabezados. –