Skip to content

Commit d28cea5

Browse files
author
3836425+corob-msft@users.noreply.github.com
committed
Markdown quality fixes 10 of N
1 parent cfb2060 commit d28cea5

9 files changed

Lines changed: 31 additions & 50 deletions

‎docs/mfc/reference/ctreectrl-class.md‎

Lines changed: 16 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -739,13 +739,11 @@ This method sends the `TVM_GETITEMPARTRECT` message, which is described in the W
739739

740740
### Example
741741

742-
The following code example defines a variable, `m_treeCtrl`, that is used to access the current tree-view control. The code example also defines an unsigned integer and several `HTREEITEM` variables. These variables are used in the next example.
742+
The first code example defines a variable, `m_treeCtrl`, that is used to access the current tree-view control. The code example also defines an unsigned integer and several `HTREEITEM` variables. These variables are used in the next example.
743743

744744
[!code-cpp[NVC_MFC_CTreeCtrl_s1#1](../../mfc/reference/codesnippet/cpp/ctreectrl-class_17.h)]
745745

746-
### Example
747-
748-
The following code example uses an accessibility identifier and the [`CTreeCtrl::MapAccIdToItem`](#mapaccidtoitem) method to retrieve a handle to the root tree-view item. Then the example uses the handle and the [`CTreeCtrl::GetItemPartRect`](#getitempartrect) method to draw a 3D rectangle around that item. In an earlier section of the code example, which is not shown, we created a tree-view that consists of a root country/region node for the United States, subnodes for the states of Pennsylvania and Washington, and tree items for cities in those states. We used the [`CTreeCtrl::MapItemToAccID`](#mapitemtoaccid) method to associate the root tree-view item with an accessibility identifier.
746+
The next code example uses an accessibility identifier and the [`CTreeCtrl::MapAccIdToItem`](#mapaccidtoitem) method to retrieve a handle to the root tree-view item. Then the example uses the handle and the [`CTreeCtrl::GetItemPartRect`](#getitempartrect) method to draw a 3D rectangle around that item. In an earlier section of the code example, which is not shown, we created a tree-view that consists of a root country/region node for the United States, subnodes for the states of Pennsylvania and Washington, and tree items for cities in those states. We used the [`CTreeCtrl::MapItemToAccID`](#mapitemtoaccid) method to associate the root tree-view item with an accessibility identifier.
749747

750748
[!code-cpp[NVC_MFC_CTreeCtrl_s1#5](../../mfc/reference/codesnippet/cpp/ctreectrl-class_18.cpp)]
751749

@@ -865,13 +863,11 @@ This method sends the [`TVM_GETNEXTITEM`](/windows/win32/Controls/tvm-getnextite
865863

866864
### Example
867865

868-
The following code example defines a variable, `m_treeCtrl`, that is used to access the current tree-view control. The code example also defines an unsigned integer and several `HTREEITEM` variables. One or more of these variables are used in the next example.
866+
The first code example defines a variable, `m_treeCtrl`, that is used to access the current tree-view control. The code example also defines an unsigned integer and several `HTREEITEM` variables. One or more of these variables are used in the next example.
869867

870868
[!code-cpp[NVC_MFC_CTreeCtrl_s1#1](../../mfc/reference/codesnippet/cpp/ctreectrl-class_17.h)]
871869

872-
### Example
873-
874-
The following code example retrieves a handle to the last unexpanded tree-view node item, and then draws a 3D rectangle around that item. In an earlier section of the code example, which is not shown, we created a tree-view that consists of a root country/region node for the United States, subnodes for the states of Pennsylvania and Washington, and tree items for cities in those states.
870+
The next code example retrieves a handle to the last unexpanded tree-view node item, and then draws a 3D rectangle around that item. In an earlier section of the code example, which is not shown, we created a tree-view that consists of a root country/region node for the United States, subnodes for the states of Pennsylvania and Washington, and tree items for cities in those states.
875871

876872
[!code-cpp[NVC_MFC_CTreeCtrl_s1#6](../../mfc/reference/codesnippet/cpp/ctreectrl-class_21.cpp)]
877873

@@ -1345,13 +1341,11 @@ This method sends the [`TVM_MAPACCIDTOHTREEITEM`](/windows/win32/Controls/tvm-ma
13451341

13461342
### Example
13471343

1348-
The following code example defines a variable, `m_treeCtrl`, that is used to access the current tree-view control. The code example also defines an unsigned integer and several `HTREEITEM` variables. These variables are used in the next example.
1344+
The first code example defines a variable, `m_treeCtrl`, that is used to access the current tree-view control. The code example also defines an unsigned integer and several `HTREEITEM` variables. These variables are used in the next example.
13491345

13501346
[!code-cpp[NVC_MFC_CTreeCtrl_s1#1](../../mfc/reference/codesnippet/cpp/ctreectrl-class_17.h)]
13511347

1352-
### Example
1353-
1354-
The following code example uses an accessibility identifier and the [`CTreeCtrl::MapAccIdToItem`](#mapaccidtoitem) method to retrieve a handle to the root tree-view item. The example uses the handle and the [`CTreeCtrl::GetItemPartRect`](#getitempartrect) method to draw a 3D rectangle around that item. In an earlier section of the code example, which is not shown, we created a tree-view that consists of a root country/region node for the United States, subnodes for the states of Pennsylvania and Washington, and tree items for cities in those states. We used the [`CTreeCtrl::MapItemToAccID`](#mapitemtoaccid) method to associate the root tree-view item with an accessibility identifier.
1348+
The next code example uses an accessibility identifier and the [`CTreeCtrl::MapAccIdToItem`](#mapaccidtoitem) method to retrieve a handle to the root tree-view item. The example uses the handle and the [`CTreeCtrl::GetItemPartRect`](#getitempartrect) method to draw a 3D rectangle around that item. In an earlier section of the code example, which is not shown, we created a tree-view that consists of a root country/region node for the United States, subnodes for the states of Pennsylvania and Washington, and tree items for cities in those states. We used the [`CTreeCtrl::MapItemToAccID`](#mapitemtoaccid) method to associate the root tree-view item with an accessibility identifier.
13551349

13561350
[!code-cpp[NVC_MFC_CTreeCtrl_s1#5](../../mfc/reference/codesnippet/cpp/ctreectrl-class_18.cpp)]
13571351

@@ -1380,13 +1374,11 @@ This method sends the [`TVM_MAPHTREEITEMTOACCID`](/windows/win32/Controls/tvm-ma
13801374

13811375
### Example
13821376

1383-
The following code example defines a variable, `m_treeCtrl`, that is used to access the current tree-view control. The code example also defines an unsigned integer and several `HTREEITEM` variables. These variables are used in the next example.
1377+
The first code example defines a variable, `m_treeCtrl`, that is used to access the current tree-view control. The code example also defines an unsigned integer and several `HTREEITEM` variables. These variables are used in the next example.
13841378

13851379
[!code-cpp[NVC_MFC_CTreeCtrl_s1#1](../../mfc/reference/codesnippet/cpp/ctreectrl-class_17.h)]
13861380

1387-
### Example
1388-
1389-
The following code example obtains an identification number for a tree-view control item. In an earlier section of the code example, which is not shown, we created a tree-view that consists of a root country/region node for the United States, subnodes for the states of Pennsylvania and Washington, and tree items for cities in those states. This code example obtains a unique identification number for the root country/region node.
1381+
The next code example obtains an identification number for a tree-view control item. In an earlier section of the code example, which is not shown, we created a tree-view that consists of a root country/region node for the United States, subnodes for the states of Pennsylvania and Washington, and tree items for cities in those states. This code example obtains a unique identification number for the root country/region node.
13901382

13911383
[!code-cpp[NVC_MFC_CTreeCtrl_s1#2](../../mfc/reference/codesnippet/cpp/ctreectrl-class_31.cpp)]
13921384

@@ -1527,13 +1519,11 @@ This method sends the [`TVM_SETAUTOSCROLLINFO`](/windows/win32/Controls/tvm-seta
15271519

15281520
### Example
15291521

1530-
The following code example defines a variable, `m_treeCtrl`, that is used to access the current tree-view control. The code example also defines an unsigned integer and several `HTREEITEM` variables. These variables are used in the next example.
1522+
The first code example defines a variable, `m_treeCtrl`, that is used to access the current tree-view control. The code example also defines an unsigned integer and several `HTREEITEM` variables. These variables are used in the next example.
15311523

15321524
[!code-cpp[NVC_MFC_CTreeCtrl_s1#1](../../mfc/reference/codesnippet/cpp/ctreectrl-class_17.h)]
15331525

1534-
### Example
1535-
1536-
The following code example sets the autoscroll behavior of the current tree-view control. In an earlier section of the code example, which is not shown, we created a tree-view that consists of a root country/region node for the United States, subnodes for the states of Pennsylvania and Washington, and tree items for cities in those states. We intentionally made the tree-view control narrow so that it must automatically scroll to display the tree item that has the focus. The code example sets the tree-view control to automatically scroll 30 pixels per second every 5 seconds until the tree item is in view.
1526+
The next code example sets the autoscroll behavior of the current tree-view control. In an earlier section of the code example, which is not shown, we created a tree-view that consists of a root country/region node for the United States, subnodes for the states of Pennsylvania and Washington, and tree items for cities in those states. We intentionally made the tree-view control narrow so that it must automatically scroll to display the tree item that has the focus. The code example sets the tree-view control to automatically scroll 30 pixels per second every 5 seconds until the tree item is in view.
15371527

15381528
[!code-cpp[NVC_MFC_CTreeCtrl_s1#4](../../mfc/reference/codesnippet/cpp/ctreectrl-class_33.cpp)]
15391529

@@ -1588,8 +1578,6 @@ When the tree control item is checked (*`fCheck`* set to `TRUE`), the item appea
15881578

15891579
[!code-cpp[NVC_MFC_CTreeCtrl#29](../../mfc/reference/codesnippet/cpp/ctreectrl-class_34.cpp)]
15901580

1591-
### Example
1592-
15931581
To use checkboxes, set `TVS_CHECKBOXES` before populating the tree control.
15941582

15951583
[!code-cpp[NVC_MFC_CTreeCtrl#30](../../mfc/reference/codesnippet/cpp/ctreectrl-class_35.cpp)]
@@ -1624,13 +1612,11 @@ This method sends the [`TVM_SETEXTENDEDSTYLE`](/windows/win32/Controls/tvm-setex
16241612

16251613
### Example
16261614

1627-
The following code example defines a variable, `m_treeCtrl`, that is used to access the current tree-view control. The code example also defines an unsigned integer and several `HTREEITEM` variables. These variables are used in the next example.
1615+
The first code example defines a variable, `m_treeCtrl`, that is used to access the current tree-view control. The code example also defines an unsigned integer and several `HTREEITEM` variables. These variables are used in the next example.
16281616

16291617
[!code-cpp[NVC_MFC_CTreeCtrl_s1#1](../../mfc/reference/codesnippet/cpp/ctreectrl-class_17.h)]
16301618

1631-
### Example
1632-
1633-
The following code example adds the `TVS_EX_AUTOHSCROLL` extended style to the current tree-view control. In an earlier section of the code example, which is not shown, we created a tree-view that consists of a root country/region node for the United States, subnodes for the states of Pennsylvania and Washington, and tree items for cities in those states. We intentionally made the tree-view control narrow so that it must automatically scroll to display the tree item that has the focus.
1619+
The next code example adds the `TVS_EX_AUTOHSCROLL` extended style to the current tree-view control. In an earlier section of the code example, which is not shown, we created a tree-view that consists of a root country/region node for the United States, subnodes for the states of Pennsylvania and Washington, and tree items for cities in those states. We intentionally made the tree-view control narrow so that it must automatically scroll to display the tree item that has the focus.
16341620

16351621
[!code-cpp[NVC_MFC_CTreeCtrl_s1#3](../../mfc/reference/codesnippet/cpp/ctreectrl-class_36.cpp)]
16361622

@@ -1843,13 +1829,11 @@ This method sends the [`TVM_SETITEM`](/windows/win32/Controls/tvm-setitem) messa
18431829
18441830
### Example
18451831
1846-
The following code example defines a variable, `m_treeCtrl`, that is used to access the current tree-view control. The code example also defines an unsigned integer and several `HTREEITEM` variables. These variables are used in the next example.
1832+
The first code example defines a variable, `m_treeCtrl`, that is used to access the current tree-view control. The code example also defines an unsigned integer and several `HTREEITEM` variables. These variables are used in the next example.
18471833
18481834
[!code-cpp[NVC_MFC_CTreeCtrl_s1#1](../../mfc/reference/codesnippet/cpp/ctreectrl-class_17.h)]
18491835
1850-
### Example
1851-
1852-
The following code example is a trivial test to determine whether the [`CTreeCtrl::GetItemExpandedImageIndex`](#getitemexpandedimageindex) method returns the value set by the [`CTreeCtrl::SetItemExpandedImageIndex`](#setitemexpandedimageindex) method. In an earlier section of the code example, which is not shown, we created a tree-view that consists of a root country/region node for the United States, subnodes for the states of Pennsylvania and Washington, and tree items for cities in those states.
1836+
The next code example is a trivial test to determine whether the [`CTreeCtrl::GetItemExpandedImageIndex`](#getitemexpandedimageindex) method returns the value set by the [`CTreeCtrl::SetItemExpandedImageIndex`](#setitemexpandedimageindex) method. In an earlier section of the code example, which is not shown, we created a tree-view that consists of a root country/region node for the United States, subnodes for the states of Pennsylvania and Washington, and tree items for cities in those states.
18531837
18541838
[!code-cpp[NVC_MFC_CTreeCtrl_s1#8](../../mfc/reference/codesnippet/cpp/ctreectrl-class_40.cpp)]
18551839
@@ -1974,13 +1958,11 @@ This method sends the [`TVM_SETITEM`](/windows/win32/Controls/tvm-setitem) messa
19741958
19751959
### Example
19761960
1977-
The following code example defines a variable, `m_treeCtrl`, that is used to access the current tree-view control. The code example also defines an unsigned integer and several `HTREEITEM` variables. These variables are used in the next example.
1961+
The first code example defines a variable, `m_treeCtrl`, that is used to access the current tree-view control. The code example also defines an unsigned integer and several `HTREEITEM` variables. These variables are used in the next example.
19781962
19791963
[!code-cpp[NVC_MFC_CTreeCtrl_s1#1](../../mfc/reference/codesnippet/cpp/ctreectrl-class_17.h)]
19801964
1981-
### Example
1982-
1983-
The following code example sets a tree-view item to disabled state. In an earlier section of the code example, which is not shown, we created a tree-view that consists of a root country/region node for the United States, subnodes for the states of Pennsylvania and Washington, and tree items for cities in those states. This code example sets the Pennsylvania node to disabled state.
1965+
The next code example sets a tree-view item to disabled state. In an earlier section of the code example, which is not shown, we created a tree-view that consists of a root country/region node for the United States, subnodes for the states of Pennsylvania and Washington, and tree items for cities in those states. This code example sets the Pennsylvania node to disabled state.
19841966
19851967
[!code-cpp[NVC_MFC_CTreeCtrl_s1#7](../../mfc/reference/codesnippet/cpp/ctreectrl-class_41.cpp)]
19861968

‎docs/mfc/reference/diagnostic-services.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -268,7 +268,7 @@ The DEBUG_ONLY macro is equivalent to surrounding *expression* with `#ifdef _DEB
268268

269269
**Header:** afx.h
270270

271-
### <a name="ensure"></a> ENSURE and ENSURE_VALID
271+
## <a name="ensure"></a> ENSURE and ENSURE_VALID
272272

273273
Use to validate data correctness.
274274

‎docs/mfc/tn033-dll-version-of-mfc.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -232,7 +232,7 @@ When *`A.DLL`* is built, it's built with **`/DA_IMPL`** and when *`B.DLL`* is bu
232232
233233
This type of layering can't be done when using the built-in `AFX_EXT_CLASS` and `_AFXEXT` preprocessor symbols. The technique described above solves this problem in the same way MFC does. MFC uses this technique when building its OLE, Database, and Network MFC extension DLLs.
234234
235-
### Not Exporting the Entire Class
235+
### Still Not Exporting the Entire Class
236236
237237
Again, you'll have to take special care when you aren't exporting an entire class. Ensure that the necessary data items created by the MFC macros are exported correctly. You can do it by redefining `AFX_DATA` to your specific class' macro. Redefine it whenever you're not exporting the entire class.
238238

‎docs/mfc/tn038-mfc-ole-iunknown-implementation.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -587,7 +587,7 @@ END_INTERFACE_MAP
587587
588588
The framework takes care of IUnknown because it is always required.
589589
590-
### INTERFACE_PART — Macro Description
590+
### INTERFACE_AGGREGATE — Macro Description
591591
592592
```cpp
593593
INTERFACE_AGGREGATE(theClass, theAggr)

‎docs/overview/whats-new-cpp-docs.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,7 @@ In addition to the changes below, many articles were updated to prevent the mach
124124
- [Compiler warnings C4400 Through C4599](../error-messages/compiler-warnings/compiler-warnings-c4400-through-c4599.md) - added some Visual Studio version 2017 diagnostics
125125
- [Compiler warnings C4800 through C5999](../error-messages/compiler-warnings/compiler-warnings-c4800-through-c4999.md) - update Visual Studio 16.10 conformance improvements and new warnings; add new 16.10 warnings, version info; added some version 2017 diagnostics; add missing errors and warnings: C7000 - C7999, C4834
126126
- [Vectorizer and parallelizer messages](../error-messages/tool-errors/vectorizer-and-parallelizer-messages.md) - add vectorizer failure reason 505; add 1204 reason code
127-
127+
128128
## C/C++ compiler intrinsics and assembly language
129129

130130
**Updated articles**
@@ -210,7 +210,7 @@ In addition to the changes below, many articles were updated to prevent the mach
210210
- [Unicode support in the compiler and linker](../build/reference/unicode-support-in-the-compiler-and-linker.md) - add info about how to save using a different encoding
211211
- [Use the Microsoft C++ toolset from the command line](../build/building-on-the-command-line.md) - updated for VS 2019
212212
- [Walkthrough: Compile a C program on the command line](../build/walkthrough-compile-a-c-program-on-the-command-line.md) - Visual Studio 16.10 updates to C17 conformance
213-
- [Walkthrough: Compiling a Native C++ Program on the Command Line](../build/walkthrough-compiling-a-native-cpp-program-on-the-command-line.md) - clarified notepad behavior when opening source file
213+
- [Walkthrough: Compiling a Native C++ Program on the Command Line](../build/walkthrough-compiling-a-native-cpp-program-on-the-command-line.md) - clarified notepad behavior when opening source file
214214

215215
## C++ Standard Library (STL) reference
216216

@@ -237,7 +237,7 @@ In addition to the changes below, many articles were updated to prevent the mach
237237

238238
**Updated articles**
239239

240-
- [C6031](../code-quality/c6031.md) - add note about ignoring a function's return value
240+
- [C6031](../code-quality/c6031.md) - add note about ignoring a function's return value
241241
- [C26432 DEFINE_OR_DELETE_SPECIAL_OPS](../code-quality/c26432.md) - update code examples
242242
- [C26497 USE_CONSTEXPR_FOR_FUNCTION](../code-quality/c26497.md) - add note about when warning won't be issued
243243

@@ -503,4 +503,4 @@ The following people contributed to the C++, C, and Assembler docs during this p
503503
- [vtjnash](https://github.com/vtjnash) - Jameson Nash (1)
504504
- [yecril71pl](https://github.com/yecril71pl) - Christopher Yeleighton (4)
505505
- [Youssef1313](https://github.com/Youssef1313) - Youssef Victor (1)
506-
- [zecozephyr](https://github.com/zecozephyr) - Jonathan Bailey (1)
506+
- [zecozephyr](https://github.com/zecozephyr) - Jonathan Bailey (1)

0 commit comments

Comments
 (0)