Skip to content

Commit 66ffc8a

Browse files
author
mtx48109
committed
format cpp pr2
1 parent 8fc0df5 commit 66ffc8a

30 files changed

+122
-122
lines changed

docs/cpp/bstr-t-operator-logical-not.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ ms.workload: ["cplusplus"]
1515
# _bstr_t::operator !
1616
**Microsoft Specific**
1717

18-
Checks if the encapsulated `BSTR` is a **NULL** string.
18+
Checks if the encapsulated `BSTR` is a NULL string.
1919

2020
## Syntax
2121

@@ -26,7 +26,7 @@ bool operator!( ) const throw( );
2626
```
2727

2828
## Return Value
29-
It returns **true** if yes, **false** if not.
29+
It returns TRUE if yes, FALSE if not.
3030

3131
**END Microsoft Specific**
3232

docs/cpp/bstr-t-relational-operators.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ bool operator>=(const _bstr_t& str) const throw( );
3131
```
3232

3333
## Remarks
34-
These operators compare two `_bstr_t` objects lexicographically. The operators return **true** if the comparisons hold, otherwise return **false**.
34+
These operators compare two `_bstr_t` objects lexicographically. The operators return TRUE if the comparisons hold, otherwise return FALSE.
3535

3636
**END Microsoft Specific**
3737

docs/cpp/casting-operators.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ There are several casting operators specific to the C++ language. These operator
1818

1919
- [static_cast](../cpp/static-cast-operator.md) Used for conversion of nonpolymorphic types.
2020

21-
- [const_cast](../cpp/const-cast-operator.md) Used to remove the `const`, `volatile`, and `__unaligned` attributes.
21+
- [const_cast](../cpp/const-cast-operator.md) Used to remove the **const**, **volatile**, and **__unaligned** attributes.
2222

2323
- [reinterpret_cast](../cpp/reinterpret-cast-operator.md) Used for simple reinterpretation of bits.
2424

docs/cpp/class-cpp.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ ms.author: "mblome"
1313
ms.workload: ["cplusplus"]
1414
---
1515
# class (C++)
16-
The `class` keyword declares a class type or defines an object of a class type.
16+
The **class** keyword declares a class type or defines an object of a class type.
1717

1818
## Syntax
1919

@@ -28,26 +28,26 @@ class [ms-decl-spec] [tag [: base-list ]]
2828
```
2929

3030
#### Parameters
31-
`template-spec`
31+
*template-spec*
3232
Optional template specifications. For more information, refer to [Templates](templates-cpp.md).
3333

34-
`class`
35-
The `class` keyword.
34+
*class*
35+
The **class** keyword.
3636

37-
`ms-decl-spec`
37+
*ms-decl-spec*
3838
Optional storage-class specification. For more information, refer to the [__declspec](../cpp/declspec.md) keyword.
3939

40-
`tag`
40+
*tag*
4141
The type name given to the class. The tag becomes a reserved word within the scope of the class. The tag is optional. If omitted, an anonymous class is defined. For more information, see [Anonymous Class Types](../cpp/anonymous-class-types.md).
4242

43-
`base-list`
43+
*base-list*
4444
Optional list of classes or structures this class will derive its members from. See [Base Classes](../cpp/base-classes.md) for more information. Each base class or structure name can be preceded by an access specifier ([public](../cpp/public-cpp.md), [private](../cpp/private-cpp.md), [protected](../cpp/protected-cpp.md)) and the [virtual](../cpp/virtual-cpp.md) keyword. See the member-access table in [Controlling Access to Class Members](member-access-control-cpp.md) for more information.
4545

46-
`member-list`
46+
*member-list*
4747
List of class members. Refer to [Class Member Overview](../cpp/class-member-overview.md) for more information.
4848

49-
`declarators`
50-
Declarator list specifying the names of one or more instances of the class type. Declarators may include initializer lists if all data members of the class are `public`. This is more common in structures, whose data members are `public` by default, than in classes. See [Overview of Declarators](../cpp/overview-of-declarators.md) for more information.
49+
*declarators*
50+
Declarator list specifying the names of one or more instances of the class type. Declarators may include initializer lists if all data members of the class are **public**. This is more common in structures, whose data members are **public** by default, than in classes. See [Overview of Declarators](../cpp/overview-of-declarators.md) for more information.
5151

5252
## Remarks
5353
For more information on classes in general, refer to one of the following topics:

docs/cpp/class-member-overview.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ int TestRun::_instances{ 0 };
8585
```
8686
8787
## Member accessibility
88-
The members of a class are declared in the member list. The member list of a class may be divided into any number of `private`, `protected` and **public** sections using keywords known as access specifiers. A colon **:** must follow the access specifier. These sections need not be contiguous, that is, any of these keywords may appear several times in the member list. The keyword designates the access of all members up until the next access specifier or the closing brace. For more information, see [Member Access Control (C++)](../cpp/member-access-control-cpp.md).
88+
The members of a class are declared in the member list. The member list of a class may be divided into any number of **private**, **protected** and **public** sections using keywords known as access specifiers. A colon **:** must follow the access specifier. These sections need not be contiguous, that is, any of these keywords may appear several times in the member list. The keyword designates the access of all members up until the next access specifier or the closing brace. For more information, see [Member Access Control (C++)](../cpp/member-access-control-cpp.md).
8989
9090
## Static members
9191
A data member may be declared as static, which means all objects of the class have access to the same copy of it. A member function may be declared as static, in which case it can only access static data members of the class (and has no *this* pointer). For more information, see [Static Data Members](../cpp/static-members-cpp.md).

