summaryrefslogtreecommitdiff
path: root/more/writingdoc
diff options
context:
space:
mode:
authorDaniel James <daniel@calamity.org.uk>2009-06-03 22:48:22 +0000
committerDaniel James <daniel@calamity.org.uk>2009-06-03 22:48:22 +0000
commit8d6972a9057fbbef29a663d8201a6fe231b829b6 (patch)
tree2161d9ad9c7afa86df418b30eef8440ac5102782 /more/writingdoc
parent3f74db5e1eab226a6e57356bb407129eff5b4e6a (diff)
downloadboost-8d6972a9057fbbef29a663d8201a6fe231b829b6.tar.gz
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. [SVN r53612]
Diffstat (limited to 'more/writingdoc')
-rw-r--r--more/writingdoc/structure.html13
1 files changed, 8 insertions, 5 deletions
diff --git a/more/writingdoc/structure.html b/more/writingdoc/structure.html
index af38aa80b9..d4b747a191 100644
--- a/more/writingdoc/structure.html
+++ b/more/writingdoc/structure.html
@@ -111,19 +111,22 @@
suggest the following guidelines for Boost library
documentation.</p>
+ <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. Below
- is a description of the Standard documentation structure. Note
+ 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
+ <a href="#more">following section</a> 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>
- <h2><a name="standards-conforming" id="standards-conforming">Standards
- Conforming</a> Documentation</h2>
-
<h3><a name="elements" id="elements">Document elements</a></h3>
<p>Each document contains the following elements, as applicable<a class=