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

From: Doug Gregor (dgregor_at_[hidden])
Date: 2004-09-27 14:35:22

On Sep 27, 2004, at 10:51 AM, Angus Leeming wrote:
> 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

Weird. Probably something trivial in the XSL.

>> (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?

Just a matter of finding some time and figuring out how Doxygen dumps 
the markup. Nearly everything with BoostBook is easy, it just takes a 
little free time.

        Doug