Search code examples
documentationdoxygendocumentation-generation

How can I add a description of the deprecated list?

I was able to add custom pages to the doxygen documentation even with a description (which is not realy documentated). However I have this here:

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

That works fine but how I add a \brief (description) for the deprecated list? Now that looks a undocumentated page what I want to avoid.

Solution

  • I think what you are looking for can be achieved with the following:

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

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