Is it possible to choose which Doxygen warning to show?

后端 未结 3 763
闹比i
闹比i 2021-01-11 17:52

Doxygen shows a Compound ? is not documented. warning when building. For a specific project I don\'t want to document Compounds. To remove clutter I want to see

3条回答
  •  北海茫月
    2021-01-11 18:27

    I think what you're looking for is the if, ifnot and endif commands. Just decide an appropriate label then use the correct tag. Ex.:

    /*
    * \if DISPLAY_COMPOUND
    * Compound doc.
    * ...
    * \endif
    */
    

    doxygen will evaluate if it knows of this label and if it doesn't, he'll ignore any comment up to the \endif command in the same comment block

    Then you need to define (or not) that label in your doxyfile in the ENABLED_SECTIONS.

    #comment the next line if you don't want to document Compound
    ENABLED_SECTIONS = DISPLAY_COMPOUND
    

    Have a look at the \cond and \endcond commands too which are similar but not quite the same (they enable or disable entire sections of a file, not just a single comment block).

提交回复
热议问题