如何引用 Doxygen 中的组
How to refer to group in Doxygen
我了解到可以在doxygen中使用\defgroup
关键字定义一个组,然后使用关键字\addtogroup
将class添加到该组中。我的问题是如何在文档中引用该组。例如,
/**
* \defgroup abc abc
*/
/**
* \addtogroup auxiliary_functions
* @{
*/
/**
* Introduction to A.
*/
class A
{
};
/*
* @}
*/
那么,在一个page section中,如何引用abc组呢?
/** @page tttt
* how to refer to group abc?
*
*/
据我所知,使用关键字 ingroup
/**
* \ingroup abc
* \brief Explain why
*/
extern int VarInA;
您可以在这里找到更多信息:Grouping doc
您可以使用其标签来引用任何组。在您的情况下,要引用 ttt
页中的 abc
组,请使用以下内容
/** @page tttt
*
* For more information, please see @ref abc
*/
生成的页面将包含您的群组的 link,其文本将反映群组的标题(abc)。
我了解到可以在doxygen中使用\defgroup
关键字定义一个组,然后使用关键字\addtogroup
将class添加到该组中。我的问题是如何在文档中引用该组。例如,
/**
* \defgroup abc abc
*/
/**
* \addtogroup auxiliary_functions
* @{
*/
/**
* Introduction to A.
*/
class A
{
};
/*
* @}
*/
那么,在一个page section中,如何引用abc组呢?
/** @page tttt
* how to refer to group abc?
*
*/
据我所知,使用关键字 ingroup
/**
* \ingroup abc
* \brief Explain why
*/
extern int VarInA;
您可以在这里找到更多信息:Grouping doc
您可以使用其标签来引用任何组。在您的情况下,要引用 ttt
页中的 abc
组,请使用以下内容
/** @page tttt
*
* For more information, please see @ref abc
*/
生成的页面将包含您的群组的 link,其文本将反映群组的标题(abc)。