Subject: [Boost-commit] svn:boost r53637 - trunk/more/writingdoc
From: daniel_james_at_[hidden]
Date: 2009-06-04 12:43:30
Author: danieljames
Date: 2009-06-04 12:43:30 EDT (Thu, 04 Jun 2009)
New Revision: 53637
URL: http://svn.boost.org/trac/boost/changeset/53637
Log:
Writing docs tweaks from Robert Stewart.
Text files modified:
trunk/more/writingdoc/structure.html | 21 +++++++++------------
1 files changed, 9 insertions(+), 12 deletions(-)
Modified: trunk/more/writingdoc/structure.html
==============================================================================
--- trunk/more/writingdoc/structure.html (original)
+++ trunk/more/writingdoc/structure.html 2009-06-04 12:43:30 EDT (Thu, 04 Jun 2009)
@@ -114,18 +114,15 @@
<h2><a name="standards-conforming" id="standards-conforming">Standards
Conforming</a> Documentation</h2>
- <p>The documentation structure required for the standard is an
- effective way to describe the technical specifications for a
- library. Although terse, that format is familiar to many Boost
- users and is far more precise than most ad hoc formats.
- This section (apart from the introduction) is taken from the
- C++ standard's method of description (Section 17.3). The
- following section fleshes this out with
- more detail. Note
- that Standard proposals must include full standardese wording,
- which the committee will not do for you, to be accepted. That
- level of detail is not expected of Boost library
- documentation.</p>
+ <p>The documentation structure required for the C++ Standard is
+ an effective way to describe the technical specifications for
+ a library. Although terse, that format is familiar to many
+ Boost users and is far more precise than most ad hoc formats.
+ The following description is based upon §17.3 of the
+ Standard. (Note that while final Standard proposals must
+ include full standardese wording, which the committee will
+ not do for you, that level of detail is not expected of Boost
+ library documentation.)</p>
<h3><a name="elements" id="elements">Document elements</a></h3>