Skip to content

Commit ea7939d

Browse files
authored
Update clang-tidy.md
addressing some feedback
1 parent 0c23813 commit ea7939d

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

docs/code-quality/clang-tidy.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -37,21 +37,21 @@ The following keys are recognized for clang-tidy:
3737

3838
- `enableMicrosoftCodeAnalysis`: Enables Microsoft Code Analysis
3939
- `enableClangTidyCodeAnalysis`: Enables Clang-Tidy analysis
40-
- `clangTidyChecks`: Clang-Tidy configuration, specified as a comma-separated list, that is, checks to be enabled or disabled
40+
- `clangTidyChecks`: Clang-Tidy configuration. A comma-separated list, that is, checks to be enabled or disabled (e.g. "cert-oop58-cpp, -cppcoreguidelines-no-malloc, google-runtime-int" enables `cert-oop58-cpp` and `google-runtime-int` checks and disables via the `-` operator the `cppcoreguidelines-no-malloc` check)
4141

4242
If neither of the "enable" options are specified, Visual Studio will select the analysis tool matching the Platform Toolset used.
4343

4444
### CMake Settings
45-
To edit your clang-tidy settings, open your CMake Settings, select "Edit JSON" in the top right-hand corner of the CMake Project Settings Editor. You can use the keys above to fill out your clang-tidy specifications in the CMake Settings json file.
46-
An example CMake settings implementation would look like this:
45+
To edit your clang-tidy settings, open your CMake Settings, select **Edit JSON** in the CMake Project Settings Editor. You can use the keys above to fill out your clang-tidy specifications in the CMake Settings json file.
46+
An example CMake settings implementation looks like this:
4747
```
4848
{
4949
"configurations": [
5050
{
5151
"name": "x64-debug",
5252
"generator": "Ninja",
5353
....
54-
"clangTidyChecks": "",
54+
"clangTidyChecks": "llvm-include-order, -modernize-use-override",
5555
"enableMicrosoftCodeAnalysis": true,
5656
"enableClangTidyCodeAnalysis": true
5757
}
@@ -61,13 +61,13 @@ An example CMake settings implementation would look like this:
6161

6262
### CMake Presets
6363
The same keys can be used in your CMake presets via the `vendor` object.
64-
An example CMake preset implementation would look like this:
64+
An example CMake preset implementation looks like this:
6565
```"configurePreset": [
6666
{ "name": "base",
6767
....
6868
"vendor": {
6969
"microsoft.com/VisualStudioSettings/CMake/1.0": {
70-
"clangTidyChecks": "",
70+
"clangTidyChecks": "llvm-include-order, -modernize-use-override",
7171
"enableMicrosoftCodeAnalysis": true,
7272
"enableClangTidyCodeAnalysis": true
7373
}

0 commit comments

Comments
 (0)