diff --git a/index.htm b/index.htm index 6fb7e27..429409e 100644 --- a/index.htm +++ b/index.htm @@ -38,6 +38,10 @@ content="text/html; charset=iso-8859-1">

Library Requirements and Guidelines.  Basic standards for those preparing a submission.

+

Writing + Documentation for Boost Basic guidelines + for writing documentation and templates for quickly generating + documentation that follows the guidelines.

Test Policy and Protocols.  How testing works at Boost.

Library Submission diff --git a/lib_guide.htm b/lib_guide.htm index 4f570a0..54ff7a2 100644 --- a/lib_guide.htm +++ b/lib_guide.htm @@ -263,18 +263,20 @@ C++ programmer to use the library successfully?

  • General introduction to the library.
  • Description of each class.
  • Relationship between classes.
  • -
  • For each function, as applicable, description, requirements - (preconditions), effects, post-conditions, returns, and throws.
  • +
  • For each function, as applicable, description, requirements (preconditions), + effects, post-conditions, returns, and throws.
  • Discussion of error detection and recovery strategy.
  • How to use including description of typical uses.
  • How to compile and link.
  • How to test.
  • Version or revision history.
  • -
  • Rationale for design decisions.  See Rationale +
  • Rationale for design decisions.  See Rationale rationale.
  • -
  • Acknowledgements.  See Acknowledgments +
  • Acknowledgements.  See Acknowledgments rationale.
  • +

    If you need more help with how to write documentation you can check out the + article on Writing Documentation for Boost.

    Rationale

    Rationale for some of the requirements and guidelines follows.