summaryrefslogtreecommitdiffstats
path: root/llvm/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
commit7365a2838b078bc49945e024cb3f14ec383fd302 (patch)
tree4196a6bf354c1a7f90da6fc823fb8e8f14bdab7c /llvm/docs/CodingStandards.html
parent3967ef8df3cab9091bc1f4e39f2f004f3e03c705 (diff)
downloadbcm5719-llvm-7365a2838b078bc49945e024cb3f14ec383fd302.tar.gz
bcm5719-llvm-7365a2838b078bc49945e024cb3f14ec383fd302.zip
add a rule for enums, patch by Zhanyong Wan!
llvm-svn: 121430
Diffstat (limited to 'llvm/docs/CodingStandards.html')
-rw-r--r--llvm/docs/CodingStandards.html10
1 files changed, 6 insertions, 4 deletions
diff --git a/llvm/docs/CodingStandards.html b/llvm/docs/CodingStandards.html
index 4af3c6a5bf6..7791e8dd872 100644
--- a/llvm/docs/CodingStandards.html
+++ b/llvm/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
OpenPOWER on IntegriCloud