add a rule for enums, patch by Zhanyong Wan!
authorChris Lattner <sabre@nondot.org>
Thu, 9 Dec 2010 23:32:39 +0000 (23:32 +0000)
committerChris Lattner <sabre@nondot.org>
Thu, 9 Dec 2010 23:32:39 +0000 (23:32 +0000)
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@121430 91177308-0d34-0410-b5e6-96231b3b80d8

docs/CodingStandards.html

index 4af3c6a5bf628a679a5a58e029e875bf7b3d6574..7791e8dd872b2993ac7881e0cb6f5b26023ffb69 100644 (file)
@@ -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