Boost C++ Libraries: Ticket #2214: Include header and namespace information in reference docs.

Frank Mori Hess — Mon, 18 Aug 2008 14:19:52 GMT

For libs using boostbook/quickbook, boostbook should probably be modified to add a "#include <headerfilename.hpp>" line somewhere in the reference pages it generates for classes, etc.. It already puts the enclosing namespaces in by giving the fully qualified class name at the top of the reference page. The docs for Boost.signals is an example of boostbook generated documentation.

Daniel James — Sun, 09 Nov 2008 21:57:40 GMT

(In [49669]) Add link to the header to the synopsis in reference documentation. Refs #2214

Daniel James — Thu, 20 Nov 2008 22:53:23 GMT

(In [49855]) Merged revisions 49661-49662,49666,49669,49735,49756,49770,49811 via svnmerge from https://svn.boost.org/svn/boost/trunk

........

r49661 | danieljames | 2008-11-09 12:03:45 +0000 (Sun, 09 Nov 2008) | 1 line

Move hash detail headers out of boost/functional/detail.

........

r49662 | danieljames | 2008-11-09 12:11:50 +0000 (Sun, 09 Nov 2008) | 1 line

Add a forwarding header for container_fwd.hpp

........

r49666 | danieljames | 2008-11-09 19:12:05 +0000 (Sun, 09 Nov 2008) | 1 line

Avoid comparing default initialised iterators in position_iterator.

........

r49669 | danieljames | 2008-11-09 21:57:38 +0000 (Sun, 09 Nov 2008) | 2 lines

Add link to the header to the synopsis in reference documentation. Refs #2214

........

r49735 | danieljames | 2008-11-14 12:51:00 +0000 (Fri, 14 Nov 2008) | 1 line

Explicitly specify the template parameters in the unordered container friend, in order to avoid some warnings.

........

r49756 | danieljames | 2008-11-14 16:11:16 +0000 (Fri, 14 Nov 2008) | 1 line

Use pragmas to suppress a Visual C++ warning.

........

r49770 | danieljames | 2008-11-15 13:07:29 +0000 (Sat, 15 Nov 2008) | 1 line

Use the new swap library.

........

r49811 | danieljames | 2008-11-16 23:10:00 +0000 (Sun, 16 Nov 2008) | 1 line

Fix a typo.

........

owner, status, milestone changed

Daniel James — Sat, 21 Feb 2009 17:13:39 GMT

owner changed from Matias Capeletto to Daniel James
status new → assigned
milestone Boost 1.36.0 → Boost 1.39.0

Boostbook now includes this information for the reference documentation. I'll change to documentation guidelines to suggest this, but I'm not going to update all the documentation.

summary changed

Daniel James — Sat, 28 Feb 2009 14:59:12 GMT

summary Documentation suggestion → Include header and namespace information in reference docs.

status changed; resolution set

Daniel James — Sat, 06 Jun 2009 13:17:09 GMT

status assigned → closed
resolution → fixed

(In [53683]) Extra guidelines for web documentation, and some editorial changes. Fixes #2214

Merged revisions 53551,53611-53613,53637 via svnmerge from https://svn.boost.org/svn/boost/trunk

........

r53551 | danieljames | 2009-06-01 20:18:00 +0100 (Mon, 01 Jun 2009) | 1 line

Extra guidelines for writing documentation for the web.

........

r53611 | danieljames | 2009-06-03 23:48:11 +0100 (Wed, 03 Jun 2009) | 1 line

New introduction and web reference guidelines, by Robert Stewart.

........

r53612 | danieljames | 2009-06-03 23:48:22 +0100 (Wed, 03 Jun 2009) | 2 lines

Use the second paragraph of Robert's introduction as an introduction to the standard guidelines section. Reintroduce the reference to the standard and link to the 'more information' section.

........

r53613 | danieljames | 2009-06-03 23:48:35 +0100 (Wed, 03 Jun 2009) | 1 line

Link footnotes back to their location in the document.

........

r53637 | danieljames | 2009-06-04 17:43:30 +0100 (Thu, 04 Jun 2009) | 1 line

Writing docs tweaks from Robert Stewart.

........