1
0
Эх сурвалжийг харах

Add /libs/lib-name to comment

[SVN r16684]
Beman Dawes 23 жил өмнө
parent
commit
3cf0f69d6d
1 өөрчлөгдсөн 9 нэмэгдсэн , 6 устгасан
  1. 9 6
      more/lib_guide.htm

+ 9 - 6
more/lib_guide.htm

@@ -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>
 

粤ICP备19079148号