Re: [cpp-netlib-devel] Reference manual (Was Re: 0.8-devel progress, more async HTTP server handler goodness)

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

On Wed, Nov 3, 2010 at 7:56 PM, Glyn Matthews <gly...@gm...> wrote:
> Hi,
>
> On 3 November 2010 11:22, Dean Michael Berris <mik...@gm...>
> wrote:
>>
>> >>
>> >> 4. There's already a skeleton/outline for the documentation of the
>> >> HTTP client and HTTP server interfaces. A reference manual is sorely
>> >> lacking in the documentation, and it would be good for others to get
>> >> their hands dirty with this one. I look forward to getting pull
>> >> requests for the documentation from those who would want to contribute
>> >> in this regard. :)
>> >
>> > Reference manual and examples :) we are still example poor at the
>> > moment.
>> >
>>
>> Yeah, I agree. We really need more feedback on the documentation --
>> although people seem to be alright with looking at the examples and
>> running away with those, however poor the examples are. :D
>>
>> Although the reference manual would be great to write, I'll need help
>> with making progress in that front. :)
>
> I think we ought to make use of the Github wiki for this:
> http://github.com/cpp-netlib/cpp-netlib/wiki

Yeah, can you start with the outline that I've already provided in the RST?

I know tracing what the public interface of the client and the
messages aren't straightforward with all the layers of inheritance
that's been introduced already, but a good start would be looking at
the client facade for the supported APIs.

-- 
Dean Michael Berris
deanberris.com