diff options
| author | Rafael Espindola <rafael.espindola@gmail.com> | 2013-08-07 19:34:37 +0000 |
|---|---|---|
| committer | Rafael Espindola <rafael.espindola@gmail.com> | 2013-08-07 19:34:37 +0000 |
| commit | b0b1622595b5ef8c74346acf116f99123f43ac09 (patch) | |
| tree | 95bc6f7b39321d16d6e84828988d2757ccc1dfb4 /llvm | |
| parent | a027f306a62626a48104096d53c538503ef0e10a (diff) | |
| download | bcm5719-llvm-b0b1622595b5ef8c74346acf116f99123f43ac09.tar.gz bcm5719-llvm-b0b1622595b5ef8c74346acf116f99123f43ac09.zip | |
Add the common begin/end naming convention to the coding standard.
llvm-svn: 187902
Diffstat (limited to 'llvm')
| -rw-r--r-- | llvm/docs/CodingStandards.rst | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/llvm/docs/CodingStandards.rst b/llvm/docs/CodingStandards.rst index 4d66ad75743..9418680edc7 100644 --- a/llvm/docs/CodingStandards.rst +++ b/llvm/docs/CodingStandards.rst @@ -796,7 +796,9 @@ In general, names should be in camel case (e.g. ``TextFileReader`` and As an exception, classes that mimic STL classes can have member names in STL's style of lower-case words separated by underscores (e.g. ``begin()``, -``push_back()``, and ``empty()``). +``push_back()``, and ``empty()``). Classes that provide multiple +iterators should add a singular prefix to ``begin()`` and ``end()`` +(e.g. ``global_begin()`` and ``use_begin()``). Here are some examples of good and bad names: |
