Re: [boost] [documentation] doxygen tags and ALIASES.

Subject: Re: [boost] [documentation] doxygen tags and ALIASES.
From: Barend Gehrels (barend_at_[hidden])
Date: 2011-03-23 03:30:54

On 23-3-2011 0:01, Vicente BOTET wrote:
> I have see that Boost.Local uses some aliases to tag some part of the doxygen documentation.
> (...)
> 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?

Boost.Geometry defines a lot (currently 79) of aliases too. However most 
of them are specific to Boost.Geometry, and I don't see much profit from 
harmonizing them across libraries (besides the \qbk alias).

The aliases are used as defining a sort of Domain Specific Documentation 
Language, to avoid repetitions of the same phrases over and over in the 
Doxygen sections.

Regards, Barend

-- 
Barend Gehrels
http://about.me/barendgehrels