summaryrefslogtreecommitdiff
path: root/docs/CodingStandards.html
diff options
context:
space:
mode:
authorChris Lattner <sabre@nondot.org>2010-12-10 00:54:03 +0000
committerChris Lattner <sabre@nondot.org>2010-12-10 00:54:03 +0000
commit78ceb3a4159ef723232471dd9e34b08114ebf870 (patch)
treeac19e37f31a3d339c335b0b17683fb88087c0bcc /docs/CodingStandards.html
parent69ad797214acdfe2fa99f08395f85c89fa6f81ec (diff)
downloadllvm-78ceb3a4159ef723232471dd9e34b08114ebf870.tar.gz
llvm-78ceb3a4159ef723232471dd9e34b08114ebf870.tar.bz2
llvm-78ceb3a4159ef723232471dd9e34b08114ebf870.tar.xz
fix some validation problems
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@121444 91177308-0d34-0410-b5e6-96231b3b80d8
Diffstat (limited to 'docs/CodingStandards.html')
-rw-r--r--docs/CodingStandards.html19
1 files changed, 10 insertions, 9 deletions
diff --git a/docs/CodingStandards.html b/docs/CodingStandards.html
index f42abd9d33..ff33ffa98a 100644
--- a/docs/CodingStandards.html
+++ b/docs/CodingStandards.html
@@ -60,7 +60,7 @@
loop</a></li>
<li><a href="#ll_iostream"><tt>#include &lt;iostream&gt;</tt> is
<em>forbidden</em></a></li>
- <li><a href="#ll_raw_ostream">Use <tt>raw_ostream</tt></a</li>
+ <li><a href="#ll_raw_ostream">Use <tt>raw_ostream</tt></a></li>
<li><a href="#ll_avoidendl">Avoid <tt>std::endl</tt></a></li>
</ol></li>
@@ -828,24 +828,25 @@ and <tt>isLValue()</tt>). Different kinds of declarations have different rules:
</p>
<ul>
-<li><b>Type names</b> (including classes, structs, enums, typedefs, etc) should
- be nouns and start with an upper-case letter (e.g. <tt>TextFileReader</tt>).
+<li><p><b>Type names</b> (including classes, structs, enums, typedefs, etc)
+ should be nouns and start with an upper-case letter (e.g.
+ <tt>TextFileReader</tt>).</p>
</li>
-<li><b>Function names</b> should be verb phrases (as they represent
+<li><p><b>Function names</b> should be verb phrases (as they represent
actions), and command-like function should be imperative. The name should
be camel case, and start with a lower case letter (e.g. <tt>openFile()</tt>
- or <tt>isFoo()</tt>).
+ or <tt>isFoo()</tt>).</p>
</li>
-<li><b>Enum declarations</b> (e.g. "enum Foo {...}") are types, so they should
- follow the naming conventions for types. A common use for enums is as a
+<li><p><b>Enum declarations</b> (e.g. "enum Foo {...}") are types, so they
+should follow the naming conventions for types. A common use for enums is as a
discriminator for a union, or an indicator of a subclass. When an enum is
used for something like this, it should have a "Kind" suffix (e.g.
- "ValueKind").
+ "ValueKind").</p>
</li>
-<li><b>Enumerators</b> (e.g. enum { Foo, Bar }) and
+<li><p><b>Enumerators</b> (e.g. enum { Foo, Bar }) and
<b>public member variables</b> should start with an upper-case letter, just
like types. Unless the enumerators are defined in their own small
namespace or inside a class, enumerators should have a prefix corresponding