强制属性类型为doxygen

Force property type to doxygen

本文关键字:doxygen 类型 属性      更新时间:2023-10-16

例如:

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

我知道"某物"会指向苹果类型的对象。我怎么能强迫告诉doxygen(对于DOT图的关系)。

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

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

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

抛开编程设计不谈,您可以这样做:

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

然后让Doxygen预先定义CCD_ 3。(预处理手册。)


(但说真的:如果它将是Apple*,就这样写吧。)

您可以通过将指针正确声明为Apple* something来向Doxygen告知这一点。