summaryrefslogtreecommitdiff
path: root/docs/CodingStandards.html
diff options
context:
space:
mode:
authorChris Lattner <sabre@nondot.org>2010-12-09 23:32:39 +0000
committerChris Lattner <sabre@nondot.org>2010-12-09 23:32:39 +0000
commit98bec51b35382ab1682e31818e46bc165ea74142 (patch)
tree7a16b8e1f7d23f427eb89bf6ec008be68bdcabbe /docs/CodingStandards.html
parent7dddad562fff1542e0c29f4bb748d0a2c7a7c449 (diff)
downloadllvm-98bec51b35382ab1682e31818e46bc165ea74142.tar.gz
llvm-98bec51b35382ab1682e31818e46bc165ea74142.tar.bz2
llvm-98bec51b35382ab1682e31818e46bc165ea74142.tar.xz
add a rule for enums, patch by Zhanyong Wan!
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@121430 91177308-0d34-0410-b5e6-96231b3b80d8
Diffstat (limited to 'docs/CodingStandards.html')
-rw-r--r--docs/CodingStandards.html10
1 files changed, 6 insertions, 4 deletions
diff --git a/docs/CodingStandards.html b/docs/CodingStandards.html
index 4af3c6a5bf..7791e8dd87 100644
--- a/docs/CodingStandards.html
+++ b/docs/CodingStandards.html
@@ -824,10 +824,12 @@ known.</p>
should be in camel case (e.g. <tt>TextFileReader</tt>
and <tt>isLValue()</tt>). Type names (including classes, structs,
enums, typedefs, etc) should be nouns and start with an upper-case
-letter (e.g. <tt>TextFileReader</tt>). Function names should be verb
-phrases (as they represent actions) and start with a lower-case letter
-(e.g. a predicate may be named <tt>isFoo()</tt> or <tt>hasBar()</tt>,
-while the name of a command-like function should be imperative,
+letter (e.g. <tt>TextFileReader</tt>). An <tt>enum</tt> for all the
+different kinds of something should be named with the <tt>Kind</tt>
+suffix. Function names should be verb phrases (as they represent
+actions) and start with a lower-case letter (e.g. a predicate may be
+named <tt>isFoo()</tt> or <tt>hasBar()</tt>, while the name of a
+command-like function should be imperative,
like <tt>openFile()</tt>).</p>
<p>Enumerators and public member variables should start with an