Doxygen/comentarios del archivo fuente

Is any way to not generates warrnings from undocumented function/method that is located in source file ( .c ) . I have all comments in header file and do not want to duplicate it. I do not want to switch off documenting source code but only comments for method in this file.

Gracias de antemano por cualquier sugerencia.

preguntado el 12 de junio de 14 a las 10:06

1 Respuestas

I can think of two approaches you could take, both by changing config options in your Doxyfile:

  1. Si configura WARN_IF_UNDOCUMENTED to False (it defaults to True), doxygen won't complain about any function or method which is undocumented. (You might not want to do that though, as the warnings can be a helpful way to check you've documented all your methods and functions.)
  2. Set your config to include or exclude files based on their suffix. For example: if the methods and functions which are causing problems all have a .c suffix, you can set EXCLUDE_PATTERNS a *.c to ignore all .c files.

The doxygen documentación de configuración is pretty comprehensive, and you may find another approach in there which suits better.

Respondido el 23 de diciembre de 18 a las 10:12

I was considering this solution but . in c file I have comments about authors,group ( module ) etc. - Radek

So maybe WARN_IF_UNDOCUMENTED = False would be the way to go? You could also look at suppressing warnings wholesale using WARNINGS = NO, though it is something of a large hammer... - morric

No es la respuesta que estás buscando? Examinar otras preguntas etiquetadas or haz tu propia pregunta.