boost/more
1
0
Fork 0
mirror of https://github.com/boostorg/more.git synced 2024-12-25 23:20:12 +08:00
Code Issues Packages Projects Releases Wiki Activity

Added links to the writing documentation pages.

Browse Source 
[SVN r13199]
This commit is contained in:
William E. Kempf 2002-03-14 23:30:00 +00:00
parent 933a719686
commit c6d34f706b
2 changed files with 10 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
index.htm
View File

@ -38,6 +38,10 @@ content="text/html; charset=iso-8859-1">
<p><a href="lib_guide.htm"><b>Library Requirements and
Guidelines</b></a>.&nbsp; Basic standards for those preparing
a submission.</p>
<p><a href="writingdoc\index.html"><strong>Writing
Documentation for Boost</strong></a> Basic guidelines
for writing documentation and templates for quickly generating
documentation that follows the guidelines.</p>
<p><a href="test_policy.htm"><b>Test Policy and Protocols</b></a>.&nbsp;
How testing works at Boost.</p>
<p><a href="submission_process.htm"><b>Library Submission

10
lib_guide.htm
View File

@ -263,18 +263,20 @@ C++ programmer to use the library successfully?</p>
<li>General introduction to the library.</li>
<li>Description of each class.</li>
<li>Relationship between classes.</li>
<li>For each function, as applicable, description, requirements
(preconditions), effects, post-conditions, returns, and throws.</li>
<li>For each function, as applicable, description, requirements (preconditions),
effects, post-conditions, returns, and throws.</li>
<li>Discussion of error detection and recovery strategy.</li>
<li>How to use including description of typical uses.</li>
<li>How to compile and link.</li>
<li>How to test.</li>
<li>Version or revision history.</li>
<li>Rationale for design decisions.&nbsp; See <a href="#Rationale">Rationale
<li>Rationale for design decisions.&nbsp; See <a href="#Rationale">Rationale
rationale</a>.</li>
<li>Acknowledgements.&nbsp; See <a href="#Acknowledgements">Acknowledgments
<li>Acknowledgements.&nbsp; See <a href="#Acknowledgements">Acknowledgments
rationale.</a></li>
</ul>
<p>If you need more help with how to write documentation you can check out the
article on <a href="writingdoc/index.html">Writing Documentation for Boost</a>.</p>
<h2>Rationale</h2>
<p>Rationale for some of the requirements and guidelines follows.</p>
<hr>