Skip to content

Commit ac17c9b

Browse files
authored
Merge pull request #1220 from msebolt/windows-formatting-review-pr36
windows formatting review pr36
2 parents 4ed2b31 + 63c0f93 commit ac17c9b

40 files changed

+48
-70
lines changed

docs/windows/mutextraits-structure.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Defines common characteristics of the [Mutex](../windows/mutex-class1.md) class.
1717

1818
## Syntax
1919

20-
```
20+
```cpp
2121
struct MutexTraits : HANDLENullTraits;
2222
```
2323

docs/windows/mutextraits-unlock-method.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Releases exclusive control of a shared resource.
1717

1818
## Syntax
1919

20-
```
20+
```cpp
2121
inline static void Unlock(
2222
_In_ Type h
2323
);

docs/windows/new-custom-resource-dialog-box.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ ms.workload: ["cplusplus", "uwp"]
1515
# New Custom Resource Dialog Box
1616
Enables you to create a new custom resource.
1717

18-
**Resource Type**
18+
### Resource Type
1919
Provides a text box for you to enter the name of a custom resource type. Visual C++ automatically capitalizes the name when you exit the **New Custom Resource** dialog box.
2020

2121
## Remarks

docs/windows/new-device-image-type-dialog-box-image-editor-for-icons.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ ms.workload: ["cplusplus", "uwp"]
1515
# New <Device> Image Type Dialog Box (Image Editor for Icons)
1616
Enables you to create a new device image of a specified type. To open the **New \<Device> Image** dialog box, click **New Image Type** on the **Image** menu.
1717

18-
**Target Image Type**
18+
### Target Image Type
1919
Lists the available image types. Select the image type you want to open:
2020

2121
||||
@@ -30,7 +30,7 @@ Enables you to create a new device image of a specified type. To open the **New
3030
> [!NOTE]
3131
> Any existing images will not be displayed in this list.
3232
33-
**Custom**
33+
### Custom
3434
Opens the [Custom Image dialog box](custom-image-dialog-box-image-editor-for-icons.md) in which you can create a new image with a custom size and number of colors.
3535

3636
## Requirements
@@ -39,4 +39,4 @@ Enables you to create a new device image of a specified type. To open the **New
3939
## See Also
4040
[Icons and Cursors: Image Resources for Display Devices](../windows/icons-and-cursors-image-resources-for-display-devices-image-editor-for-icons.md)
4141
[Image Menu](../windows/image-menu-image-editor-for-icons.md)
42-
[Image Editor for Icons](../windows/image-editor-for-icons.md)
42+
[Image Editor for Icons](../windows/image-editor-for-icons.md)

docs/windows/new-new-slot-in-vtable-cpp-component-extensions.md

-2
Original file line numberDiff line numberDiff line change
@@ -85,8 +85,6 @@ int main() {
8585
}
8686
```
8787
88-
**Output**
89-
9088
```Output
9189
C::f() called
9290

docs/windows/new-toolbar-resource-dialog-box.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -13,14 +13,14 @@ ms.author: "mblome"
1313
ms.workload: ["cplusplus", "uwp"]
1414
---
1515
# New Toolbar Resource Dialog Box
16-
The New Toolbar Resource dialog box allows you to specify the width and height of the buttons you are adding to a toolbar resource. The default is 16 × 15 pixels.
16+
The **New Toolbar Resource** dialog box allows you to specify the width and height of the buttons you are adding to a toolbar resource. The default is 16 × 15 pixels.
1717

1818
A bitmap that is used to create a toolbar has a maximum width of 2048. So if you set the **Button Width** to 512, you can only have four buttons. If you set the width to 513, you can only have three buttons.
1919

20-
**Button Width**
20+
### Button Width
2121
Provides a space for you to enter the width for the toolbar buttons you are converting from a bitmap resource to a toolbar resource. The images are cropped to the width and height specified, and the colors are adjusted to use standard toolbar colors (16 colors).
2222

23-
**Button Height**
23+
### Button Height
2424
Provides a space for you to enter the height for the toolbar buttons you are converting from a bitmap resource to a toolbar resource. The images are cropped to the width and height specified, and the colors are adjusted to use standard toolbar colors (16 colors).
2525

2626
For information on adding resources to managed projects, please see [Resources in Desktop Apps](/dotnet/framework/resources/index) in the *.NET Framework Developer's Guide*. For information on manually adding resource files to managed projects, accessing resources, displaying static resources, and assigning resource strings to properties, see [Creating Resource Files for Desktop Apps](/dotnet/framework/resources/creating-resource-files-for-desktop-apps). For information on globalization and localization of resources in managed apps, see [Globalizing and Localizing .NET Framework Applications](/dotnet/standard/globalization-localization/index).

docs/windows/nil-structure.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Supports the WRL infrastructure and is not intended to be used directly from you
1616

1717
## Syntax
1818

19-
```
19+
```cpp
2020
struct Nil;
2121
```
2222

