diff options
| -rw-r--r-- | more/writingdoc/structure.html | 13 |
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= |