Re: [boost] [quick-book] suggestion about library compatibility

Subject: Re: [boost] [quick-book] suggestion about library compatibility
From: Andrew Sutton (andrew.n.sutton_at_[hidden])
Date: 2009-04-26 07:47:13

>
> which generates a nice box with an icon. I think it would be useful to
> have addition admonitions to indicate the following
>
> - the library can be serialized with Boost.Serialization
> - the library can be compiled without exceptions (BOOST_NO_EXCEPTION)
> - the library can be used with Boost.Interprocess
>
> so these can be stated in a consistent manner up front in the
> documentation. Perhaps it is better that these are written up front
> like
>
> [library Boost.AutoBuffer
>    [quickbook 1.4]
>    [copyright 2009 Thorsten Ottosen]
>    [compatibility noexceptions serialization interprocess]
>  ]
>

I don't think a single compatibility tag really gives enough information
about the degree of compatibility. Maybe it would be useful to expand a
compay tag as a kind of template with some default verbage plus optional
extra text.

[compat noexceptions] -> "This library can be compiled without exceptions".

[compat serialization To enable this feature include the
<file/serialize.hpp> header.] -> "This library can be serialized with
Boost.Serialization. To enable feature, inlcude the <file/serialize.hpp>
header.

This could alslo allow compatibilities to be applied to specific data
structures, functions,  files,  etc, which might be useful for larger
libraries like the BGL.

Andrew Sutton
andrew.n.sutton_at_[hidden]