docs/cpp/classes-and-structs-cpp.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ This section introduces C++ classes and structs. The two constructs are identica
5252

5353
|Structures|Classes|Unions|
5454
|----------------|-------------|------------|
55-
|class key is `struct`|class key is **class**|class key is **union**|
55+
|class key is **struct**|class key is **class**|class key is **union**|
5656
|Default access is public|Default access is private|Default access is public|
5757
|No usage constraints|No usage constraints|Use only one member at a time|
5858

docs/cpp/com-error-class.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ ms.workload: ["cplusplus"]
1515
# _com_error Class
1616
**Microsoft Specific**
1717

18-
A `_com_error` object represents an exception condition detected by the error-handling wrapper functions in the header files generated from the type library or by one of the COM support classes. The `_com_error` class encapsulates the `HRESULT` error code and any associated `IErrorInfo Interface` object.
18+
A `_com_error` object represents an exception condition detected by the error-handling wrapper functions in the header files generated from the type library or by one of the COM support classes. The `_com_error` class encapsulates the HRESULT error code and any associated `IErrorInfo Interface` object.
1919

2020
### Construction
2121

@@ -33,9 +33,9 @@ ms.workload: ["cplusplus"]
3333

3434
|||
3535
|-|-|
36-
|[Error](../cpp/com-error-error.md)|Retrieves the `HRESULT` passed to the constructor.|
36+
|[Error](../cpp/com-error-error.md)|Retrieves the HRESULT passed to the constructor.|
3737
|[ErrorInfo](../cpp/com-error-errorinfo.md)|Retrieves the `IErrorInfo` object passed to the constructor.|
38-
|[WCode](../cpp/com-error-wcode.md)|Retrieves the 16-bit error code mapped into the encapsulated `HRESULT`.|
38+
|[WCode](../cpp/com-error-wcode.md)|Retrieves the 16-bit error code mapped into the encapsulated HRESULT.|
3939

4040
### IErrorInfo Functions
4141

@@ -57,8 +57,8 @@ ms.workload: ["cplusplus"]
5757

5858
|||
5959
|-|-|
60-
|[HRESULTToWCode](../cpp/com-error-hresulttowcode.md)|Maps 32-bit `HRESULT` to 16-bit `wCode`.|
61-
|[WCodeToHRESULT](../cpp/com-error-wcodetohresult.md)|Maps 16-bit `wCode` to 32-bit `HRESULT`.|
60+
|[HRESULTToWCode](../cpp/com-error-hresulttowcode.md)|Maps 32-bit HRESULT to 16-bit `wCode`.|
61+
|[WCodeToHRESULT](../cpp/com-error-wcodetohresult.md)|Maps 16-bit `wCode` to 32-bit HRESULT.|
6262

6363
**END Microsoft Specific**
6464

