boost/more
1
0
Fork 0
mirror of https://github.com/boostorg/more.git synced 2025-02-07 06:20:10 +08:00
Code Issues Packages Projects Releases Wiki Activity

Use the second paragraph of Robert's introduction as an introduction to the standard guidelines section.

Browse Source 
Reintroduce the reference to the standard and link to the 'more information' section.

[SVN r53612]
This commit is contained in:
Daniel James 2009-06-03 22:48:22 +00:00
parent 8b3b668ec4
commit 79f9bbbb9d
1 changed files with 8 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
writingdoc/structure.html
View File

@ -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=