doxygen-addtogroup | 易学教程

Documenting namespaces with Doxygen

阅读更多关于 Documenting namespaces with Doxygen

问题 I'm having issues with Doxygen recognizing namespaces and modules. I believe the issue surrounds whether to place the \addtogroup within the namespace or outside the namespace. Example 1, outside the namespace: /*! * \addtogroup Records * @{ */ //! Generic record interfaces and implementations namespace Records { //! Describes the record interface class Interface; } // End namespace Records /*! @} End of Doxygen Groups*/ Example 2 - within namespace //! Generic record interfaces and

C and doxygen - removing duplicates of variable documentation

阅读更多关于 C and doxygen - removing duplicates of variable documentation

问题 I'm documenting my C code with doxygen. For better readability I group documentation of every .c/.h file pair (sometimes also more files) with defgroup and addtogroup (see doxygen in c: grouping of defines). The file pages look fine, but on the group/module pages all variable documentation is doubled. There are 2 entries for every variable that's declared (with extern) in the header file and defined in the .c file (in the summary as well as in the description part). Functions and everything

Documenting namespaces with Doxygen

阅读更多关于 Documenting namespaces with Doxygen

I'm having issues with Doxygen recognizing namespaces and modules. I believe the issue surrounds whether to place the \addtogroup within the namespace or outside the namespace. Example 1, outside the namespace: /*! * \addtogroup Records * @{ */ //! Generic record interfaces and implementations namespace Records { //! Describes the record interface class Interface; } // End namespace Records /*! @} End of Doxygen Groups*/ Example 2 - within namespace //! Generic record interfaces and implementations namespace Records { /*! * \addtogroup Records * @{ */ //! Describes the record interface class