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

Add /libs/lib-name to comment

Browse Source 
[SVN r16684]
This commit is contained in:
Beman Dawes 2002-12-23 02:08:41 +00:00
parent 0026aa49e4
commit 6fe9662880
1 changed files with 9 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
lib_guide.htm
View File

@ -214,11 +214,14 @@ library, but a reasonable effort to comply is expected.</p>
<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>
<li>A comment line referencing your library on the Boost web site:<br>
<br>
<code>// See http://www.boost.org/libs/foo for documentation.</code><br>
<br>
where <code>foo</code> is the directory name (see below) for your library.
As well as aiding users who come across a Boost file detached from its
documentation, some of Boost's automatic tools depend on this comment to
identify which library header files belong to.</li>
</ul>
</li>
</ul>
@ -441,7 +444,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 -->16 December, 2002<!--webbot bot="Timestamp" endspan i-checksum="38515" --></p>
<p>Revised <!--webbot bot="Timestamp" s-type="EDITED" s-format="%d %B, %Y" startspan -->22 December, 2002<!--webbot bot="Timestamp" endspan i-checksum="38508" --></p>
</body>