docs/cpp/com-error-com-error.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -30,30 +30,30 @@ _com_error( const _com_error& that ) throw( );
3030
```
3131

3232
#### Parameters
33-
`hr`
34-
`HRESULT` information.
33+
*hr*
34+
HRESULT information.
3535

36-
`perrinfo`
37-
**IErrorInfo** object.
36+
*perrinfo*
37+
`IErrorInfo` object.
3838

39-
**bool fAddRef=false**
40-
Causes the constructor to call AddRef on a non-null **IErrorInfo** interface. This provides for correct reference counting in the common case where ownership of the interface is passed into the `_com_error` object, such as:
39+
`bool fAddRef=false`
40+
Causes the constructor to call AddRef on a non-null `IErrorInfo` interface. This provides for correct reference counting in the common case where ownership of the interface is passed into the `_com_error` object, such as:
4141

4242
```cpp
4343
throw _com_error(hr, perrinfo);
4444
```
4545
46-
If you do not want your code to transfer ownership to the `_com_error` object, and the `AddRef` is required to offset the **Release** in the `_com_error` destructor, construct the object as follows:
46+
If you do not want your code to transfer ownership to the `_com_error` object, and the `AddRef` is required to offset the `Release` in the `_com_error` destructor, construct the object as follows:
4747
4848
```cpp
4949
_com_error err(hr, perrinfo, true);
5050
```
5151

52-
`that`
52+
*that*
5353
An existing `_com_error` object.
5454

5555
## Remarks
56-
The first constructor creates a new object given an `HRESULT` and optional **IErrorInfo** object. The second creates a copy of an existing `_com_error` object.
56+
The first constructor creates a new object given an HRESULT and optional `IErrorInfo` object. The second creates a copy of an existing `_com_error` object.
5757

5858
**END Microsoft Specific**
5959

docs/cpp/com-error-description.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ ms.workload: ["cplusplus"]
1515
# _com_error::Description
1616
**Microsoft Specific**
1717

18-
Calls **IErrorInfo::GetDescription** function.
18+
Calls `IErrorInfo::GetDescription` function.
1919

2020
## Syntax
2121

@@ -26,10 +26,10 @@ _bstr_t Description( ) const;
2626
```
2727

2828
## Return Value
29-
Returns the result of **IErrorInfo::GetDescription** for the **IErrorInfo** object recorded within the `_com_error` object. The resulting `BSTR` is encapsulated in a `_bstr_t` object. If no **IErrorInfo** is recorded, it returns an empty `_bstr_t`.
29+
Returns the result of `IErrorInfo::GetDescription` for the `IErrorInfo` object recorded within the `_com_error` object. The resulting `BSTR` is encapsulated in a `_bstr_t` object. If no `IErrorInfo` is recorded, it returns an empty `_bstr_t`.
3030

3131
## Remarks
32-
Calls the **IErrorInfo::GetDescription** function and retrieves **IErrorInfo** recorded within the `_com_error` object. Any failure while calling the **IErrorInfo::GetDescription** method is ignored.
32+
Calls the `IErrorInfo::GetDescription` function and retrieves `IErrorInfo` recorded within the `_com_error` object. Any failure while calling the `IErrorInfo::GetDescription` method is ignored.
3333

3434
**END Microsoft Specific**
3535

docs/cpp/com-error-error.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ ms.workload: ["cplusplus"]
1515
# _com_error::Error
1616
**Microsoft Specific**
1717

18-
Retrieves the `HRESULT` passed to the constructor.
18+
Retrieves the HRESULT passed to the constructor.
1919

2020
## Syntax
2121

@@ -26,10 +26,10 @@ HRESULT Error( ) const throw( );
2626
```
2727

2828
## Return Value
29-
Raw `HRESULT` item passed into the constructor.
29+
Raw HRESULT item passed into the constructor.
3030

3131
## Remarks
32-
Retrieves the encapsulated `HRESULT` item in a `_com_error` object.
32+
Retrieves the encapsulated HRESULT item in a `_com_error` object.
3333

3434
**END Microsoft Specific**
3535

docs/cpp/com-error-errorinfo.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ ms.workload: ["cplusplus"]
1515
# _com_error::ErrorInfo
1616
**Microsoft Specific**
1717

18-
Retrieves the **IErrorInfo** object passed to the constructor.
18+
Retrieves the `IErrorInfo` object passed to the constructor.
1919

2020
## Syntax
2121

@@ -26,10 +26,10 @@ IErrorInfo * ErrorInfo( ) const throw( );
2626
```
2727

2828
## Return Value
29-
Raw **IErrorInfo** item passed into the constructor.
29+
Raw `IErrorInfo` item passed into the constructor.
3030

