On Sunday 02 February 2003 03:31 pm, David Abrahams wrote:
> Douglas Gregor <[EMAIL PROTECTED]> writes:
> > That would be great! I'm in the midst of Doxygen support, so I can't
> > throw a lot of time into Synopsis right now, but of course I'll be happy
> > to provide BoostBook and XML details, fix and extend the stylesheets,
> > etc. Have you read the (very incomplete) BoostBook documentation at:
> > http://www.cs.rpi.edu/~gregod/boost/doc/html/boostbook.html
>
> Yep. I noticed template constructs were very completely described ;-)
They're completely implemented, too. Well, unless you need nontype template
parameters or template template parameters. Anyway, templates are just:
Examples are probably the best way to learn BoostBook at this point. For
instance, here's the <template> portion of boost::function's documentation:
<template>
<template-type-parameter name="R"/>
<template-type-parameter name="T1"/>
<template-type-parameter name="T2"/>
<template-varargs/>
<template-type-parameter name="TN"/>
<template-type-parameter name="Allocator"
default="std::allocator<void>"/>
</template>
> > It's a start, at least. More often than not, you'll find that keywords
> > for entities in C++ are the same as BoostBook element names (e.g., class,
> > enum, function, typedef, template). Whenever there is an identifier
> > naming that entity (e.g., function and class names), that's the "name"
> > attribute of the entity. So for "class Foo" the element would be
> >
> > <class name="Foo">
> > // all the class members
> > </class>
>
> Why don't I throw the Synopsis DocBook formatter at some Boost code,
> and let you tell me things that should be fixed. We can go step by
> step until I've achieved BoostBook.
That might be tough. BoostBook's C++ representation is quite different from
DocBook's Java/C representation. IMHO, the best approach might be to start
with a small header that already has some BoostBook documentation (say,
boost/last_value.hpp, whose documentation is in
boost-sandbox/libs/documentation/examples/signals/reference/last_value.xml)
and try to match that output. Or if you have a favorite test class that isn't
terribly large, I can type up the BoostBook for it and post it here.
Doug
-------------------------------------------------------
This SF.NET email is sponsored by:
SourceForge Enterprise Edition + IBM + LinuxWorld = Something 2 See!
http://www.vasoftware.com
_______________________________________________
Boost-docs mailing list
[EMAIL PROTECTED]
Unsubscribe and other administrative requests:
https://lists.sourceforge.net/lists/listinfo/boost-docs
