Chris Lattner
4fe35f8960
Revert r189704, which removed the guidance about not duplicating doc comments.
...
This is under active discussion.
llvm-svn: 189730
2013-09-01 15:48:08 +00:00
Chris Lattner
facd9ef8f5
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
f1f91213ec
Add the common begin/end naming convention to the coding standard.
...
llvm-svn: 187902
2013-08-07 19:34:37 +00:00
Dmitri Gribenko
8e9bbe5822
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
59aa8060b1
Fix spelling
...
llvm-svn: 173103
2013-01-21 23:20:47 +00:00
Sean Silva
e593654d4f
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
0459c763d6
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
e296be11ad
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
13a0bb2e64
docs: Add link to HowToSetUpLLVMStyleRTTI
...
llvm-svn: 168271
2012-11-17 21:01:44 +00:00
Jordan Rose
c9ba5a38bb
Suggest llvm_unreachable over assert(0).
...
llvm-svn: 166821
2012-10-26 22:08:46 +00:00
Dmitri Gribenko
f01cbf1125
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
975a363331
[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
c78b1c68c7
Fix && to && in Coding Standards.
...
llvm-svn: 164920
2012-09-30 20:42:13 +00:00
David Blaikie
022673f281
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
2bafd0b320
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
867c22eebd
Fix function names in coding style examples
...
llvm-svn: 164311
2012-09-20 17:02:04 +00:00
Andrew Trick
39a94943a8
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
ddd1dbb78c
Coding standards: fix typo: '= deleted' -> '= delete'.
...
llvm-svn: 164126
2012-09-18 14:00:58 +00:00
Craig Topper
4662d8cd85
Add LLVM_DELETED_FUNCTION to coding standards.
...
llvm-svn: 164101
2012-09-18 04:43:40 +00:00
Meador Inge
73a66eeb7d
Put space after "code-block::".
...
llvm-svn: 158880
2012-06-20 23:57:00 +00:00
Meador Inge
05adf60070
Removed some left over HTML tags and a '}'.
...
llvm-svn: 158877
2012-06-20 23:48:01 +00:00
Bill Wendling
88128b9637
Sphinxify the CodingStandard documentation.
...
llvm-svn: 158786
2012-06-20 02:57:56 +00:00
