Re: [cpp-netlib-devel] Documentation

[Dean M. B. <mik...@gm...>]

Hi Glyn!

On Tue, Aug 12, 2008 at 4:11 AM, Glyn Matthews <gly...@gm...> wrote:
> Hi,
>
>
> I created a new subversion branch for documentation.  I've added a few a
> quickbook files and an initial Jamfile (copied without shame from the boost
> threads library).
>
> There are some things that need to be done:
>
> 1. We're not an official part of boost, so I don't want to rely too much on
> this connection (I like the way asio does this).  I think it would be a good
> idea for this project to stand up under its own scrutiny before we decide to
> submit it for boost review.  Maybe if someone could come with a small logo,
> it could be good ;)

Sounds like a good idea. I'll ask around for help with regards to a Logo. :)

> 2. I've presented a pretty straightforward documentation template:
>
> - Overview
> - Motivation
> - Message
> - Protocols
> - Acknowledgements
>
> This is pretty uncontroversial and should serve us well.  Adding an examples
> section should be trivial (once we have some examples).
>

I just checked in one example of using the HTTP client. I'm going to
give another example on using the message framework. :)

> This will do us for starters, I think.  Any comments?  Or suggestions?

I like it. If we can generate the docs in HTML and put it up to the
sourceforge web space, that would be awesome. :D

Looking forward to the documentation! :)

-- 
Dean Michael C. Berris
Software Engineer, Friendster, Inc.