Skip to content

Commit b3b329f

Browse files
author
Andrew Pardoe
committed
Fixing up suggestions from Issues 505 and 496
1 parent 2bd4a7c commit b3b329f

File tree

1 file changed

+17
-1
lines changed

1 file changed

+17
-1
lines changed

CppCoreGuidelines.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,7 @@ Supporting sections:
5757
* [Appendix A: Libraries](#S-libraries)
5858
* [Appendix B: Modernizing code](#S-modernizing)
5959
* [Appendix C: Discussion](#S-discussion)
60+
* [Appendix D: Tools support](#S-tools)
6061
* [Glossary](#S-glossary)
6162
* [To-do: Unclassified proto-rules](#S-unclassified)
6263

@@ -426,6 +427,7 @@ Supporting sections:
426427
* [Appendix A: Libraries](#S-libraries)
427428
* [Appendix B: Modernizing code](#S-modernizing)
428429
* [Appendix C: Discussion](#S-discussion)
430+
* [Appendix D: Tools support](#S-tools)
429431
* [Glossary](#S-glossary)
430432
* [To-do: Unclassified proto-rules](#S-unclassified)
431433

@@ -2613,7 +2615,7 @@ Member functions defined in-class are `inline` by default.
26132615

26142616
##### Exception
26152617

2616-
Template functions (incl. template member functions) must be in headers and therefore inline.
2618+
Template functions (incl. template member functions) are normally defined in headers and therefore inline.
26172619

26182620
##### Enforcement
26192621

@@ -21140,6 +21142,20 @@ It is common to need an initial set of elements.
2114021142

2114121143
When is a class a container? ???
2114221144

21145+
# <a name="S-tools"></a>Appendix D: Supporting tools
21146+
21147+
This section contains a list of tools that directly support adoption of the C++ Core Guidelines. This list is not intended to be an exhaustive list of tools
21148+
that are helpful in writing good C++ code. If a tool is designed specifically to support and links to the C++ Core Guidelines it is a candidate for inclusion.
21149+
In particular, here we present further rationale, longer examples, and discussions of alternatives.
21150+
21151+
### <a name="St-clangtidy"></a>Tools: [Clang-tidy](http://clang.llvm.org/extra/clang-tidy/checks/list.html)
21152+
21153+
Clang-tidy has a set of rules that specifically enforce the C++ Core Guidelines. These rules are named in the pattern `cppcoreguidelines-*`.
21154+
21155+
### <a name="St-cppcorecheck"></a>Tools: [CppCoreCheck](https://docs.microsoft.com/en-us/visualstudio/code-quality/using-the-cpp-core-guidelines-checkers)
21156+
21157+
The Microsoft compiler's C++ code analysis contains a set of rules specifically aimed at enforcement of the C++ Core Guidelines.
21158+
2114321159
# <a name="S-glossary"></a>Glossary
2114421160

2114521161
A relatively informal definition of terms used in the guidelines

0 commit comments

Comments
 (0)