Skip to content

Commit 2efce86

Browse files
author
mtx48109
committed
windows formatting review pr4
1 parent 33871b0 commit 2efce86

30 files changed

Lines changed: 127 additions & 129 deletions

‎docs/windows/comptr-asiid-method.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ ms.author: "mblome"
1313
ms.workload: ["cplusplus", "uwp"]
1414
---
1515
# ComPtr::AsIID Method
16-
Returns a ComPtr object that represents the interface identified by the specified interface ID.
16+
Returns a **ComPtr** object that represents the interface identified by the specified interface ID.
1717

1818
## Syntax
1919

@@ -25,11 +25,11 @@ WRL_NOTHROW HRESULT AsIID(
2525
```
2626

2727
#### Parameters
28-
`riid`
28+
*riid*
2929
An interface ID.
3030

31-
`p`
32-
If the object has an interface whose ID equals `riid`, a doubly-indirect pointer to the interface specified by the `riid` parameter; otherwise, a pointer to IUnknown.
31+
*p*
32+
If the object has an interface whose ID equals *riid*, a doubly-indirect pointer to the interface specified by the *riid* parameter; otherwise, a pointer to `IUnknown`.
3333

3434
## Return Value
3535
S_OK if successful; otherwise, an HRESULT that indicates the error.

‎docs/windows/comptr-asweak-method.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ HRESULT AsWeak(
2424
```
2525

2626
#### Parameters
27-
`pWeakRef`
27+
*pWeakRef*
2828
When this operation completes, a pointer to a weak reference object.
2929

3030
## Return Value

‎docs/windows/comptr-attach-method.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ ms.author: "mblome"
1313
ms.workload: ["cplusplus", "uwp"]
1414
---
1515
# ComPtr::Attach Method
16-
Associates this ComPtr with the interface type specified by the current template type parameter.
16+
Associates this **ComPtr** with the interface type specified by the current template type parameter.
1717

1818
## Syntax
1919

@@ -24,7 +24,7 @@ void Attach(
2424
```
2525

2626
#### Parameters
27-
`other`
27+
*other*
2828
An interface type.
2929

3030
## Requirements

‎docs/windows/comptr-class.md‎

Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ ms.author: "mblome"
1313
ms.workload: ["cplusplus", "uwp"]
1414
---
1515
# ComPtr Class
16-
Creates a *smart pointer* type that represents the interface specified by the template parameter. ComPtr automatically maintains a reference count for the underlying interface pointer and releases the interface when the reference count goes to zero.
16+
Creates a *smart pointer* type that represents the interface specified by the template parameter. **ComPtr** automatically maintains a reference count for the underlying interface pointer and releases the interface when the reference count goes to zero.
1717

1818
## Syntax
1919

@@ -26,71 +26,71 @@ friend class ComPtr;
2626
```
2727

2828
#### Parameters
29-
`T`
30-
The interface that the ComPtr represents.
29+
*T*
30+
The interface that the **ComPtr** represents.
3131

32-
`U`
33-
A class to which the current ComPtr is a friend. (The template that uses this parameter is protected.)
32+
*U*
33+
A class to which the current **ComPtr** is a friend. (The template that uses this parameter is protected.)
3434

3535
## Remarks
36-
ComPtr<> declares a type that represents the underlying interface pointer. Use ComPtr<> to declare a variable and then use the arrow member-access operator (`->`) to access an interface member function.
36+
`ComPtr<>` declares a type that represents the underlying interface pointer. Use `ComPtr<>` to declare a variable and then use the arrow member-access operator (`->`) to access an interface member function.
3737

38-
For more information about smart pointers, see the "COM Smart Pointers" subsection of the [COM Coding Practices](http://msdn.microsoft.com/en-us/76aca556-b4d6-4e67-a2a3-4439900f0c39)topic in the MSDN Library.
38+
For more information about smart pointers, see the "COM Smart Pointers" subsection of the [COM Coding Practices](http://msdn.microsoft.com/76aca556-b4d6-4e67-a2a3-4439900f0c39)topic in the MSDN Library.
3939

4040
## Members
4141

4242
### Public Typedefs
4343

4444
|Name|Description|
4545
|----------|-----------------|
46-
|`InterfaceType`|A synonym for the type specified by the `T` template parameter.|
46+
|`InterfaceType`|A synonym for the type specified by the *T* template parameter.|
4747

4848
### Public Constructors
4949

5050
|Name|Description|
5151
|----------|-----------------|
52-
|[ComPtr::ComPtr Constructor](../windows/comptr-comptr-constructor.md)|Intializes a new instance of the ComPtr class. Overloads provide default, copy, move, and conversion constructors.|
53-
|[ComPtr::~ComPtr Destructor](../windows/comptr-tilde-comptr-destructor.md)|Deinitializes an instance of ComPtr.|
52+
|[ComPtr::ComPtr Constructor](../windows/comptr-comptr-constructor.md)|Intializes a new instance of the **ComPtr** class. Overloads provide default, copy, move, and conversion constructors.|
53+
|[ComPtr::~ComPtr Destructor](../windows/comptr-tilde-comptr-destructor.md)|Deinitializes an instance of **ComPtr**.|
5454

5555
### Public Methods
5656

5757
|Name|Description|
5858
|----------|-----------------|
59-
|[ComPtr::As Method](../windows/comptr-as-method.md)|Returns a ComPtr object that represents the interface identified by the specified template parameter.|
60-
|[ComPtr::AsIID Method](../windows/comptr-asiid-method.md)|Returns a ComPtr object that represents the interface identified by the specified interface ID.|
59+
|[ComPtr::As Method](../windows/comptr-as-method.md)|Returns a **ComPtr** object that represents the interface identified by the specified template parameter.|
60+
|[ComPtr::AsIID Method](../windows/comptr-asiid-method.md)|Returns a **ComPtr** object that represents the interface identified by the specified interface ID.|
6161
|[ComPtr::AsWeak Method](../windows/comptr-asweak-method.md)|Retrieves a weak reference to the current object.|
62-
|[ComPtr::Attach Method](../windows/comptr-attach-method.md)|Associates this ComPtr with the interface type specified by the current template type parameter.|
63-
|[ComPtr::CopyTo Method](../windows/comptr-copyto-method.md)|Copies the current or specified interface associated with this ComPtr to the specified output pointer.|
64-
|[ComPtr::Detach Method](../windows/comptr-detach-method.md)|Disassociates this ComPtr from the interface that it represents.|
65-
|[ComPtr::Get Method](../windows/comptr-get-method.md)|Retrieves a pointer to the interface that is associated with this ComPtr.|
66-
|[ComPtr::GetAddressOf Method](../windows/comptr-getaddressof-method.md)|Retrieves the address of the [ptr_](../windows/comptr-ptr-data-member.md) data member, which contains a pointer to the interface represented by this ComPtr.|
67-
|[ComPtr::ReleaseAndGetAddressOf Method](../windows/comptr-releaseandgetaddressof-method.md)|Releases the interface associated with this ComPtr and then retrieves the address of the [ptr_](../windows/comptr-ptr-data-member.md) data member, which contains a pointer to the interface that was released.|
68-
|[ComPtr::Reset](../windows/comptr-reset.md)|Releases all references for the pointer to the interface that is associated with this ComPtr.|
69-
|[ComPtr::Swap Method](../windows/comptr-swap-method.md)|Exchanges the interface managed by the current ComPtr with the interface managed by the specified ComPtr.|
62+
|[ComPtr::Attach Method](../windows/comptr-attach-method.md)|Associates this **ComPtr** with the interface type specified by the current template type parameter.|
63+
|[ComPtr::CopyTo Method](../windows/comptr-copyto-method.md)|Copies the current or specified interface associated with this **ComPtr** to the specified output pointer.|
64+
|[ComPtr::Detach Method](../windows/comptr-detach-method.md)|Disassociates this **ComPtr** from the interface that it represents.|
65+
|[ComPtr::Get Method](../windows/comptr-get-method.md)|Retrieves a pointer to the interface that is associated with this **ComPtr**.|
66+
|[ComPtr::GetAddressOf Method](../windows/comptr-getaddressof-method.md)|Retrieves the address of the [ptr_](../windows/comptr-ptr-data-member.md) data member, which contains a pointer to the interface represented by this **ComPtr**.|
67+
|[ComPtr::ReleaseAndGetAddressOf Method](../windows/comptr-releaseandgetaddressof-method.md)|Releases the interface associated with this **ComPtr** and then retrieves the address of the [ptr_](../windows/comptr-ptr-data-member.md) data member, which contains a pointer to the interface that was released.|
68+
|[ComPtr::Reset](../windows/comptr-reset.md)|Releases all references for the pointer to the interface that is associated with this **ComPtr**.|
69+
|[ComPtr::Swap Method](../windows/comptr-swap-method.md)|Exchanges the interface managed by the current **ComPtr** with the interface managed by the specified **ComPtr**.|
7070

7171
### Protected Methods
7272

7373
|Name|Description|
7474
|----------|-----------------|
75-
|[ComPtr::InternalAddRef Method](../windows/comptr-internaladdref-method.md)|Increments the reference count of the interface associated with this ComPtr.|
76-
|[ComPtr::InternalRelease Method](../windows/comptr-internalrelease-method.md)|Performs a COM Release operation on the interface associated with this ComPtr.|
75+
|[ComPtr::InternalAddRef Method](../windows/comptr-internaladdref-method.md)|Increments the reference count of the interface associated with this **ComPtr**.|
76+
|[ComPtr::InternalRelease Method](../windows/comptr-internalrelease-method.md)|Performs a COM Release operation on the interface associated with this **ComPtr**.|
7777

7878
### Public Operators
7979

8080
|Name|Description|
8181
|----------|-----------------|
82-
|[ComPtr::operator Microsoft::WRL::Details::BoolType Operator](../windows/comptr-operator-microsoft-wrl-details-booltype-operator.md)|Indicates whether or not a ComPtr is managing the object lifetime of an interface.|
83-
|[ComPtr::operator& Operator](../windows/comptr-operator-ampersand-operator.md)|Retrieves the address of the current ComPtr.|
84-
|[ComPtr::operator= Operator](../windows/comptr-operator-assign-operator.md)|Assigns a value to the current ComPtr.|
82+
|[ComPtr::operator Microsoft::WRL::Details::BoolType Operator](../windows/comptr-operator-microsoft-wrl-details-booltype-operator.md)|Indicates whether or not a **ComPtr** is managing the object lifetime of an interface.|
83+
|[ComPtr::operator& Operator](../windows/comptr-operator-ampersand-operator.md)|Retrieves the address of the current **ComPtr**.|
84+
|[ComPtr::operator= Operator](../windows/comptr-operator-assign-operator.md)|Assigns a value to the current **ComPtr**.|
8585
|[ComPtr::operator-> Operator](../windows/comptr-operator-arrow-operator.md)|Retrieves a pointer to the type specified by the current template parameter.|
86-
|[ComPtr::operator== Operator](../windows/comptr-operator-equality-operator.md)|Indicates whether two ComPtr objects are equal.|
87-
|[ComPtr::operator!= Operator](../windows/comptr-operator-inequality-operator.md)|Indicates whether two ComPtr objects are not equal.|
86+
|[ComPtr::operator== Operator](../windows/comptr-operator-equality-operator.md)|Indicates whether two **ComPtr** objects are equal.|
87+
|[ComPtr::operator!= Operator](../windows/comptr-operator-inequality-operator.md)|Indicates whether two **ComPtr** objects are not equal.|
8888

8989
### Protected Data Members
9090

9191
|Name|Description|
9292
|----------|-----------------|
93-
|[ComPtr::ptr_ Data Member](../windows/comptr-ptr-data-member.md)|Contains a pointer to the interface that is associated with, and managed by this ComPtr.|
93+
|[ComPtr::ptr_ Data Member](../windows/comptr-ptr-data-member.md)|Contains a pointer to the interface that is associated with, and managed by this **ComPtr**.|
9494

9595
## Inheritance Hierarchy
9696
`ComPtr`

‎docs/windows/comptr-comptr-constructor.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ ms.author: "mblome"
1313
ms.workload: ["cplusplus", "uwp"]
1414
---
1515
# ComPtr::ComPtr Constructor
16-
Intializes a new instance of the ComPtr class. Overloads provide default, copy, move, and conversion constructors.
16+
Intializes a new instance of the **ComPtr** class. Overloads provide default, copy, move, and conversion constructors.
1717

1818
## Syntax
1919

@@ -47,11 +47,11 @@ WRL_NOTHROW ComPtr(
4747
```
4848

4949
#### Parameters
50-
`U`
51-
The type of the `other` parameter.
50+
*U*
51+
The type of the *other* parameter.
5252

53-
`other`
54-
An object of type `U`.
53+
*other*
54+
An object of type *U*.
5555

5656
## Return Value
5757

‎docs/windows/comptr-copyto-method.md‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ ms.author: "mblome"
1313
ms.workload: ["cplusplus", "uwp"]
1414
---
1515
# ComPtr::CopyTo Method
16-
Copies the current or specified interface associated with this ComPtr to the specified pointer.
16+
Copies the current or specified interface associated with this **ComPtr** to the specified pointer.
1717

1818
## Syntax
1919

@@ -34,24 +34,24 @@ HRESULT CopyTo(
3434
```
3535

3636
#### Parameters
37-
`U`
37+
*U*
3838
A type name.
3939

40-
`ptr`
40+
*ptr*
4141
When this operation completes, a pointer to the requested interface.
4242

43-
`riid`
43+
*riid*
4444
An interface ID.
4545

4646
## Return Value
47-
S_OK if successful; otherwise, an HRESULT that indicates why the implicit QueryInterface operation failed.
47+
S_OK if successful; otherwise, an HRESULT that indicates why the implicit `QueryInterface` operation failed.
4848

4949
## Remarks
50-
The first function returns a copy of a pointer to the interface associated with this ComPtr. This function always returns S_OK.
50+
The first function returns a copy of a pointer to the interface associated with this **ComPtr**. This function always returns S_OK.
5151

52-
The second function performs a QueryInterface operation on the interface associated with this ComPtr for the interface specified by the `riid` parameter.
52+
The second function performs a `QueryInterface` operation on the interface associated with this **ComPtr** for the interface specified by the *riid* parameter.
5353

54-
The third function performs a QueryInterface operation on the interface associated with this ComPtr for the underlying interface of the `U` parameter.
54+
The third function performs a `QueryInterface` operation on the interface associated with this **ComPtr** for the underlying interface of the *U* parameter.
5555

5656
## Requirements
5757
**Header:** client.h

‎docs/windows/comptr-detach-method.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ ms.author: "mblome"
1313
ms.workload: ["cplusplus", "uwp"]
1414
---
1515
# ComPtr::Detach Method
16-
Disassociates this `ComPtr` object from the interface that it represents.
16+
Disassociates this **ComPtr** object from the interface that it represents.
1717

1818
## Syntax
1919

@@ -22,7 +22,7 @@ T* Detach();
2222
```
2323

2424
## Return Value
25-
A pointer to the interface that was represented by this `ComPtr` object.
25+
A pointer to the interface that was represented by this **ComPtr** object.
2626

2727
## Requirements
2828
**Header:** client.h

‎docs/windows/comptr-get-method.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ ms.author: "mblome"
1313
ms.workload: ["cplusplus", "uwp"]
1414
---
1515
# ComPtr::Get Method
16-
Retrieves a pointer to the interface that is associated with this ComPtr.
16+
Retrieves a pointer to the interface that is associated with this **ComPtr**.
1717

1818
## Syntax
1919

@@ -22,7 +22,7 @@ T* Get() const;
2222
```
2323

2424
## Return Value
25-
Pointer to the interface that is associated with this ComPtr.
25+
Pointer to the interface that is associated with this **ComPtr**.
2626

2727
## Requirements
2828
**Header:** client.h

‎docs/windows/comptr-getaddressof-method.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ ms.author: "mblome"
1313
ms.workload: ["cplusplus", "uwp"]
1414
---
1515
# ComPtr::GetAddressOf Method
16-
Retrieves the address of the [ptr_](../windows/comptr-ptr-data-member.md) data member, which contains a pointer to the interface represented by this ComPtr.
16+
Retrieves the address of the [ptr_](../windows/comptr-ptr-data-member.md) data member, which contains a pointer to the interface represented by this **ComPtr**.
1717

1818
## Syntax
1919

‎docs/windows/comptr-internaladdref-method.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ ms.author: "mblome"
1313
ms.workload: ["cplusplus", "uwp"]
1414
---
1515
# ComPtr::InternalAddRef Method
16-
Increments the reference count of the interface associated with this ComPtr.
16+
Increments the reference count of the interface associated with this **ComPtr**.
1717

1818
## Syntax
1919

0 commit comments

Comments
 (0)