[boost] [documentation] doxygen tags and ALIASES.

Subject: [boost] [documentation] doxygen tags and ALIASES.
From: Vicente BOTET (vicente.botet_at_[hidden])
Date: 2011-03-22 19:01:03

Hi,

I have see that Boost.Local uses some aliases to tag some part of the doxygen documentation.

ALIASES=" Params=\"Parameters: \" Param{2}=\"\\1\\2
\" EndParams=\"\" Returns=\"Returns:\" Note=\"Note:\" Warning=\"Warning:\" See=\"See:\" RefSect{1}=\"\\xmlonly
\\1\\endxmlonly\" RefSect2{2}=\"\\xmlonly
\\2\\endxmlonly\" RefClass{1}=\"\\xmlonly\\1\\endxmlonly\" RefMacro{1}=\"\\xmlonly\\1\\endxmlonly\" "

For example

/**
* @brief This macro is used to specify the local function name.
*
* This macro must follow the local function body code block { ... } as
* shown in the @RefMacro{BOOST_LOCAL_FUNCTION_PARAMS} documentation.
*
* @Params
* @Param{name,
* The name of the local function. This name cannot be the name of an operator
* operator... and it cannot be the same name of another local function
* declared within the same enclosing scope (i.e.\, it is not possible to
* overload local function declarations) -- see the
* @RefSect2{Advanced_Topics\, Advanced Topics} section.
* }
* @EndParams
*
* @See @RefMacro{BOOST_LOCAL_FUNCTION_PARAMS}, @RefSect{Tutorial} section,
* @RefSect2{Advanced_Topics, Advanced Topics} section.
*/

Other use html valises  directly.

//! Effects:
//! \code
//! for (; first != last; ++result, ++first)
//! new (static_cast(&*result))
//! typename iterator_traits::value_type(boost::move(*first));
//! \endcode
//!
//! Returns: result

Is somewhere a guideline on how to tag the doxygen documentation for Boost libraries? Is there a list of ALIASES?
If not, is there some interest in defining one?

Thanks,
Vicente