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

Minor updates

Browse Source 
[SVN r7769]
This commit is contained in:
Beman Dawes 2000-09-22 18:06:56 +00:00
parent aa13c941ef
commit ccf2ee2bf4
4 changed files with 31 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
feature_model_diagrams.htm
View File

@ -9,6 +9,7 @@
<body bgcolor="#FFFFFF" text="#000000">
<p><img border="0" src="../c++boost.gif" width="277" height="86"></p>
<h1>Feature Model Diagrams in text and HTML</h1>
<p>By <a href="../people/beman_dawes.html">Beman Dawes</a></p>
<h2>Introduction</h2>
@ -95,7 +96,7 @@ assuming no constraints.</p>
<p>Krzysztof Czarnecki and Ulrich W. Eisenecker, <a name="Generative Programming" href="http://www.generative-programming.org">Generative
Programming</a>, Addison-Wesley, 2000, ISBN 0-210-30977-7</p>
<hr>
<p>Revised <!--webbot bot="Timestamp" s-type="EDITED" s-format="%d %B %Y" startspan -->23 July 2000<!--webbot bot="Timestamp" endspan i-checksum="18762" --></p>
<p>Revised <!--webbot bot="Timestamp" s-type="EDITED" s-format="%d %B %Y" startspan -->25 August 2000<!--webbot bot="Timestamp" endspan i-checksum="31248" --></p>
<p>© Copyright Beman Dawes, 2000</p>
</body>

13
header.htm
View File

@ -28,15 +28,6 @@ be &quot;good neighbors&quot;.</p>
these are also reasonable guidelines for general use.
<ul>
<li>Headers should have a .hpp (lowercase) filename extension.&nbsp;</li>
<li>Identify the file with an initial comment line.&nbsp; The sample header
identifies both the name of the header and the library it is a part of.</li>
<li>Specify copyright ownership and any restrictions on use.&nbsp; If you
don't want to retain ownership, say something like &quot;Written by Jane
Programmer and placed in the public domain&quot;.</li>
<li>Supply version information, possibly generated automatically by your
version control system.</li>
<li>Macro names should be all uppercase, and begin with the namespace
name.&nbsp; Underscores separate words.</li>
<li>Wrap the header in #ifndef guards so that multiple inclusion is
benign.&nbsp; Use a naming convention that minimizes the chance of clashes
with macro names from other's code.&nbsp; The <a href="#Sample header">sample
@ -68,7 +59,7 @@ these are also reasonable guidelines for general use.
//&nbsp; in all copies. This software is provided &quot;as is&quot; without express or implied
//&nbsp; warranty, and with no claim as to its suitability for any purpose.
//&nbsp; $Id$ or other version information
//&nbsp; See http://www.boost.org for updates, documentation, and revision history.
#ifndef BOOST_FURBALL_HPP
#define BOOST_FURBALL_HPP
@ -95,7 +86,7 @@ commenting ending braces, and similar formatting issues.&nbsp; These stylistic
issues are viewed as personal preferences and are not part of the Boost Header
Policy.</p>
<hr>
<p>Revised <!--webbot bot="Timestamp" s-type="EDITED" s-format="%d %B, %Y" startspan -->27 July, 2000<!--webbot bot="Timestamp" endspan i-checksum="21060" --></p>
<p>Revised <!--webbot bot="Timestamp" s-type="EDITED" s-format="%d %B, %Y" startspan -->06 August, 2000<!--webbot bot="Timestamp" endspan i-checksum="34288" --></p>
</body>

5
index.htm
View File

@ -36,6 +36,9 @@ for library submissions.</p>
<p><b><a href="imp_vars.htm">Implementation Variations</a></b>.&nbsp;
Sometimes one size fits all, sometimes it doesn't.&nbsp; This page deals with
the trade-offs.</p>
<p><b><a href="library_reuse.htm">Library Reuse</a></b>.&nbsp; Should Boost
libraries use other boost libraries?&nbsp; What about the C++ Standard
Library?&nbsp; It's another trade-off.</p>
</blockquote>
<h2>Links</h2>
<blockquote>
@ -55,7 +58,7 @@ for library submissions.</p>
HTML</a></b> describes how to represent feature model diagrams in text form.</p>
</blockquote>
<hr>
<p>Revised <!--webbot bot="Timestamp" s-type="EDITED" s-format="%d %B, %Y" startspan -->16 July, 2000<!--webbot bot="Timestamp" endspan i-checksum="21057" --></p>
<p>Revised <!--webbot bot="Timestamp" s-type="EDITED" s-format="%d %B, %Y" startspan -->16 August, 2000<!--webbot bot="Timestamp" endspan i-checksum="34289" --></p>
</body>

27
lib_guide.htm
View File

@ -120,14 +120,20 @@ library, but a reasonable effort to comply is expected.</p>
<li>Headers should be good neighbors. See the <a href="header.htm">header
policy</a>.</li>
</ul>
<ul>
<li>Follow the <a href="imp_vars.htm">implementation variation policy</a>.&nbsp;</li>
</ul>
<ul>
<li>Follow quality programming practices. See, for example, &quot;Effective
C++&quot; 2nd Edition, and &quot;More Effective C++&quot;, both by Scott
Meyers, published by Addison Wesley.</li>
</ul>
<ul>
<li>Use the C++ Standard Library or other Boost libraries, but only when the
benefits outweigh the costs.&nbsp; Do not use libraries other than the C++
Standard Library or Boost. See <a href="library_reuse.htm">Library reuse</a>.</li>
</ul>
<ul>
<li>Read <a href="imp_vars.htm">Implementation Variation</a> to see how to
supply performance, platform, or other implementation variations.</li>
</ul>
<ul>
<li>Use the lowercase/underscore <a href="#Naming">naming conventions</a> of
the C++ standard library.&nbsp; Template parameter names begin with an
@ -158,6 +164,19 @@ library, but a reasonable effort to comply is expected.</p>
</ul>
</li>
</ul>
<ul>
<li>Begin all source files with:
<ul>
<li>A comment line describing the contents of the file.</li>
<li>Comments describing copyright and licensing.</li>
<li>A comment line referencing the Boost home page in the form:<br>
<code>// See http://www.boost.org for updates, documentation, and
revision history.</code><br>
[Including revision history in source files is no longer recommended;
the publicly available CVS repository better serves that purpose.]</li>
</ul>
</li>
</ul>
<h3>Documentation</h3>
<p>Even the simplest library needs some documentation; the amount should be
proportional to the need.&nbsp; The documentation should assume the readers have
@ -261,7 +280,7 @@ suggestion.&nbsp; Major contributions are usually acknowledged in the
documentation, while minor fixes are often mentioned in comments within the code
itself.</p>
<hr>
<p>Revised <!--webbot bot="Timestamp" s-type="EDITED" s-format="%d %B, %Y" startspan -->24 July, 2000<!--webbot bot="Timestamp" endspan i-checksum="21054" --></p>
<p>Revised <!--webbot bot="Timestamp" s-type="EDITED" s-format="%d %B, %Y" startspan -->30 August, 2000<!--webbot bot="Timestamp" endspan i-checksum="34279" --></p>
</body>