如何添加已弃用列表的说明?

时间:2013-11-25 09:27:50

标签: documentation doxygen documentation-generation

我能够将自定义页面添加到doxygen文档中,即使有描述(未经过实际记录)。不过我在这里有这个:

/*!
 * \page fielname Here comes the title
 * \brief A short introduction which explains this page.
 *
 * The real page content...
 */

这样可行,但我如何为已弃用的列表添加\brief(描述)?现在,这看起来是一个我想避免的未记录的页面。

1 个答案:

答案 0 :(得分:1)

我认为您正在寻找的内容可以通过以下方式实现:

/** Test class
 *  @deprecated Will be removed in release 2.0
 */
class Test
{
};

/** @page deprecated
 *  @brief Deprecated page brief
 *
 *  Deprecated page contents.
 */