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

Subject: Re: [boost] [documentation] doxygen tags and ALIASES.
From: Steven Watanabe (watanabesj_at_[hidden])
Date: 2011-03-23 14:48:00

AMDG

On 03/23/2011 10:44 AM, Barend Gehrels wrote:
>> I was not only thinking on template parameters requirements but also 
>> to run-time requirements (i.e. pre-conditions). the predefined @pre 
>> should work if we reach to get a coherent lock.
>
> Again, of course it looks coherent within Doxygen but the problem is: 
> what to do with that afterwards.

You should be able to handle it in the XML
output.  I know that doxygen2boostbook
handles \pre correctly.

> Complete programs are the best basic examples. See our example e.g. here:
>
> http://bit.ly/en9JsR
>
> First I used snippets but Mateusz convinced me that it should really 
> be complete examples including headerfiles. And I agree completely now.
>
> This is the same way cplusplus does it , e.g.
>
> <http://www.cplusplus.com/reference/algorithm/sort/>
>
> which is really useful.

I usually use quickbook's snippet extraction,
and include a link to the actual source.

In Christ,
Steven Watanabe