----- Original Message -----
From: "Pavol Droba" <[EMAIL PROTECTED]>
> > That's by design, although there was a bug where a function with a
template
> > header on a separate line would have the rest of its declaration
> > highlighted, and that looks quite silly. I've fixed the bug part. I
actually
> > like the whole-definition highlighting when it fits on one line, because
it
> > gives me a lot of clickin' latitude. But since this is a stylistic
issue, we
> > can always agree to disagree and add a stylesheet parameter :)
> >
>
> 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.
> > > - 1. Parameters
> > > - 2. Return value
> > > - 3. Description
> > > - 4. ?Notes
> > > - 5. ?Examples
> >
> > This is very unlikely to happen. BoostBook is deliberately modeled afer
the
> > C++ standard's method of documentation, which is very rigid in the
ordering
> > of the semantic clauses, and I really don't think we want to break that
to
> > support Doxygen extensions like parameter lists. Actually, I'm starting
to
> > wonder if the problem is because the Doxygen description should be
mapped
> > over to <effects> instead of coming before normal semantic clauses...
> >
> This reasoning is fine for me. Question is if the behaviour should not be
> optional.
> After all, there is quite a difference between user manual and C++
Standard
> technical paper.
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).
Doug
-------------------------------------------------------
This SF.net email is sponsored by: VM Ware
With VMware you can run multiple operating systems on a single machine.
WITHOUT REBOOTING! Mix Linux / Windows / Novell virtual machines at the
same time. Free trial click here: http://www.vmware.com/wl/offer/345/0
_______________________________________________
Boost-docs mailing list
[EMAIL PROTECTED]
Unsubscribe and other administrative requests:
https://lists.sourceforge.net/lists/listinfo/boost-docs
