Skip to content

Commit a79e5ab

Browse files
authored
Disambiguate "Visual Studio Code" and "Visual Studio Code *"
1 parent fe00e93 commit a79e5ab

File tree

4 files changed

+14
-14
lines changed

4 files changed

+14
-14
lines changed

docs/code-quality/quick-start-code-analysis-for-c-cpp.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ The Error List window lists the code analysis warnings found. The results are di
100100

101101
For detailed information about the warning, including possible solutions to the issue, choose the warning ID in the Code column to display its corresponding online help article.
102102

103-
Double-click a warning to move the cursor to the line of code that caused the warning in the Visual Studio code editor. Or, press Enter on the selected warning.
103+
Double-click a warning to move the cursor to the line of code that caused the warning in the code editor. Or, press Enter on the selected warning.
104104

105105
After you understand the problem, you can resolve it in your code. Then, rerun code analysis to make sure that the warning no longer appears in the Error List.
106106

docs/code-quality/understanding-sal.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -94,9 +94,9 @@ These annotations help identify possible uninitialized values and invalid null p
9494
9595
This section shows code examples for the basic SAL annotations.
9696
97-
### Using the Visual Studio Code Analysis Tool to Find Defects
97+
### Using the Visual Studio code analysis tool to find defects
9898
99-
In the examples, the Visual Studio Code Analysis tool is used together with SAL annotations to find code defects. Here's how to do that.
99+
In the examples, the Visual Studio code analysis tool is used together with SAL annotations to find code defects. Here's how to do that.
100100
101101
#### To use Visual Studio code analysis tools and SAL
102102
@@ -145,7 +145,7 @@ void BadInCaller()
145145
}
146146
```
147147

148-
If you use Visual Studio Code Analysis on this example, it validates that the callers pass a non-Null pointer to an initialized buffer for `pInt`. In this case, `pInt` pointer cannot be NULL.
148+
If you use Visual Studio code analysis on this example, it validates that the callers pass a non-Null pointer to an initialized buffer for `pInt`. In this case, `pInt` pointer cannot be NULL.
149149

150150
### Example: The \_In\_opt\_ Annotation
151151

@@ -172,7 +172,7 @@ void InOptCaller()
172172
}
173173
```
174174
175-
Visual Studio Code Analysis validates that the function checks for NULL before it accesses the buffer.
175+
Visual Studio code analysis validates that the function checks for NULL before it accesses the buffer.
176176
177177
### Example: The \_Out\_ Annotation
178178
@@ -198,7 +198,7 @@ void OutCaller()
198198
}
199199
```
200200

201-
Visual Studio Code Analysis Tool validates that the caller passes a non-NULL pointer to a buffer for `pInt` and that the buffer is initialized by the function before it returns.
201+
Visual Studio code analysis validates that the caller passes a non-NULL pointer to a buffer for `pInt` and that the buffer is initialized by the function before it returns.
202202

203203
### Example: The \_Out\_opt\_ Annotation
204204

@@ -225,7 +225,7 @@ void OutOptCaller()
225225
}
226226
```
227227
228-
Visual Studio Code Analysis validates that this function checks for NULL before `pInt` is dereferenced, and if `pInt` is not NULL, that the buffer is initialized by the function before it returns.
228+
Visual Studio code analysis validates that this function checks for NULL before `pInt` is dereferenced, and if `pInt` is not NULL, that the buffer is initialized by the function before it returns.
229229
230230
### Example: The \_Inout\_ Annotation
231231
@@ -256,7 +256,7 @@ void BadInOutCaller()
256256
}
257257
```
258258

259-
Visual Studio Code Analysis validates that callers pass a non-NULL pointer to an initialized buffer for `pInt`, and that, before return, `pInt` is still non-NULL and the buffer is initialized.
259+
Visual Studio code analysis validates that callers pass a non-NULL pointer to an initialized buffer for `pInt`, and that, before return, `pInt` is still non-NULL and the buffer is initialized.
260260

261261
### Example: The \_Inout\_opt\_ Annotation
262262

@@ -285,7 +285,7 @@ void InOutOptCaller()
285285
}
286286
```
287287
288-
Visual Studio Code Analysis validates that this function checks for NULL before it accesses the buffer, and if `pInt` is not NULL, that the buffer is initialized by the function before it returns.
288+
Visual Studio code analysis validates that this function checks for NULL before it accesses the buffer, and if `pInt` is not NULL, that the buffer is initialized by the function before it returns.
289289
290290
### Example: The \_Outptr\_ Annotation
291291
@@ -315,7 +315,7 @@ void OutPtrCaller()
315315
}
316316
```
317317

318-
Visual Studio Code Analysis validates that the caller passes a non-NULL pointer for `*pInt`, and that the buffer is initialized by the function before it returns.
318+
Visual Studio code analysis validates that the caller passes a non-NULL pointer for `*pInt`, and that the buffer is initialized by the function before it returns.
319319

320320
### Example: The \_Outptr\_opt\_ Annotation
321321

@@ -347,7 +347,7 @@ void OutPtrOptCaller()
347347
}
348348
```
349349
350-
Visual Studio Code Analysis validates that this function checks for NULL before `*pInt` is dereferenced, and that the buffer is initialized by the function before it returns.
350+
Visual Studio code analysis validates that this function checks for NULL before `*pInt` is dereferenced, and that the buffer is initialized by the function before it returns.
351351
352352
### Example: The \_Success\_ Annotation in Combination with \_Out\_
353353
@@ -366,7 +366,7 @@ bool GetValue(_Out_ int *pInt, bool flag)
366366
}
367367
```
368368

369-
The `_Out_` annotation causes Visual Studio Code Analysis to validate that the caller passes a non-NULL pointer to a buffer for `pInt`, and that the buffer is initialized by the function before it returns.
369+
The `_Out_` annotation causes Visual Studio code analysis to validate that the caller passes a non-NULL pointer to a buffer for `pInt`, and that the buffer is initialized by the function before it returns.
370370

371371
## SAL Best Practice
372372

docs/code-quality/using-the-cpp-core-guidelines-checkers.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -321,7 +321,7 @@ Because of the way the code analysis rules get loaded within Visual Studio 2015,
321321

322322
1. Select the Microsoft.CppCoreCheck package and then choose the **Install** button to add the rules to your project.
323323

324-
The NuGet package adds an MSBuild *`.targets`* file to your project that is invoked when you enable code analysis on your project. The *`.targets`* file adds the C++ Core Check rules as another extension to the Visual Studio Code analysis tool. When the package is installed, you can use the Property Pages dialog to enable or disable the released and experimental rules.
324+
The NuGet package adds an MSBuild *`.targets`* file to your project that is invoked when you enable code analysis on your project. The *`.targets`* file adds the C++ Core Check rules as another extension to the Visual Studio code analysis tool. When the package is installed, you can use the Property Pages dialog to enable or disable the released and experimental rules.
325325

326326
::: moniker-end
327327

docs/embedded/toc.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
items:
2-
- name: Embedded development with Visual Studio and Visual Studio code
2+
- name: Embedded development with Visual Studio and Visual Studio Code
33
href: ./index.yml
44
- name: Download and install the Embedded Tools
55
href: download-and-install-the-embedded-tooling.md

0 commit comments

Comments
 (0)