Chris Lattner
28cdc3d31b
Remove the suggestion to not duplicate comments in header and
...
implementation files. While doc generation systems don't need this,
humans do benefit from it. Not everyone reads all code through doxygen.
llvm-svn: 189704
2013-08-30 23:06:20 +00:00
Rafael Espindola
b0b1622595
Add the common begin/end naming convention to the coding standard.
...
llvm-svn: 187902
2013-08-07 19:34:37 +00:00
Dmitri Gribenko
a84c59c95a
Coding standards: don't use `inline` when defining a function in a class
...
definition
Current practice is not to use 'inline' in:
class Foo {
public:
inline void bar() {
// ...
}
};
llvm-svn: 174317
2013-02-04 10:24:58 +00:00
Joel Jones
7818be446c
Fix spelling
...
llvm-svn: 173103
2013-01-21 23:20:47 +00:00
Sean Silva
92a44897a2
docs: Fix long standing linking antipattern.
...
Before we learned about :doc:, we used :ref: and put a dummy link at the
top of each page. Don't do that anymore.
This fixes PR14891 as a special case.
llvm-svn: 172162
2013-01-11 02:28:08 +00:00
Chandler Carruth
494cfc0786
Simplify the coding standards for #include ordering. The ordering is now
...
trivially achievable with an editor. I'll likely check in a silly python
script to help with this too.
llvm-svn: 169107
2012-12-02 11:53:27 +00:00
Sean Silva
7333a848c8
docs: CodingStandards should follow the coding standards.
...
Some variables in code examples were not LikeThis.
llvm-svn: 168275
2012-11-17 23:25:33 +00:00
Sean Silva
0fc33ec10f
docs: Add link to HowToSetUpLLVMStyleRTTI
...
llvm-svn: 168271
2012-11-17 21:01:44 +00:00
Jordan Rose
2962d9599e
Suggest llvm_unreachable over assert(0).
...
llvm-svn: 166821
2012-10-26 22:08:46 +00:00
Dmitri Gribenko
9fb49d2b30
Document current Doxygen use practices in Coding Standards. Mostly it is
...
obvious stuff and most new code being committed conforms to that. Some old
code does not; this might cause confusion and this is the motivation to
document the correct guidelines.
llvm-svn: 166378
2012-10-20 13:27:43 +00:00
Michael J. Spencer
99a241fa2c
[Docs] Update File Headers section to cover doxygen style file level docs.
...
llvm-svn: 164964
2012-10-01 19:59:21 +00:00
Jakub Staszak
2e747e3596
Fix && to && in Coding Standards.
...
llvm-svn: 164920
2012-09-30 20:42:13 +00:00
David Blaikie
f787f171a3
Add missing 'to' and rephrase an explanation of GCC's assumptions.
...
Wordsmithing by Matt Beaumont-Gay in response to r164389.
llvm-svn: 164395
2012-09-21 18:03:02 +00:00
David Blaikie
00bec9a4ad
Document "do not use defaults in covered switch-over-enum" coding standard.
...
llvm-svn: 164389
2012-09-21 17:47:36 +00:00
Andrew Trick
e6af4b9a35
Fix function names in coding style examples
...
llvm-svn: 164311
2012-09-20 17:02:04 +00:00
Andrew Trick
fc9420c006
Fix static function names in CodingStandards examples.
...
Try not to violate conventions immediately before explaining them.
llvm-svn: 164278
2012-09-20 02:01:06 +00:00
Dmitri Gribenko
be88f563bf
Coding standards: fix typo: '= deleted' -> '= delete'.
...
llvm-svn: 164126
2012-09-18 14:00:58 +00:00
Craig Topper
1740e05c31
Add LLVM_DELETED_FUNCTION to coding standards.
...
llvm-svn: 164101
2012-09-18 04:43:40 +00:00
Meador Inge
6a706af708
Put space after "code-block::".
...
llvm-svn: 158880
2012-06-20 23:57:00 +00:00
Meador Inge
46137da795
Removed some left over HTML tags and a '}'.
...
llvm-svn: 158877
2012-06-20 23:48:01 +00:00
Bill Wendling
1c5e94a47c
Sphinxify the CodingStandard documentation.
...
llvm-svn: 158786
2012-06-20 02:57:56 +00:00
