Doxygen链接指向班级

时间:2015-05-06 14:22:54

标签: c++ doxygen

我现在正在使用Doxygen为C ++类生成文档:

/** brief introduction to the class
*
*  detailed explanations are here.
*
/
class MyClass
{
  public:
    MyClass()
   ...
 }

当我在主页部分写一些内容时,我想指出该课程的详细解释部分:

/*! \mainpage a library
*
*
*   link to the detailed explanation part of the class: MyClass
*/

但是,该链接将引导我进入类参考部分,但不是详细解释部分。我必须在课程的简要说明部分点击更多... ,以获得详细部分,如下图所示: enter image description here 关于如何获得课程详细解释部分链接的任何想法?感谢。

1 个答案:

答案 0 :(得分:0)

我偶然发现了一个解决方案。我所做的是首先定义一个模块名称,如果这个类

/**
* @addtogroup mymodule
*/

之后,

/** brief introduction to the class
*
*  detailed explanations are here.
*
*  @ingroup mymodule
/
class MyClass
{
  public:
    MyClass()
   ...
 }

然后一切都会好的。