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 13:28:55

On 23-3-2011 18:06, Paul A. Bristow wrote:
> Correct, see
>
> http://www.stack.nl/~dimitri/doxygen/commands.html#cmdthrow
>
> also /example and /tparam
>
>   http://www.stack.nl/~dimitri/doxygen/commands.html
>
> lists them all - lots!
>
>> Also notes and remarks are standard Doxygen.
> So all this is quite easy.

Yep. The challenge is to get them all in the right way into QuickBook ;-)

> I've done it in as Doxygen comments in the C++ code - it's hard work!
> But done at the time of writing, it certainly does focus the mind.
>
> And it clutters the C++ part too, but I find that syntax coloring blots it
> out OK.
>
> (If you are using lots of MACROS and tricks, it gets messy).
>
> Paul
>
> PS Some use @ and others \ as the trip char.  I'm a \ person ;-)

I'm a \ person too ;-)

/// is also possible but that clutters multi-line Doxygen comments a bit.

Regards, Barend

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