如何在Doxygen中引用组

时间:2017-03-15 16:12:08

标签: doxygen

我知道我们可以使用\defgroup关键字在doxygen中定义一个组,并使用关键字\addtogroup在该组中添加该类。我的问题是如何在文档中引用该组。例如,

/**
* \defgroup abc abc
*/

  /**
  * \addtogroup auxiliary_functions
  * @{
  */

 /**
 * Introduction to A. 
 */
 class A
  {

 };
/*
  * @}
*/

然后,在页面部分中,如何引用abc组?

/** @page tttt
*   how to refer to group abc?
*
*/

2 个答案:

答案 0 :(得分:2)

您可以使用其标签引用任何组。在您的情况下,要引用页面abc中的ttt组,请使用以下

/** @page tttt
 *   
 * For more information, please see @ref abc
 */

结果页面将包含指向您的论坛的链接,其中的文字将反映论坛的标题( abc )。

答案 1 :(得分:1)

据我所知,使用关键字 ingroup

/**
 * \ingroup abc
 * \brief   Explain why
 */
extern int VarInA;

您可以在此处找到更多信息:Grouping doc