强制属性类型为doxygen

时间:2012-08-28 16:16:31

标签: c++ doxygen

例如:

class Test
{
    /// This var contain Apple class
    void* something;
};

我知道“某事”将指向Apple类型的对象。我如何强制告诉doxygen(对于DOT图表关系)。

3 个答案:

答案 0 :(得分:2)

除了编程设计,你可以这样做:

class Test
{
    #ifdef DOXYGEN_RUNNING
        Apple* something;
    #else
        void* something;
    #endif
};

然后让Doxygen预定义DOXYGEN_RUNNING。 (Manual for preprocessing。)


(但是说真的:如果它会成为Apple*那么就这样写。)

答案 1 :(得分:2)

它可能有点沉重,但有一种方法是在使用doxygen处理它时有条件地将其声明为Apple*

class Test
{
    /// This var contain Apple class
#ifdef DOXYGEN_INVOKED
    Apple* something;
#else
    void* something;
#endif
};

您可以使用PREDEFINED标记配置Doxygen以定义DOXYGEN_INVOKED宏。

答案 2 :(得分:1)

通过将指针正确地声明为Apple* something来告诉Doxygen。