summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAndrew Trick <atrick@apple.com>2012-09-20 02:01:06 +0000
committerAndrew Trick <atrick@apple.com>2012-09-20 02:01:06 +0000
commitfc9420c0061f3aa5d4d410d2d38ea627cc2537bd (patch)
treeaa6cfc8ed872e51c19243bd58a03ff7960ea096a
parentd6e5fd52f0d8d59a8c1340439c40564d782eb22a (diff)
downloadbcm5719-llvm-fc9420c0061f3aa5d4d410d2d38ea627cc2537bd.tar.gz
bcm5719-llvm-fc9420c0061f3aa5d4d410d2d38ea627cc2537bd.zip
Fix static function names in CodingStandards examples.
Try not to violate conventions immediately before explaining them. llvm-svn: 164278
-rw-r--r--llvm/docs/CodingStandards.rst12
1 files changed, 6 insertions, 6 deletions
diff --git a/llvm/docs/CodingStandards.rst b/llvm/docs/CodingStandards.rst
index 4d16e2a9bd6..cb57b890297 100644
--- a/llvm/docs/CodingStandards.rst
+++ b/llvm/docs/CodingStandards.rst
@@ -601,9 +601,9 @@ code to be structured like this:
.. code-block:: c++
- /// ListContainsFoo - Return true if the specified list has an element that is
+ /// containsFoo - Return true if the specified list has an element that is
/// a foo.
- static bool ListContainsFoo(const std::vector<Bar*> &List) {
+ static bool containsFoo(const std::vector<Bar*> &List) {
for (unsigned i = 0, e = List.size(); i != e; ++i)
if (List[i]->isFoo())
return true;
@@ -611,7 +611,7 @@ code to be structured like this:
}
...
- if (ListContainsFoo(BarList)) {
+ if (containsFoo(BarList)) {
...
}
@@ -1120,7 +1120,7 @@ good:
};
} // end anonymous namespace
- static void Helper() {
+ static void runHelper() {
...
}
@@ -1140,7 +1140,7 @@ This is bad:
bool operator<(const char *RHS) const;
};
- void Helper() {
+ void runHelper() {
...
}
@@ -1150,7 +1150,7 @@ This is bad:
} // end anonymous namespace
-This is bad specifically because if you're looking at "``Helper``" in the middle
+This is bad specifically because if you're looking at "``runHelper``" in the middle
of a large C++ file, that you have no immediate way to tell if it is local to
the file. When it is marked static explicitly, this is immediately obvious.
Also, there is no reason to enclose the definition of "``operator<``" in the
OpenPOWER on IntegriCloud