Re: standard for locating appropriate header file to include from doc page?
Daniel James <[email protected]>
| Newsgroups | gmane.comp.lib.boost.documentation |
|---|---|
| Message-ID | <CAHOE3yeDWt78yq8W6=+Ue-c13GHxJj4q3hUO8w1nG-G1=vBmLw@mail.gmail.com> |
On 25 May 2012 19:25, Jonathan Graehl <[email protected]> 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.