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: Jonathan Graehl (graehl_at_[hidden])
Date: 2012-05-25 20:46:02

On 5/25/12 12:40 PM, Daniel James wrote:
> 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.
> _______________________________________________
> Boost-docs mailing list
> Boost-docs_at_[hidden]
> http://lists.boost.org/mailman/listinfo.cgi/boost-docs
Thanks. It turns out that in practice it's pretty easy to find boost 
headers using one of the emacs find-file helpers (or 'ack') and a boost 
headers dir, but this is something that's always puzzled me over the years.