Re: [boost] Asciidoc, an alternative for documentation

Subject: Re: [boost] Asciidoc, an alternative for documentation
From: Vinnie Falco (vinnie.falco_at_[hidden])
Date: 2017-10-07 17:30:59

On Sat, Oct 7, 2017 at 10:25 AM, John Maddock via Boost
<boost_at_[hidden]> wrote:
> ...standardese does not make good documentation

That's correct. However, it DOES make a good reference.

For example, here's a reference (generated with a tool):
<http://www.boost.org/doc/libs/develop/libs/beast/doc/html/beast/quickref.html>
<http://www.boost.org/doc/libs/develop/libs/beast/doc/html/beast/ref/boost__beast__http__async_write/overload1.html>

And here's "documentation" (i.e. the exposition written by hand)

<http://www.boost.org/doc/libs/develop/libs/beast/doc/html/beast/using_http/message_stream_operations.html>

Lets use the tools for where they do the most good rather than making
blanket statements about not using them.

Thanks