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

Writing docs tweaks from Robert Stewart.

Browse Source 
[SVN r53637]
This commit is contained in:
Daniel James 2009-06-04 16:43:30 +00:00
parent a7458a5c7d
commit e2f996366a
1 changed files with 9 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
writingdoc/structure.html
View File

@ -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
<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>
<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 &sect;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>