opensubscriber
   Find in this group all groups
 
Unknown more information…

b : boost-docs@lists.sourceforge.net 21 July 2007 • 12:43AM -0400

Re: [Boost-docs] stl docs
by Paul A Bristow

REPLY TO AUTHOR
 
REPLY TO GROUP




>-----Original Message-----
>From: boost-docs-bounces@list...
>[mailto:boost-docs-bounces@list...] On Behalf Of
>Andrew Sutton
>Sent: 20 July 2007 15:39
>To: Boost documentation format, structure, and processing discussion
>Subject: Re: [Boost-docs] stl docs
>
>> Having an "Official" Boost reference document for the
>standard library
>> would be great.  Assuming it'd be in quickbook or similar, it might
>> even be turnable into a treeware version.
>>
>> It's nowhere near everything that's needed, but I can offer
>under some
>> appropriate license some articles I've been writing that
>might make an
>> acceptable starting point:
>> http://gpwiki.org/index.php/C_plus_plus:Modern_C_plus_plus
>
>This is more tutorial-style documentation - which isn't really my  
>priority at the moment.

But I'm impressed by the *style* of, say, vector *examples*:

http://gpwiki.org/index.php/C_plus_plus:Modern_C_plus_plus:Vectors

(Except that, in nit-pick mode, I can't understand why comments don't start their sentences with Capital Letter, and end with a
period?)

This is the sort of example that I believe would be most helpful, and I hope can be referenced directly from Quickbook.

Doxygen seems fine for reference, but I've not seen it produce *nice* annotated examples.  Perhaps that's my ignorance though?

Paul

---
Paul A Bristow
Prizet Farmhouse, Kendal, Cumbria UK LA8 8AB
+44 1539561830 & SMS, Mobile +44 7714 330204 & SMS
pbristow@hetp...








-------------------------------------------------------------------------
This SF.net email is sponsored by: Microsoft
Defy all challenges. Microsoft(R) Visual Studio 2005.
http://clk.atdmt.com/MRT/go/vse0120000070mrt/direct/01/
_______________________________________________
Boost-docs mailing list
Boost-docs@list...
Unsubscribe and other administrative requests: https://lists.sourceforge.net/lists/listinfo/boost-docs

Bookmark with:

Delicious   Digg   reddit   Facebook   StumbleUpon

Related Messages

opensubscriber is not affiliated with the authors of this message nor responsible for its content.