3131
## Remarks
32-
Retrieves the encapsulated **IErrorInfo** item in a `_com_error` object, or **NULL** if no **IErrorInfo** item is recorded. The caller must call **Release** on the returned object when finished using it.
32+
Retrieves the encapsulated `IErrorInfo` item in a `_com_error` object, or NULL if no `IErrorInfo` item is recorded. The caller must call `Release` on the returned object when finished using it.
3333

3434
**END Microsoft Specific**
3535

docs/cpp/com-error-errormessage.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ ms.workload: ["cplusplus"]
1515
# _com_error::ErrorMessage
1616
**Microsoft Specific**
1717

18-
Retrieves the string message for `HRESULT` stored in the `_com_error` object.
18+
Retrieves the string message for HRESULT stored in the `_com_error` object.
1919

2020
## Syntax
2121

@@ -26,10 +26,10 @@ const TCHAR * ErrorMessage( ) const throw( );
2626
```
2727

2828
## Return Value
29-
Returns the string message for the `HRESULT` recorded within the `_com_error` object. If the `HRESULT` is a mapped 16-bit [wCode](../cpp/com-error-wcode.md), then a generic message "`IDispatch error #<wCode>`" is returned. If no message is found, then a generic message "`Unknown error #<hresult>`" is returned. The returned string is either a Unicode or multibyte string, depending on the state of the **_UNICODE** macro.
29+
Returns the string message for the HRESULT recorded within the `_com_error` object. If the HRESULT is a mapped 16-bit [wCode](../cpp/com-error-wcode.md), then a generic message "`IDispatch error #<wCode>`" is returned. If no message is found, then a generic message "`Unknown error #<hresult>`" is returned. The returned string is either a Unicode or multibyte string, depending on the state of the _UNICODE macro.
3030

