Doxygen demands that an include-guard be documented

后端 未结 1 1541
慢半拍i
慢半拍i 2021-01-18 07:16

Please do not mind the strangeness of the following minimal example (I would have to make it much larger to justify why I am doing things this way):

File test.cpp:

相关标签:
1条回答
  • 2021-01-18 07:36

    You may use conditional documentation to suppress Doxygen warnings like this:

    //b.h
    /// \file
    
    //! @cond SuppressGuard
    #ifndef GUARD
    #define GUARD
    //! @endcond
    
    struct A {};
    //! @cond SuppressCmd
    #define CMD 5 // without this, all is well!
    //! @endcond
    
    //! @cond SuppressGuard
    #endif
    //! @endcond
    

    Note that I wrapped #endif with conds, because otherwise you'll get if-endif mismatch warning:

    /home/user/doxygen/b.h:13: warning: More #endif's than #if's found.
    
    0 讨论(0)
提交回复
热议问题