Opened 14 years ago
Closed 13 years ago
#2214 closed Feature Requests (fixed)
Include header and namespace information in reference docs.
| Reported by: | Owned by: | Daniel James | |
|---|---|---|---|
| Milestone: | Boost 1.39.0 | Component: | Documentation |
| Version: | Boost 1.36.0 | Severity: | Cosmetic |
| Keywords: | header file namespace | Cc: |
Description
In the reference documentation for any library, where individual functions and/or classes are given a detailed explanation, the documentation should always specify both the full namespace of the construct and the header file which needs to be included, preferably at the very beginning of the explanation.
Change History (6)
comment:1 by , 14 years ago
comment:2 by , 14 years ago
comment:3 by , 14 years ago
(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.
........
comment:4 by , 14 years ago
| Milestone: | Boost 1.36.0 → Boost 1.39.0 |
|---|---|
| Owner: | changed from to |
| Status: | new → assigned |
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.
comment:5 by , 14 years ago
| Summary: | Documentation suggestion → Include header and namespace information in reference docs. |
|---|
comment:6 by , 13 years ago
| Resolution: | → fixed |
|---|---|
| Status: | assigned → closed |
(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.
........
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.