Re: [Boost-docs] few comments

From: Pavol Droba (droba_at_[hidden])
Date: 2003-07-17 05:11:16

Hi,

On Wed, Jul 16, 2003 at 10:26:30PM -0700, Douglas Gregor wrote:

[snip]

> > It is probably the matter of taste, important is to have a uniform
> > behaviour,
> > otherwise we get a mess.
> 
> FWIW, I don't really believe that we get a mess if we add a stylesheet
> parameter, because changing a stylesheet parameter will affect the layout
> for _all_ libraries for which documentation is being generated. It's how we
> can account for personal taste: one person likes to see things one way, so
> they spin a few knobs and flip a few switches to get what they want.
>

Ok, you are right.

[snip]
 
> Much of the documentation for Boost libraries looks like the C++ standard,
> though :). The way I've viewed it is that the parameters and <description>
> environment (where Doxygen documentation ends up for functions) can give the
> "user-level" description and the semantic clauses
> (requires/effects/postconditions/etc) give the specific, standardese.
> Granted, in my own libraries I tend to write the standardese (only).

All right, maybe user-level clauses could be turned on/off using some stylesheet
paramete similary to the above case. So that we can get user friendly and
standardese documentation from one place.

Regards,

Pavol