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

[Misha Brukman]

Changes in directory llvm/docs:

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

Documentation which contains smileys won't be taken seriously by some people.


---
Diffs of the changes:  (+7 -8)

Index: llvm/docs/CodingStandards.html
diff -u llvm/docs/CodingStandards.html:1.24 llvm/docs/CodingStandards.html:1.25
--- llvm/docs/CodingStandards.html:1.24	Tue Oct 26 11:18:43 2004
+++ llvm/docs/CodingStandards.html	Fri Dec  3 18:32:12 2004
@@ -111,7 +111,7 @@
 <div class="doc_text">
 
 <p>Comments are one critical part of readability and maintainability.  Everyone
-knows they should comment, so should you.  :)  Although we all should probably
+knows they should comment, so should you.  Although we all should probably
 comment our code more than we do, there are a few very critical places that
 documentation is very useful:</p>
 
@@ -164,7 +164,7 @@
 a class definition should have a comment block that explains what the class is
 used for... if it's not obvious.  If it's so completely obvious your grandma
 could figure it out, it's probably safe to leave it out.  Naming classes
-something sane goes a long ways towards avoiding writing documentation. :)</p>
+something sane goes a long ways towards avoiding writing documentation.</p>
 
 
 <b>Method information</b>
@@ -194,7 +194,7 @@
 
 <ol>
   <li>When writing a C code: Obviously if you are writing C code, use C style
-      comments.  :)</li>
+      comments.</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
@@ -470,7 +470,7 @@
 <p>Many modules have a complex implementation that causes them to use more than
 one implementation (<tt>.cpp</tt>) file.  It is often tempting to put the
 internal communication interface (helper classes, extra functions, etc) in the
-public module header file.  Don't do this.  :)</p>
+public module header file.  Don't do this.</p>
 
 <p>If you really need to do something like this, put a private header file in
 the same directory as the source files, and include it locally.  This ensures
@@ -594,8 +594,7 @@
 
 <p>For these reasons, come to know and love the contents of your local
 <tt><algorithm></tt> header file.  Know about <tt><functional></tt>
-and what it can do for you.  C++ is just a tool that wants you to master it.
-:)</p>
+and what it can do for you.  C++ is just a tool that wants you to master it.</p>
 
 </div>
 
@@ -625,7 +624,7 @@
 </ol>
 
 <p>If you get some free time, and you haven't read them: do so, you might learn
-something. :)</p>
+something.</p>
 
 </div>
 
@@ -640,7 +639,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:18:43 $
+  Last modified: $Date: 2004/12/04 00:32:12 $
 </address>
 
 </body>