aboutsummaryrefslogtreecommitdiffstats
path: root/docs/CodingStandards.rst
Commit message (Collapse)AuthorAgeFilesLines
* Revert r189704, which removed the guidance about not duplicating doc comments.Chris Lattner2013-09-011-0/+7
| | | | | | | This is under active discussion. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@189730 91177308-0d34-0410-b5e6-96231b3b80d8
* 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. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@189704 91177308-0d34-0410-b5e6-96231b3b80d8
* Add the common begin/end naming convention to the coding standard.Rafael Espindola2013-08-071-1/+3
| | | | git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@187902 91177308-0d34-0410-b5e6-96231b3b80d8
* 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() { // ... } }; git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@174317 91177308-0d34-0410-b5e6-96231b3b80d8
* Fix spellingJoel Jones2013-01-211-1/+1
| | | | git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@173103 91177308-0d34-0410-b5e6-96231b3b80d8
* 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. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@172162 91177308-0d34-0410-b5e6-96231b3b80d8
* 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. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@169107 91177308-0d34-0410-b5e6-96231b3b80d8
* docs: CodingStandards should follow the coding standards.Sean Silva2012-11-171-20/+20
| | | | | | Some variables in code examples were not LikeThis. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@168275 91177308-0d34-0410-b5e6-96231b3b80d8
* docs: Add link to HowToSetUpLLVMStyleRTTISean Silva2012-11-171-1/+2
| | | | git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@168271 91177308-0d34-0410-b5e6-96231b3b80d8
* Suggest llvm_unreachable over assert(0).Jordan Rose2012-10-261-10/+15
| | | | git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@166821 91177308-0d34-0410-b5e6-96231b3b80d8
* 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. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@166378 91177308-0d34-0410-b5e6-96231b3b80d8
* [Docs] Update File Headers section to cover doxygen style file level docs.Michael J. Spencer2012-10-011-8/+11
| | | | git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@164964 91177308-0d34-0410-b5e6-96231b3b80d8
* Fix && to && in Coding Standards.Jakub Staszak2012-09-301-1/+1
| | | | git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@164920 91177308-0d34-0410-b5e6-96231b3b80d8
* 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. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@164395 91177308-0d34-0410-b5e6-96231b3b80d8
* Document "do not use defaults in covered switch-over-enum" coding standard.David Blaikie2012-09-211-0/+18
| | | | git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@164389 91177308-0d34-0410-b5e6-96231b3b80d8
* Fix function names in coding style examplesAndrew Trick2012-09-201-4/+4
| | | | git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@164311 91177308-0d34-0410-b5e6-96231b3b80d8
* Fix static function names in CodingStandards examples.Andrew Trick2012-09-201-6/+6
| | | | | | Try not to violate conventions immediately before explaining them. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@164278 91177308-0d34-0410-b5e6-96231b3b80d8
* Coding standards: fix typo: '= deleted' -> '= delete'.Dmitri Gribenko2012-09-181-2/+2
| | | | git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@164126 91177308-0d34-0410-b5e6-96231b3b80d8
* Add LLVM_DELETED_FUNCTION to coding standards.Craig Topper2012-09-181-0/+28
| | | | git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@164101 91177308-0d34-0410-b5e6-96231b3b80d8
* Put space after "code-block::".Meador Inge2012-06-201-1/+1
| | | | git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@158880 91177308-0d34-0410-b5e6-96231b3b80d8
* Removed some left over HTML tags and a '}'.Meador Inge2012-06-201-3/+2
| | | | git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@158877 91177308-0d34-0410-b5e6-96231b3b80d8
* Sphinxify the CodingStandard documentation.Bill Wendling2012-06-201-0/+1148
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@158786 91177308-0d34-0410-b5e6-96231b3b80d8
generated by cgit v1.1 at 2024-12-23 23:11:42 +0000