docs/windows/no-injected-text.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -17,13 +17,13 @@ Prevents the compiler from injecting code as a result of attribute use.
1717

1818
## Syntax
1919

20-
```
20+
```cpp
2121
[ no_injected_text(
2222
boolean
2323
) ];
2424
```
2525

26-
#### Parameters
26+
### Parameters
2727
*boolean* (optional)
2828
**true** if you want no code injected, **false** to allow code to be injected. **true** is the default.
2929

docs/windows/nonbrowsable.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Indicates that an interface member should not be displayed in a property browser
1717

1818
## Syntax
1919

20-
```
20+
```cpp
2121
[nonbrowsable]
2222
```
2323

docs/windows/noncreatable.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Defines an object that cannot be instantiated by itself.
1717

1818
## Syntax
1919

20-
```
20+
```cpp
2121
[noncreatable]
2222
```
2323

docs/windows/nonextensible.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Specifies that the `IDispatch` implementation includes only the properties and m
1717

1818
## Syntax
1919

20-
```
20+
```cpp
2121
[nonextensible]
2222
```
2323

docs/windows/nullptr-cpp-component-extensions.md

-6
Original file line numberDiff line numberDiff line change
@@ -104,8 +104,6 @@ int main() {
104104
}
105105
```
106106

107-
**Output**
108-
109107
```Output
110108
pMyClass == nullptr
111109
@@ -172,8 +170,6 @@ int main() {
172170
}
173171
```
174172
175-
**Output**
176-
177173
```Output
178174
test
179175
```
@@ -201,8 +197,6 @@ int main() {
201197
}
202198
```
203199
204-
**Output**
205-
206200
```Output
207201
NULL
208202
```

docs/windows/object-cpp.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Identifies a custom interface.
1717

1818
## Syntax
1919

20-
```
20+
```cpp
2121
[object]
2222
```
2323

docs/windows/odl.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Identifies an interface as an Object Description Language (ODL) interface. The M
1717

1818
## Syntax
1919

20-
```
20+
```cpp
2121
[odl]
2222
```
2323

docs/windows/oleautomation.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Indicates that an interface is compatible with Automation.
1717

1818
## Syntax
1919

