Doxygen grouping variables from inside the function -


i've been reading careful grouing , ingroup command. states "members of group can files, namespaces, classes, functions, variables, enums, typedefs, , defines, other groups."

as such, i've been trying group few variables inside function. documentation not seem state specifications or limitation kind of variable is.

here simple example:

/// \file hyperlinks.h class hyperlinks {     public:          void getenvvars();          // works!         /**          *  @ingroup group2          */         int public_var;      protected:         // works!         /**          *  @ingroup group2          */         int protected_var;      private:         int private_var; };  // works! /**  *  @ingroup group2  */ int globalvarh; 

and corresponding cpp file:

/// \file hyperlinks.cpp #include "hyperlinks.h"  /** *  @defgroup group2 second group *  second group */   hyperlinks::getenvvars() {     // here      // put group2     // ---does not work---     /**     *  @ingroup group2     *  @brief variable inside getenvvars()     */     int infunctionvariable;  }  // works! /**  *  @ingroup group2  *  @brief outside globalvar .cpp file in group 2  *  @brief outside class defenition  */ int globalvarcpp; 

from code above following placed in module->the second group:

-public_var

-protected_var

-globalvarh

-globalvarcpp

yet, variable inside function not appear in group:

-infunctionvariable

the 5th variable no showing up.

any ideas why not working? how fix or work-around?

also, i've read thru message/warning generated during run of doxygen documentation. there errors or warning regards file.

any appreciated.

thank you!

ps. doxygen version 1.8.3.1

doxygen doesn't support commenting elements within body of function. documenting code in doxygen manual:

for each entity in code there 2 (or in cases three) types of descriptions, form documentation entity; brief description , detailed description, both optional. methods , functions there third type of description, called in body description, consists of concatenation of comment blocks found within body of method or function.

in code example, documentation on infunctionvariable in-body documentation hyperlinks::getenvvars() function, , appears part of documentation item.


Comments

Popular posts from this blog

Why does Ruby on Rails generate add a blank line to the end of a file? -

keyboard - Smiles and long press feature in Android -

node.js - Bad Request - node js ajax post -