3131
## Remarks
32-
Retrieves the appropriate system message text for `HRESULT` recorded within the `_com_error` object. The system message text is obtained by calling the Win32 [FormatMessage](http://msdn.microsoft.com/library/windows/desktop/ms679351) function. The string returned is allocated by the `FormatMessage` API, and it is released when the `_com_error` object is destroyed.
32+
Retrieves the appropriate system message text for HRESULT recorded within the `_com_error` object. The system message text is obtained by calling the Win32 [FormatMessage](http://msdn.microsoft.com/library/windows/desktop/ms679351) function. The string returned is allocated by the `FormatMessage` API, and it is released when the `_com_error` object is destroyed.
3333

3434
**END Microsoft Specific**
3535

docs/cpp/com-error-guid.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ ms.workload: ["cplusplus"]
1515
# _com_error::GUID
1616
**Microsoft Specific**
1717

18-
Calls **IErrorInfo::GetGUID** function.
18+
Calls `IErrorInfo::GetGUID` function.
1919

2020
## Syntax
2121

@@ -26,10 +26,10 @@ GUID GUID( ) const throw( );
2626
```
2727

2828
## Return Value
29-
Returns the result of **IErrorInfo::GetGUID** for the **IErrorInfo** object recorded within the `_com_error` object. If no **IErrorInfo** object is recorded, it returns `GUID_NULL`.
29+
Returns the result of `IErrorInfo::GetGUID` for the `IErrorInfo` object recorded within the `_com_error` object. If no `IErrorInfo` object is recorded, it returns GUID_NULL.
3030

3131
## Remarks
32-
Any failure while calling the **IErrorInfo::GetGUID** method is ignored.
32+
Any failure while calling the `IErrorInfo::GetGUID` method is ignored.
3333

3434
**END Microsoft Specific**
3535

docs/cpp/com-error-helpcontext.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ ms.workload: ["cplusplus"]
1515
# _com_error::HelpContext
1616
**Microsoft Specific**
1717

18-
Calls **IErrorInfo::GetHelpContext** function.
18+
Calls `IErrorInfo::GetHelpContext` function.
1919

2020
## Syntax
2121

@@ -26,10 +26,10 @@ DWORD HelpContext( ) const throw( );
2626
```
2727

2828
## Return Value
29-
Returns the result of **IErrorInfo::GetHelpContext** for the **IErrorInfo** object recorded within the `_com_error` object. If no **IErrorInfo** object is recorded, it returns a zero.
29+
Returns the result of `IErrorInfo::GetHelpContext` for the `IErrorInfo` object recorded within the `_com_error` object. If no `IErrorInfo` object is recorded, it returns a zero.
3030

3131
## Remarks
32-
Any failure while calling the **IErrorInfo::GetHelpContext** method is ignored.
32+
Any failure while calling the `IErrorInfo::GetHelpContext` method is ignored.
3333

3434
**END Microsoft Specific**
3535

docs/cpp/com-error-helpfile.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ ms.workload: ["cplusplus"]
1515
# _com_error::HelpFile
1616
**Microsoft Specific**
1717

18-
Calls **IErrorInfo::GetHelpFile** function.
18+
Calls `IErrorInfo::GetHelpFile` function.
1919

2020
## Syntax
2121

@@ -26,10 +26,10 @@ _bstr_t HelpFile() const;
2626
```
2727

2828
## Return Value
29-
Returns the result of **IErrorInfo::GetHelpFile** for the **IErrorInfo** object recorded within the `_com_error` object. The resulting BSTR is encapsulated in a `_bstr_t` object. If no **IErrorInfo** is recorded, it returns an empty `_bstr_t`.
29+
Returns the result of `IErrorInfo::GetHelpFile` for the `IErrorInfo` object recorded within the `_com_error` object. The resulting BSTR is encapsulated in a `_bstr_t` object. If no `IErrorInfo` is recorded, it returns an empty `_bstr_t`.
3030

3131
## Remarks
32-
Any failure while calling the **IErrorInfo::GetHelpFile** method is ignored.
32+
Any failure while calling the `IErrorInfo::GetHelpFile` method is ignored.
3333

3434
**END Microsoft Specific**
3535

docs/cpp/com-error-hresulttowcode.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ ms.workload: ["cplusplus"]
1515
# _com_error::HRESULTToWCode
1616
**Microsoft Specific**
1717

18-
Maps 32-bit `HRESULT` to 16-bit `wCode`.
18+
Maps 32-bit HRESULT to 16-bit `wCode`.
1919

2020
## Syntax
2121

@@ -27,11 +27,11 @@ ms.workload: ["cplusplus"]
2727
```
2828

2929
#### Parameters
30-
`hr`
31-
The 32-bit `HRESULT` to be mapped to 16-bit `wCode`.
30+
*hr*
31+
The 32-bit HRESULT to be mapped to 16-bit `wCode`.
3232

3333
## Return Value
34-
16-bit `wCode` mapped from the 32-bit `HRESULT`.
34+
16-bit `wCode` mapped from the 32-bit HRESULT.
3535

3636
## Remarks
3737
See [_com_error::WCode](../cpp/com-error-wcode.md) for more information.

docs/cpp/com-error-member-functions.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ ms.author: "mblome"
1212
ms.workload: ["cplusplus"]
1313
---
1414
# _com_error Member Functions
15-
For information about the **_com_error** member functions, see [_com_error Class](../cpp/com-error-class.md).
15+
For information about the `_com_error` member functions, see [_com_error Class](../cpp/com-error-class.md).
1616

1717
## See Also
1818
[_com_error Class](../cpp/com-error-class.md)

docs/cpp/com-error-operator-equal.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ ms.workload: ["cplusplus"]
2727
```
2828

2929
#### Parameters
30-
`that`
30+
*that*
3131
A `_com_error` object.
3232

3333
**END Microsoft Specific**

docs/cpp/com-error-source.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ ms.workload: ["cplusplus"]
1515
# _com_error::Source
1616
**Microsoft Specific**
1717

18-
Calls **IErrorInfo::GetSource** function.
18+
Calls `IErrorInfo::GetSource` function.
1919

2020
## Syntax
2121

@@ -26,10 +26,10 @@ _bstr_t Source() const;
2626
```
2727

2828
## Return Value
29-
Returns the result of **IErrorInfo::GetSource** for the **IErrorInfo** object recorded within the `_com_error` object. The resulting BSTR is encapsulated in a `_bstr_t` object. If no **IErrorInfo** is recorded, it returns an empty `_bstr_t`.
29+
Returns the result of `IErrorInfo::GetSource` for the `IErrorInfo` object recorded within the `_com_error` object. The resulting BSTR is encapsulated in a `_bstr_t` object. If no `IErrorInfo` is recorded, it returns an empty `_bstr_t`.
3030

3131
## Remarks
32-
Any failure while calling the **IErrorInfo::GetSource** method is ignored.
32+
Any failure while calling the `IErrorInfo::GetSource` method is ignored.
3333

3434
**END Microsoft Specific**
3535

0 commit comments

Comments
 (0)