Re: [Boost-docs] standard for locating appropriate header file to include from doc page?

Subject: Re: [Boost-docs] standard for locating appropriate header file to include from doc page?
From: Daniel James (dnljms_at_[hidden])
Date: 2012-05-25 19:40:19

On 25 May 2012 19:25, Jonathan Graehl <graehl_at_[hidden]> wrote:
> A documentation URL like
>
> http://www.boost.org/doc/libs/1_49_0/libs/ptr_container/doc/ptr_array.html
>
> means I should include <boost/ptr_container/ptr_array.hpp>, right? Or is
> there no such convention? The actual documentation text has always lacked
> any easily discoverable mention of the relevant header to include (and less
> frequently needed - the library name for the linker).

No, there's no such convention. Reference documentation generated
using boostbook will include the header,
http://www.boost.org/doc/html/boost/array.html is an example of that.
For other libraries the documentation is their maintainers'
responsibility.