20-
```
20+
```cpp
2121
[oleautomation]
2222
```
2323

docs/windows/open-device-image-dialog-box-image-editor-for-icons.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,12 @@ ms.workload: ["cplusplus", "uwp"]
1515
# Open &lt;Device&gt; Image Dialog Box (Image Editor for Icons)
1616
Use this dialog box to open device images. It lists existing device images in the current resource (images that are part of the current resource).
1717

18-
**Current Images**
18+
### Current Images
1919
Lists the images included in the resource. Select the image type you want to open.
2020

2121
## Requirements
2222
None
2323

2424
## See Also
2525
[Image Menu](../windows/image-menu-image-editor-for-icons.md)
26-
[Image Editor for Icons](../windows/image-editor-for-icons.md)
27-
26+
[Image Editor for Icons](../windows/image-editor-for-icons.md)

docs/windows/opening-a-resource-for-binary-editing.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ ms.workload: ["cplusplus", "uwp"]
2323
2. Right-click the resource and click **Open Binary Data** from the shortcut menu.
2424

2525
> [!NOTE]
26-
> If you use the [Resource View](../windows/resource-view-window.md) window to open a resource with a format that Visual Studio does not recognize (such as RCDATA or a custom resource), the resource is automatically opened in the Binary editor.
26+
> If you use the [Resource View](../windows/resource-view-window.md) window to open a resource with a format that Visual Studio does not recognize (such as RCDATA or a custom resource), the resource is automatically opened in the **Binary** editor.
2727
2828
### To open a managed resource for binary editing
2929

@@ -45,10 +45,9 @@ Binary Data for a Dialog Box Displayed in the Binary Editor
4545
Only certain ASCII values are represented in the Binary editor (0x20 through 0x7E). Extended characters are displayed as periods in the ASCII Value section of the Binary editor (the right panel). The "printable" characters are ASCII values 32 through 126.
4646

4747
> [!NOTE]
48-
> If you want to use the Binary editor on a resource already being edited in another editor window, close the other editor window first.
48+
> If you want to use the **Binary** editor on a resource already being edited in another editor window, close the other editor window first.
4949
5050
## Requirements
51-
5251
None
5352

5453
## See Also

docs/windows/opening-the-resource-editor-for-a-given-symbol.md

-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,6 @@ When you are browsing symbols in the [Resource Symbols dialog box](../windows/re
2828
For information on adding resources to managed projects, please see [Resources in Desktop Apps](/dotnet/framework/resources/index) in the *.NET Framework Developer's Guide*.
2929

3030
## Requirements
31-
3231
Win32
3332

3433
## See Also

docs/windows/operator-equality-operator-microsoft-wrl.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Equality operator for [ComPtr](../windows/comptr-class.md) and [ComPtrRef](../wi
1616

1717
## Syntax
1818

19-
```
19+
```cpp
2020
WRL_NOTHROW bool operator==(
2121
const ComPtr<T>& a,
2222
const ComPtr<U>& b

docs/windows/operator-inequality-operator-microsoft-wrl.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Inequality operator for [ComPtr](../windows/comptr-class.md) and [ComPtrRef](../
1616

1717
## Syntax
1818

19-
```
19+
```cpp
2020
WRL_NOTHROW bool operator!=(
2121
const ComPtr<T>& a,
2222
const ComPtr<U>& b

docs/windows/optional-cpp.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Specifies an optional parameter for a member function.
1717

1818
## Syntax
1919

20-
```
20+
```cpp
2121
[optional]
2222
```
2323

docs/windows/out-cpp.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Identifies pointer parameters that are returned from the called procedure to the
1717

1818
## Syntax
1919

20-
```
20+
```cpp
2121
[out]
2222
```
2323

docs/windows/overview-of-windows-programming-in-cpp.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ You can write UWP apps in C++/CX, a dialect of C++, you can use the [C++/WinRT l
2929

3030
This category also includes using C++ for core components and computational code in the context of server and cloud programming. Sometimes the performance-intensive code at the core of a server or cloud application is written in C++ to maximize performance. You can compile such code into a DLL and use it from C# or Visual Basic.
3131

32-
- **.NET Framework applications**. Most .NET Framework applications are written in C# or Visual Basic, but you can also C++/CLI (the /clr compiler option in Visual C++). We recommend using C++/CLI for a minimal interop layer in a larger application that includes managed and native code.
32+
- **.NET Framework applications**. Most .NET Framework applications are written in C# or Visual Basic, but you can also C++/CLI (the `/clr` compiler option in Visual C++). We recommend using C++/CLI for a minimal interop layer in a larger application that includes managed and native code.
3333

3434
## <a name="BK_WindowsUniversal"></a> Windows Universal Apps
3535

docs/windows/picking-up-a-color-from-an-image-to-use-elsewhere-image-editor-for-icons.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -25,14 +25,13 @@ The **Select Color**, or color-pickup, tool makes any color on the image the cur
2525
2. Select the color you want to pick up from the image.
2626

2727
> [!NOTE]
28-
> After you pick up a color, the Image editor reactivates the most recently used tool.
28+
> After you pick up a color, the **Image** editor reactivates the most recently used tool.
2929
3030
3. Draw using the left mouse button for the foreground color, or the right mouse button for the background color.
3131

3232
For information on adding resources to managed projects, please see [Resources in Desktop Apps](/dotnet/framework/resources/index) in the *.NET Framework Developer's Guide*. For information on manually adding resource files to managed projects, accessing resources, displaying static resources, and assigning resource strings to properties, see [Creating Resource Files for Desktop Apps](/dotnet/framework/resources/creating-resource-files-for-desktop-apps). For information on globalization and localization of resources in managed apps, see [Globalizing and Localizing .NET Framework Applications](/dotnet/standard/globalization-localization/index).
3333

3434
## Requirements
35-
3635
None
3736

3837
## See Also

docs/windows/pin-ptr-cpp-cli.md

-6
Original file line numberDiff line numberDiff line change
@@ -131,8 +131,6 @@ int main() {
131131
}
132132
```
133133
134-
**Output**
135-
136134
```Output
137135
45
138136
```
@@ -167,8 +165,6 @@ int main() {
167165
};
168166
```
169167
170-
**Output**
171-
172168
```Output
173169
1
174170
```
@@ -197,8 +193,6 @@ int main() {
197193
}
198194
```
199195
200-
**Output**
201-
202196
```Output
203197
8
204198
255

docs/windows/platform-default-and-cli-namespaces-cpp-component-extensions.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ A namespace qualifies the names of language elements so the names do not conflic
2727
## Common Language Runtime
2828
### Syntax
2929

30-
```
30+
```cpp
3131
using namespace cli;
3232
```
3333

