Question

我一直在仔细阅读关于抱石和内圈指挥的内容。它声明“组的成员可以是文件，名称空间，类，函数，变量，枚举，typedef和定义，还有其他组。”

因此，我一直在尝试从函数内部对少数变量进行分组。该文档似乎没有说明它是什么类型的变量的任何规范或限制。

这是一个简单的例子：

/// \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;

和相应的cpp文件：

/// \file hyperLinks.cpp
#include "hyperLinks.h"

/**
*  @defgroup group2 The Second Group
*  This is the second group
*/


hyperLinks::getEnvVars()
{
    // do something here

    // put this into a group2
    // ---DOES NOT WORK---
    /**
    *  @ingroup group2
    *  @brief variable inside getEnvVars()
    */
    int inFunctionVariable;

}

// works!
/**
 *  @ingroup group2
 *  @brief OUTSIDE globalVar from .cpp file in group 2
 *  @brief outside class defenition
 */
int globalVarCPP;

从上面的代码中，下面的DO放在Module-＆gt; The Second Group：

中

-public_var

-protected_var

-globalVarH

-globalVarCPP

然而，函数内部的变量不会出现在组中：

-inFunctionVariable

第五个变量没有显示出来。

为什么这不起作用的任何想法？如何解决它或解决方法？

另外，我已经阅读了doxygen文档运行期间生成的所有消息/警告。有关此文件的错误或警告。

非常感谢任何帮助。

谢谢！

PS。 Doxygen版本1.8.3.1

Answer 1

Doxygen不支持在函数体内注释元素。来自doxygen手册中的Documenting the code：

对于代码中的每个实体，有两种（或在某些情况下为三种）描述类型，它们在一起形成该实体的文件;简要说明和详细说明，两者都是可选的。对于方法和功能还有第三种描述，即所谓的身体描述，其中包含在方法或函数体内找到的所有注释块的串联。

在您的代码示例中，inFunctionVariable上的文档是hyperLinks::getEnvVars()函数的正文文档，并显示为该项目文档的一部分。

来自函数内部的Doxygen分组变量

1 个答案: