Skip to content

Commit f751015

Browse files
author
mtx48109
committed
windows formatting review pr10
1 parent 37503f8 commit f751015

30 files changed

+489
-508
lines changed

docs/windows/hstring-makereference-method.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ ms.author: "mblome"
1212
ms.workload: ["cplusplus", "uwp"]
1313
---
1414
# HString::MakeReference Method
15-
Creates an HStringReference object from a specified string parameter.
15+
Creates an `HStringReference` object from a specified string parameter.
1616

1717
## Syntax
1818

@@ -27,18 +27,18 @@ template<unsigned int sizeDest>
2727
unsigned int len);
2828
```
2929

30-
#### Parameters
31-
`sizeDest`
32-
A template parameter that specifies the size of the destination HStringReference buffer.
30+
### Parameters
31+
*sizeDest*
32+
A template parameter that specifies the size of the destination `HStringReference` buffer.
3333

34-
`str`
34+
*str*
3535
A reference to a wide-character string.
3636

37-
`len`
38-
The maximum length of the `str` parameter buffer to use in this operation. If the `len` parameter isn't specified, the entire `str` parameter is used.
37+
*len*
38+
The maximum length of the *str* parameter buffer to use in this operation. If the *len* parameter isn't specified, the entire *str* parameter is used.
3939

4040
## Return Value
41-
An HStringReference object whose value is the same as the specified `str` parameter.
41+
An `HStringReference` object whose value is the same as the specified *str* parameter.
4242

4343
## Requirements
4444
**Header:** corewrappers.h

docs/windows/hstring-operator-assign-operator.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,20 +12,20 @@ ms.author: "mblome"
1212
ms.workload: ["cplusplus", "uwp"]
1313
---
1414
# HString::Operator= Operator
15-
Moves the value of another HString object to the current HString object.
15+
Moves the value of another **HString** object to the current **HString** object.
1616

1717
## Syntax
1818

1919
```cpp
2020
HString& operator=(HString&& other) throw()
2121
```
2222

23-
#### Parameters
24-
`other`
25-
An existing HString object.
23+
### Parameters
24+
*other*
25+
An existing **HString** object.
2626

2727
## Remarks
28-
The value of the existing `other` object is copied to the current HString object, and then the `other` object is destroyed.
28+
The value of the existing *other* object is copied to the current **HString** object, and then the *other* object is destroyed.
2929

3030
## Requirements
3131
**Header:** corewrappers.h

docs/windows/hstring-operator-equality-operator.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -36,18 +36,17 @@ inline bool operator==(
3636
inline bool operator==(
3737
const HString& lhs,
3838
const HSTRING& rhs) throw()
39-
4039
```
4140

42-
#### Parameters
43-
`lhs`
44-
The first parameter to compare. `lhs` can be an HString or HStringReference object, or an HSTRING handle.
41+
### Parameters
42+
*lhs*
43+
The first parameter to compare. *lhs* can be an **HString** or `HStringReference` object, or an HSTRING handle.
4544

46-
`rhs`
47-
The second parameter to compare.`rhs` can be an HString or HStringReference object, or an HSTRING handle.
45+
*rhs*
46+
The second parameter to compare.*rhs* can be an **HString** or `HStringReference` object, or an HSTRING handle.
4847

4948
## Return Value
50-
`true` if the `lhs` and `rhs` parameters are equal; otherwise, `false`.
49+
**true** if the *lhs* and *rhs* parameters are equal; otherwise, **false**.
5150

5251
## Requirements
5352
**Header:** corewrappers.h

docs/windows/hstring-operator-inequality-operator.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -34,14 +34,14 @@ inline bool operator!=( const HString& lhs,
3434
```
3535

3636
#### Parameters
37-
`lhs`
38-
The first parameter to compare. `lhs` can be an HString or HStringReference object, or an HSTRING handle.
37+
*lhs*
38+
The first parameter to compare. *lhs* can be an **HString** or `HStringReference` object, or an HSTRING handle.
3939

40-
`rhs`
41-
The second parameter to compare.`rhs` can be an HString or HStringReference object, or an HSTRING handle.
40+
*rhs*
41+
The second parameter to compare.*rhs* can be an **HString** or `HStringReference` object, or an HSTRING handle.
4242

4343
## Return Value
44-
`true` if the `lhs` and `rhs` parameters are not equal; otherwise, `false`.
44+
**true** if the *lhs* and *rhs* parameters are not equal; otherwise, **false**.
4545

4646
## Requirements
4747
**Header:** corewrappers.h

docs/windows/hstring-operator-less-than-operator.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -20,18 +20,17 @@ Indicates whether the first parameter is less than the second parameter.
2020
inline bool operator<(
2121
const HString& lhs,
2222
const HString& rhs) throw()
23-
2423
```
2524

2625
#### Parameters
27-
`lhs`
28-
The first parameter to compare. `lhs` can be a reference to an HString.
26+
*lhs*
27+
The first parameter to compare. *lhs* can be a reference to an **HString**.
2928

30-
`rhs`
31-
The second parameter to compare. `rhs` can be a reference to an HString.
29+
*rhs*
30+
The second parameter to compare. *rhs* can be a reference to an **HString**.
3231

3332
## Return Value
34-
`true` if the `lhs` parameter is less than the `rhs` parameter; otherwise, `false`.
33+
**true** if the *lhs* parameter is less than the *rhs* parameter; otherwise, **false**.
3534

3635
## Requirements
3736
**Header:** corewrappers.h

docs/windows/hstring-release-method.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ ms.author: "mblome"
1212
ms.workload: ["cplusplus", "uwp"]
1313
---
1414
# HString::Release Method
15-
Deletes the underlying string value and intializes the current HString object to an empty value.
15+
Deletes the underlying string value and intializes the current **HString** object to an empty value.
1616

1717
## Syntax
1818

docs/windows/hstring-set-method.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,11 @@ ms.author: "mblome"
1212
ms.workload: ["cplusplus", "uwp"]
1313
---
1414
# HString::Set Method
15-
Sets the value of the current HString object to the specified wide-character string or HString parameter.
15+
Sets the value of the current **HString** object to the specified wide-character string or **HString** parameter.
1616

1717
## Syntax
1818

1919
```
20-
2120
HRESULT Set(
2221
const wchar_t* str) throw();
2322
HRESULT Set(
@@ -29,15 +28,15 @@ HRESULT Set(
2928
) throw();
3029
```
3130

32-
#### Parameters
33-
`str`
31+
### Parameters
32+
*str*
3433
A wide-character string.
3534

36-
`len`
37-
The maximum length of the `str` parameter that is assigned to the current HString object.
35+
*len*
36+
The maximum length of the *str* parameter that is assigned to the current **HString** object.
3837

39-
`hstr`
40-
An existing HString object.
38+
*hstr*
39+
An existing **HString** object.
4140

4241
## Requirements
4342
**Header:** corewrappers.h

docs/windows/hstring-tilde-hstring-destructor.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ ms.author: "mblome"
1212
ms.workload: ["cplusplus", "uwp"]
1313
---
1414
# HString::~HString Destructor
15-
Destroys the current instance of the HString class.
15+
Destroys the current instance of the **HString** class.
1616

1717
## Syntax
1818

docs/windows/hstringreference-class.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,28 +21,28 @@ class HStringReference;
2121
```
2222

2323
## Remarks
24-
The lifetime of the backing buffer in the new HSTRING is not managed by the Windows Runtime. The caller allocates a source string on the stack frame to avoid a heap allocation and to eliminate the risk of a memory leak. Also, the caller must ensure that source string remains unchanged during the lifetime of the attached HSTRING. For more information, see [WindowsCreateStringReference function](http://msdn.microsoft.com/en-us/0361bb7e-da49-4289-a93e-de7aab8712ac).
24+
The lifetime of the backing buffer in the new HSTRING is not managed by the Windows Runtime. The caller allocates a source string on the stack frame to avoid a heap allocation and to eliminate the risk of a memory leak. Also, the caller must ensure that source string remains unchanged during the lifetime of the attached HSTRING. For more information, see [WindowsCreateStringReference function](http://msdn.microsoft.com/0361bb7e-da49-4289-a93e-de7aab8712ac).
2525

2626
## Members
2727

2828
### Public Constructors
2929

3030
|Name|Description|
3131
|----------|-----------------|
32-
|[HStringReference::HStringReference Constructor](../windows/hstringreference-hstringreference-constructor.md)|Initializes a new instance of the HStringReference class.|
32+
|[HStringReference::HStringReference Constructor](../windows/hstringreference-hstringreference-constructor.md)|Initializes a new instance of the **HStringReference** class.|
3333

3434
### Members
3535

3636
|Member|Description|
3737
|------------|-----------------|
38-
|[HStringReference::CopyTo Method](../windows/hstringreference-copyto-method.md)|Copies the current HStringReference object to an HSTRING object.|
38+
|[HStringReference::CopyTo Method](../windows/hstringreference-copyto-method.md)|Copies the current **HStringReference** object to an HSTRING object.|
3939
|[HStringReference::Get Method](../windows/hstringreference-get-method.md)|Retrieves the value of the underlying HSTRING handle.|
4040

4141
### Public Operators
4242

4343
|Name|Description|
4444
|----------|-----------------|
45-
|[HStringReference::Operator= Operator](../windows/hstringreference-operator-assign-operator.md)|Moves the value of another HStringReference object to the current HStringReference object.|
45+
|[HStringReference::Operator= Operator](../windows/hstringreference-operator-assign-operator.md)|Moves the value of another **HStringReference** object to the current **HStringReference** object.|
4646
|[HStringReference::Operator== Operator](../windows/hstringreference-operator-equality-operator.md)|Indicates whether the two parameters are equal.|
4747
|[HStringReference::Operator!= Operator](../windows/hstringreference-operator-inequality-operator.md)|Indicates whether the two parameters are not equal.|
4848

docs/windows/hstringreference-copyto-method.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,19 +11,18 @@ ms.author: "mblome"
1111
ms.workload: ["cplusplus", "uwp"]
1212
---
1313
# HStringReference::CopyTo Method
14-
Copies the current HStringReference object to an HSTRING object.
14+
Copies the current **HStringReference** object to an HSTRING object.
1515

1616
## Syntax
1717

1818
```
19-
2019
HRESULT CopyTo(
2120
_Out_ HSTRING *str
2221
) const throw();
2322
```
2423

2524
#### Parameters
26-
`str`
25+
*str*
2726
The HSTRING that receives the copy.
2827

2928
## Remarks

docs/windows/hstringreference-hstringreference-constructor.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ ms.author: "mblome"
1212
ms.workload: ["cplusplus", "uwp"]
1313
---
1414
# HStringReference::HStringReference Constructor
15-
Initializes a new instance of the HStringReference class.
15+
Initializes a new instance of the **HStringReference** class.
1616

1717
## Syntax
1818

@@ -27,25 +27,25 @@ HStringReference(wchar_t const (&str)[ sizeDest],
2727
HStringReference(HStringReference&& other) throw();
2828
```
2929
30-
#### Parameters
31-
`sizeDest`
32-
A template parameter that specifies the size of the destination HStringReference buffer.
30+
### Parameters
31+
*sizeDest*
32+
A template parameter that specifies the size of the destination **HStringReference** buffer.
3333
34-
`str`
34+
*str*
3535
A reference to a wide-character string.
3636
37-
`len`
38-
The maximum length of the `str` parameter buffer to use in this operation. If the `len` parameter isn't specified, the entire `str` parameter is used. If `len` is greater than `sizeDest`, `len` is set to `sizeDest`-1.
37+
*len*
38+
The maximum length of the *str* parameter buffer to use in this operation. If the *len* parameter isn't specified, the entire *str* parameter is used. If *len* is greater than *sizeDest*, *len* is set to *sizeDest*-1.
3939
40-
`other`
41-
Another HStringReference object.
40+
*other*
41+
Another **HStringReference** object.
4242
4343
## Remarks
44-
The first constructor initializes a new HStringReference object that the same size as parameter `str`.
44+
The first constructor initializes a new **HStringReference** object that the same size as parameter *str*.
4545
46-
The second constructor initializes a new HStringReference object that the size specifeid by parameter `len`.
46+
The second constructor initializes a new **HStringReference** object that the size specifeid by parameter *len*.
4747
48-
The third constructor initializes a new HStringReference object to the value of the `other` parameter, and then destroys the `other` parameter.
48+
The third constructor initializes a new **HStringReference** object to the value of the *other* parameter, and then destroys the *other* parameter.
4949
5050
## Requirements
5151
**Header:** corewrappers.h

docs/windows/hstringreference-operator-assign-operator.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,20 +12,20 @@ ms.author: "mblome"
1212
ms.workload: ["cplusplus", "uwp"]
1313
---
1414
# HStringReference::Operator= Operator
15-
Moves the value of another HStringReference object to the current HStringReference object.
15+
Moves the value of another **HStringReference** object to the current **HStringReference** object.
1616

1717
## Syntax
1818

1919
```cpp
2020
HStringReference& operator=(HStringReference&& other) throw()
2121
```
2222

23-
#### Parameters
24-
`other`
25-
An existing HStringReference object.
23+
### Parameters
24+
*other*
25+
An existing **HStringReference** object.
2626

2727
## Remarks
28-
The value of the existing `other` object is copied to the current HStringReference object, and then the `other` object is destroyed.
28+
The value of the existing *other* object is copied to the current **HStringReference** object, and then the *other* object is destroyed.
2929

3030
## Requirements
3131
**Header:** corewrappers.h

docs/windows/hstringreference-operator-equality-operator.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -28,18 +28,17 @@ inline bool operator==(
2828
inline bool operator==(
2929
const HStringReference& lhs,
3030
const HSTRING& rhs) throw()
31-
3231
```
3332

34-
#### Parameters
35-
`lhs`
36-
The first parameter to compare. `lhs` can be an HStringReference object or an HSTRING handle.
33+
### Parameters
34+
*lhs*
35+
The first parameter to compare. *lhs* can be an **HStringReference** object or an HSTRING handle.
3736

38-
`rhs`
39-
The second parameter to compare. `rhs` can be an HStringReference object or an HSTRING handle.
37+
*rhs*
38+
The second parameter to compare. *rhs* can be an **HStringReference** object or an HSTRING handle.
4039

4140
## Return Value
42-
`true` if the `lhs` and `rhs` parameters are equal; otherwise, `false`.
41+
**true** if the *lhs* and *rhs* parameters are equal; otherwise, **false**.
4342

4443
## Requirements
4544
**Header:** corewrappers.h

docs/windows/hstringreference-operator-inequality-operator.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -32,18 +32,17 @@ inline bool operator!=(
3232
inline bool operator!=(
3333
const HStringReference& lhs,
3434
const HSTRING& rhs) throw()
35-
3635
```
3736

38-
#### Parameters
39-
`lhs`
40-
The first parameter to compare. `lhs` can be an HStringReference object or an HSTRING handle.
37+
### Parameters
38+
*lhs*
39+
The first parameter to compare. *lhs* can be an **HStringReference** object or an HSTRING handle.
4140

42-
`rhs`
43-
The second parameter to compare. `rhs` can be an HStringReference object or an HSTRING handle.
41+
*rhs*
42+
The second parameter to compare. *rhs* can be an **HStringReference** object or an HSTRING handle.
4443

4544
## Return Value
46-
`true` if the `lhs` and `rhs` parameters are not equal; otherwise, `false`.
45+
**true** if the *lhs* and *rhs* parameters are not equal; otherwise, **false**.
4746

4847
## Requirements
4948
**Header:** corewrappers.h

docs/windows/hstringreference-operator-less-than-operator.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -22,15 +22,15 @@ inline bool operator<(
2222
const HStringReference& rhs) throw()
2323
```
2424

25-
#### Parameters
26-
`lhs`
27-
The first parameter to compare. `lhs` can be a reference to an HStringReference.
25+
### Parameters
26+
*lhs*
27+
The first parameter to compare. *lhs* can be a reference to an **HStringReference**.
2828

29-
`rhs`
30-
The second parameter to compare. `rhs` can be a reference to an HStringReference.
29+
*rhs*
30+
The second parameter to compare. *rhs* can be a reference to an **HStringReference**.
3131

3232
## Return Value
33-
`true` if the `lhs` parameter is less than the `rhs` parameter; otherwise, `false`.
33+
**true** if the *lhs* parameter is less than the *rhs* parameter; otherwise, **false**.
3434

3535
## Requirements
3636
**Header:** corewrappers.h

docs/windows/icons-and-cursors-image-resources-for-display-devices-image-editor-for-icons.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -54,13 +54,12 @@ Icons and cursors are graphical resources that can contain multiple images in di
5454

5555
- [Setting a Cursor's Hot Spot](../windows/setting-a-cursor-s-hot-spot-image-editor-for-icons.md)
5656

57-
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).
57+
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).
5858

5959
## Requirements
6060
None
6161

6262
## See Also
6363
[Image Editor for Icons](../windows/image-editor-for-icons.md)
6464
[Icons](http://msdn.microsoft.com/library/windows/desktop/ms646973)
65-
[Cursors](http://msdn.microsoft.com/library/windows/desktop/ms646970)
66-
65+
[Cursors](http://msdn.microsoft.com/library/windows/desktop/ms646970)

0 commit comments

Comments
 (0)