docs/windows/pointer-default.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -17,13 +17,13 @@ Specifies the default pointer attribute for all pointers, except top-level point
1717

1818
## Syntax
1919

20-
```
20+
```cpp
2121
[ pointer_default(
2222
value
2323
) ]
2424
```
2525

26-
#### Parameters
26+
### Parameters
2727
*value*
2828
A value that describes the pointer type: **ptr**, **ref**, or **unique**.
2929

docs/windows/pragma.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -17,13 +17,13 @@ Emits the specified string into the generated .idl file without the use of quota
1717

1818
## Syntax
1919

20-
```
20+
```cpp
2121
[ pragma(
2222
pragma_statement
2323
) ];
2424
```
2525

26-
#### Parameters
26+
### Parameters
2727
*pragma_statement*
2828
The pragma that you want to go into the generated .idl file.
2929

docs/windows/predefined-symbol-ids.md

-2
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,6 @@ When you begin a new project, depending on the project type, some symbol IDs are
2727
> [!NOTE]
2828
> Predefined symbols are always read-only.
2929
30-
31-
3230
## Requirements
3331
Win32, MFC, or ATL
3432

docs/windows/previewing-resources.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -33,22 +33,22 @@ Previewing your resources allows you to view graphical resource without opening
3333

3434
### To preview resources
3535

36-
1. In [Resource View](../windows/resource-view-window.md) or a document window, select your resource, for example, IDD_ABOUTBOX.
36+
1. In [Resource View](../windows/resource-view-window.md) or a document window, select your resource, for example, **IDD_ABOUTBOX**.
3737

38-
**Note** If your project doesn't already contain an .rc file, please see [Creating a New Resource Script File](../windows/how-to-create-a-resource-script-file.md).
38+
> [!NOTE]
39+
> If your project doesn't already contain an .rc file, please see [Creating a New Resource Script File](../windows/how-to-create-a-resource-script-file.md).
3940
4041
2. In the [Properties window](/visualstudio/ide/reference/properties-window), click the **Property Pages** button.
4142

4243
\- or -
4344

4445
3. On the **View** menu, click **Property Pages**.
4546

46-
The Property Page for the resource opens displaying a preview of that resource. You can then use the Up and Down arrow keys to navigate the tree control in Resource View or the document window. The Property Page will stay open and show any resource that has focus and is able to be previewed.
47+
The **Property Page** for the resource opens displaying a preview of that resource. You can then use the **Up** and **Down** arrow keys to navigate the tree control in **Resource View** or the document window. The **Property Page** will stay open and show any resource that has focus and is able to be previewed.
4748

4849
For information on adding resources to managed projects, please see [Resources in Desktop Apps](/dotnet/framework/resources/index) in the *.NET Framework Developer's Guide*. For information on manually adding resource files to managed projects, accessing resources, displaying static resources, and assigning resource strings to properties, see [Creating Resource Files for Desktop Apps](/dotnet/framework/resources/creating-resource-files-for-desktop-apps). For information on globalization and localization of resources in managed apps, see [Globalizing and Localizing .NET Framework Applications](/dotnet/standard/globalization-localization/index).
4950

5051
## Requirements
51-
5252
Win32
5353

5454
## See Also

0 commit comments

Comments
 (0)