Skip to content

Commit 5929002

Browse files
author
Colin Robertson
authored
Clarify some code analysis TOC entries (#2931)
* Clarify some code analysis TOC entries * Also fix overview toc * Also update code quality landing page
1 parent 32f1067 commit 5929002

File tree

3 files changed

+33
-8
lines changed

3 files changed

+33
-8
lines changed

docs/code-quality/index.yml

Lines changed: 28 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,6 @@ landingContent:
3131
links:
3232
- text: Analyze C/C++ code for defects walkthrough
3333
url: walkthrough-analyzing-c-cpp-code-for-defects.md
34-
- text: Use SAL annotations to reduce C/C++ code defects
35-
url: using-sal-annotations-to-reduce-c-cpp-code-defects.md
3634

3735
# Card
3836
- title: Code analysis reference
@@ -47,3 +45,31 @@ landingContent:
4745
url: code-analysis-for-cpp-corecheck.md
4846
- text: C++ code analysis warnings
4947
url: code-analysis-for-c-cpp-warnings.md
48+
49+
# Card
50+
- title: Use SAL annotations to reduce defects
51+
linkLists:
52+
- linkListType: overview
53+
links:
54+
- text: Understanding SAL
55+
url: understanding-sal.md
56+
- linkListType: get-started
57+
links:
58+
- text: SAL examples
59+
url: best-practices-and-examples-sal.md
60+
- linkListType: how-to-guide
61+
links:
62+
- text: Annotate function parameters and return values
63+
url: annotating-function-parameters-and-return-values.md
64+
- text: Annotate function behavior
65+
url: annotating-function-behavior.md
66+
- text: Annotate structs and classes
67+
url: annotating-structs-and-classes.md
68+
- text: Annotate locking behavior
69+
url: annotating-locking-behavior.md
70+
- text: Specify when and where annotations apply
71+
url: specifying-when-and-where-an-annotation-applies.md
72+
- linkListType: reference
73+
links:
74+
- text: SAL annotation intrinsics
75+
url: intrinsic-functions.md

docs/code-quality/toc.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
- name: Code analysis documentation
22
href: ../code-quality/index.yml
33
- name: Overview
4-
displayName: "C++ code analysis"
4+
displayName: "C and C++ code analysis"
55
href: ../code-quality/code-analysis-for-c-cpp-overview.md
66
- name: Quickstart
77
href: ../code-quality/quick-start-code-analysis-for-c-cpp.md
@@ -217,10 +217,10 @@
217217
href: ../code-quality/c26819.md
218218
- name: C26820
219219
href: ../code-quality/c26820.md
220-
- name: C/C++ warnings
220+
- name: C/C++ code analysis warnings
221221
items:
222222
- name: Overview
223-
displayName: "C++ warnings"
223+
displayName: "Code analysis warnings"
224224
href: ../code-quality/code-analysis-for-c-cpp-warnings.md
225225
- name: C1250
226226
href: ../code-quality/c1250.md

docs/overview/toc.yml

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
- name: C++ in Visual Studio
1+
- name: Microsoft C/C++ in Visual Studio
22
expanded: false
33
items:
44
- name: C++ in Visual Studio
@@ -40,7 +40,7 @@
4040
href: /windows/uwp/gaming/tutorial--create-your-first-uwp-directx-game
4141
- name: Projects and build systems
4242
href: ../build/projects-and-build-systems-cpp.md
43-
- name: Read and write C++ code in Visual Studio
43+
- name: Read and write code in Visual Studio
4444
href: ../ide/read-and-understand-code-cpp.md
4545
- name: Windows desktop development
4646
href: ../windows/overview-of-windows-programming-in-cpp.md
@@ -123,6 +123,5 @@
123123
href: ../mfc/mfc-and-atl.md
124124
- name: Parallel libraries
125125
href: ../parallel/
126-
items:
127126
- name: Data access libraries
128127
href: ../data/

0 commit comments

Comments
 (0)