[llvm-commits] CVS: llvm/docs/CodingStandards.html

[Misha Brukman]

Changes in directory llvm/docs:

CodingStandards.html updated: 1.23 -> 1.24
---
Log message:

Use <tt> around "#include" and "std::endl"


---
Diffs of the changes:  (+22 -21)

Index: llvm/docs/CodingStandards.html
diff -u llvm/docs/CodingStandards.html:1.23 llvm/docs/CodingStandards.html:1.24
--- llvm/docs/CodingStandards.html:1.23	Tue Oct 26 11:07:46 2004
+++ llvm/docs/CodingStandards.html	Tue Oct 26 11:18:43 2004
@@ -19,7 +19,7 @@
         <ol>
           <li><a href="#scf_commenting">Commenting</a></li>
           <li><a href="#scf_commentformat">Comment Formatting</a></li>
-          <li><a href="#scf_includes">#include Style</a></li>
+          <li><a href="#scf_includes"><tt>#include</tt> Style</a></li>
           <li><a href="#scf_codewidth">Source Code Width</a></li>
           <li><a href="#scf_spacestabs">Use Spaces Instead of Tabs</a></li>
           <li><a href="#scf_indentation">Indent Code Consistently</a></li>
@@ -46,7 +46,7 @@
         <ol>
           <li><a href="#hl_assert">Assert Liberally</a></li>
           <li><a href="#hl_preincrement">Prefer Preincrement</a></li>
-          <li><a href="#hl_avoidendl">Avoid std::endl</a></li>
+          <li><a href="#hl_avoidendl">Avoid <tt>std::endl</tt></a></li>
           <li><a href="#hl_exploitcpp">Exploit C++ to its Fullest</a></li>
         </ol></li>
     </ol></li>
@@ -195,7 +195,8 @@
 <ol>
   <li>When writing a C code: Obviously if you are writing C code, use C style
       comments.  :)</li>
-  <li>When writing a header file that may be #included by a C source file.</li>
+  <li>When writing a header file that may be <tt>#include</tt>d by a C source
+      file.</li>
   <li>When writing a source file that is used by a tool that only accepts C
       style comments.</li>
 </ol>
@@ -207,7 +208,7 @@
 
 <!-- _______________________________________________________________________ -->
 <div class="doc_subsubsection">
-  <a name="scf_includes">#include Style</a>
+  <a name="scf_includes"><tt>#include</tt> Style</a>
 </div>
 
 <div class="doc_text">
@@ -235,13 +236,13 @@
 <p>... and each catagory should be sorted by name.</p>
 
 <p><a name="mmheader">The "Main Module Header"</a> file applies to .cpp file
-which implement an interface defined by a .h file.  This #include should always
-be included <b>first</b> regardless of where it lives on the file system.  By
-including a header file first in the .cpp files that implement the interfaces,
-we ensure that the header does not have any hidden dependencies which are not
-explicitly #included in the header, but should be.  It is also a form of
-documentation in the .cpp file to indicate where the interfaces it implements
-are defined.</p>
+which implement an interface defined by a .h file.  This <tt>#include</tt>
+should always be included <b>first</b> regardless of where it lives on the file
+system.  By including a header file first in the .cpp files that implement the
+interfaces, we ensure that the header does not have any hidden dependencies
+which are not explicitly #included in the header, but should be.  It is also a
+form of documentation in the .cpp file to indicate where the interfaces it
+implements are defined.</p>
 
 </div>
 
@@ -432,7 +433,7 @@
 
 <!-- _______________________________________________________________________ -->
 <div class="doc_subsubsection">
-  <a name="hl_dontinclude">#include as Little as Possible</a>
+  <a name="hl_dontinclude"><tt>#include</tt> as Little as Possible</a>
 </div>
 
 <div class="doc_text">
@@ -441,13 +442,13 @@
 have to, especially in header files.</p>
 
 <p>But wait, sometimes you need to have the definition of a class to use it, or
-to inherit from it.  In these cases go ahead and #include that header file.  Be
-aware however that there are many cases where you don't need to have the full
-definition of a class.  If you are using a pointer or reference to a class, you
-don't need the header file.  If you are simply returning a class instance from a
-prototyped function or method, you don't need it.  In fact, for most cases, you
-simply don't need the definition of a class... and not <tt>#include</tt>'ing
-speeds up compilation.</p>
+to inherit from it.  In these cases go ahead and <tt>#include</tt> that header
+file.  Be aware however that there are many cases where you don't need to have
+the full definition of a class.  If you are using a pointer or reference to a
+class, you don't need the header file.  If you are simply returning a class
+instance from a prototyped function or method, you don't need it.  In fact, for
+most cases, you simply don't need the definition of a class... and not
+<tt>#include</tt>'ing speeds up compilation.</p>
 
 <p>It is easy to try to go too overboard on this recommendation, however.  You
 <b>must</b> include all of the header files that you are using, either directly
@@ -557,7 +558,7 @@
 
 <!-- _______________________________________________________________________ -->
 <div class="doc_subsubsection">
-  <a name="hl_avoidendl">Avoid std::endl</a>
+  <a name="hl_avoidendl">Avoid <tt>std::endl</tt></a>
 </div>
 
 <div class="doc_text">
@@ -639,7 +640,7 @@
 
   <a href="mailto:sabre at nondot.org">Chris Lattner</a><br>
   <a href="http://llvm.cs.uiuc.edu">LLVM Compiler Infrastructure</a><br>
-  Last modified: $Date: 2004/10/26 16:07:46 $
+  Last modified: $Date: 2004/10/26 16:18:43 $
 </address>
 
 </body>