[boost] Re: [boostbook] doxygen docs for enums

From: Angus Leeming (angus.leeming_at_[hidden])
Date: 2004-09-27 10:51:13

Doug Gregor wrote:
> It does handle enums, although admittedly not that well. See, e.g.,
> http://www.boost.org/regression-logs/cs-win32_metacomm/doc/html/
> date_time.doxy.html

So it does ;-)

>> namespace boost {
>>
>> /** @brief The boost::glob function accepts a @c glob_flags
>>  *  argument made up of a bitwise OR of zero or more of the
>>  *  following symbolic constants.
>>  */
>> enum glob_flags { ... };

> Since this only has a brief comment

Ok, thanks. Fixed that with

/** NOISE TO FORCE GENERATION OF A SEPARATE REFERENCE 
 *  PAGE FOR THIS ENUM.
 *
 *  @brief The boost::glob function accepts a @c glob_flags argument made
 *  up of a bitwise OR of zero or more of the following symbolic constants.
 */
enum glob_flags { ... };

What's peculiar here is that the NOISE isn't documented anywhere but the
brief comment now appears in the separate page:

http://www.devel.lyx.org/~leeming/globbing/enum.boost.glob_flags.html

> (and the documentation on the enum values isn't included;
> that's a known issue)

Ok, thanks. Is there a fundamental difficulty or is it just a matter of
finding some time to transform doxygen markup to boostbook?

Many thanks for your swift replies.
Angus