summaryrefslogtreecommitdiffstats
path: root/llvm/docs/CodingStandards.rst
Commit message (Collapse)AuthorAgeFilesLines
* Revert my commit in r199620 that added sections about namespaces to theChandler Carruth2014-01-201-97/+18
| | | | | | | | | | | | | | | | | | coding standards, and instead fix the existing section. Thanks to Daniel Jasper for pointing out we already had a section devoted to this topic. Instead of adding sections, just hack on this section some. Also fix the example in the anonymous namespace section below it to agree with the new advice. As a re-cap, this switches the LLVM preferred style to never indent namespaces. Having two approaches just led to endless (and utterly pointless) debates about what was "small enough". This wasn't helping anyone. The no-indent rule is easy to understand and doesn't really make anything harder to read. Moreover, with tools like clang-format it is considerably nicer to have simple consistent rules. llvm-svn: 199637
* Add some wording to the coding standards to say how to indent namespacesChandler Carruth2014-01-201-1/+45
| | | | | | | | | | | (and to mention namespace ending comments). This is based on a quick discussion on the developer mailing list where there was essentially no objections to a simple and consistent rule. This should avoid future debates about whether or not a namespace is "big enough" to indent. It also matches clang-format's current behavior with LLVM source code which hasn't really seen any opposition in code reviews that I spot checked. llvm-svn: 199620
* Correct word hyphenationsAlp Toker2013-12-051-1/+1
| | | | | | | This patch tries to avoid unrelated changes other than fixing a few hyphen-related ambiguities and contractions in nearby lines. llvm-svn: 196471
* Revert r189704, which removed the guidance about not duplicating doc comments.Chris Lattner2013-09-011-0/+7
| | | | | | This is under active discussion. llvm-svn: 189730
* Remove the suggestion to not duplicate comments in header andChris Lattner2013-08-301-7/+0
| | | | | | | 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
* Add the common begin/end naming convention to the coding standard.Rafael Espindola2013-08-071-1/+3
| | | | llvm-svn: 187902
* Coding standards: don't use ``inline`` when defining a function in a classDmitri Gribenko2013-02-041-0/+28
| | | | | | | | | | | | | | | definition Current practice is not to use 'inline' in: class Foo { public: inline void bar() { // ... } }; llvm-svn: 174317
* Fix spellingJoel Jones2013-01-211-1/+1
| | | | llvm-svn: 173103
* docs: Fix long standing linking antipattern.Sean Silva2013-01-111-2/+0
| | | | | | | | | 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
* Simplify the coding standards for #include ordering. The ordering is nowChandler Carruth2012-12-021-9/+2
| | | | | | | trivially achievable with an editor. I'll likely check in a silly python script to help with this too. llvm-svn: 169107
* docs: CodingStandards should follow the coding standards.Sean Silva2012-11-171-20/+20
| | | | | | Some variables in code examples were not LikeThis. llvm-svn: 168275
* docs: Add link to HowToSetUpLLVMStyleRTTISean Silva2012-11-171-1/+2
| | | | llvm-svn: 168271
* Suggest llvm_unreachable over assert(0).Jordan Rose2012-10-261-10/+15
| | | | llvm-svn: 166821
* Document current Doxygen use practices in Coding Standards. Mostly it isDmitri Gribenko2012-10-201-9/+134
| | | | | | | | 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
* [Docs] Update File Headers section to cover doxygen style file level docs.Michael J. Spencer2012-10-011-8/+11
| | | | llvm-svn: 164964
* Fix && to && in Coding Standards.Jakub Staszak2012-09-301-1/+1
| | | | llvm-svn: 164920
* Add missing 'to' and rephrase an explanation of GCC's assumptions.David Blaikie2012-09-211-4/+4
| | | | | | Wordsmithing by Matt Beaumont-Gay in response to r164389. llvm-svn: 164395
* Document "do not use defaults in covered switch-over-enum" coding standard.David Blaikie2012-09-211-0/+18
| | | | llvm-svn: 164389
* Fix function names in coding style examplesAndrew Trick2012-09-201-4/+4
| | | | llvm-svn: 164311
* Fix static function names in CodingStandards examples.Andrew Trick2012-09-201-6/+6
| | | | | | Try not to violate conventions immediately before explaining them. llvm-svn: 164278
* Coding standards: fix typo: '= deleted' -> '= delete'.Dmitri Gribenko2012-09-181-2/+2
| | | | llvm-svn: 164126
* Add LLVM_DELETED_FUNCTION to coding standards.Craig Topper2012-09-181-0/+28
| | | | llvm-svn: 164101
* Put space after "code-block::".Meador Inge2012-06-201-1/+1
| | | | llvm-svn: 158880
* Removed some left over HTML tags and a '}'.Meador Inge2012-06-201-3/+2
| | | | llvm-svn: 158877
* Sphinxify the CodingStandard documentation.Bill Wendling2012-06-201-0/+1148
llvm-svn: 158786
OpenPOWER on IntegriCloud