Skip to content

Commit 3de6754

Browse files
author
mtx48109
committed
cpp formatting review pr13
1 parent 4dd72c1 commit 3de6754

30 files changed

+43
-67
lines changed

docs/cpp/based-grammar.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -35,5 +35,5 @@ ms.workload: ["cplusplus"]
3535

3636
**END Microsoft Specific**
3737

38-
## See Also
38+
## See also
3939
[Based Pointers](../cpp/based-pointers-cpp.md)

docs/cpp/based-pointers-cpp.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,6 @@ int main() {
8484
11
8585
```
8686

87-
## See Also
87+
## See also
8888
[Keywords](../cpp/keywords-cpp.md)
8989
[alloc_text](../preprocessor/alloc-text.md)

docs/cpp/basic-concepts-cpp.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -32,5 +32,5 @@ This section explains concepts that are critical to understanding C++. C program
3232

3333
- [Trivial, standard-layout and POD types](../cpp/trivial-standard-layout-and-pod-types.md)
3434

35-
## See Also
35+
## See also
3636
[C++ Language Reference](../cpp/cpp-language-reference.md)

docs/cpp/binary-operators.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -68,5 +68,4 @@ where *ret-type* and *op* are as described for member operator functions and *ar
6868
> There is no restriction on the return types of the binary operators; however, most user-defined binary operators return either a class type or a reference to a class type.
6969
7070
## See also
71-
72-
- [Operator Overloading](../cpp/operator-overloading.md)
71+
[Operator Overloading](../cpp/operator-overloading.md)

docs/cpp/bitwise-and-operator-amp.md

+1-3
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,7 @@ ms.workload: ["cplusplus"]
1717
## Syntax
1818

1919
```
20-
2120
expression & expression
22-
2321
```
2422

2523
## Remarks
@@ -48,7 +46,7 @@ int main() {
4846
}
4947
```
5048

51-
## See Also
49+
## See also
5250
[C++ Built-in Operators, Precedence and Associativity](cpp-built-in-operators-precedence-and-associativity.md)
5351
[C++ Built-in Operators, Precedence and Associativity](../cpp/cpp-built-in-operators-precedence-and-associativity.md)
5452
[C Bitwise Operators](../c-language/c-bitwise-operators.md)

docs/cpp/bitwise-exclusive-or-operator-hat.md

+2-4
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,5 @@ int main() {
4242
}
4343
```
4444

45-
## See Also
46-
[C++ Built-in Operators, Precedence and Associativity](../cpp/cpp-built-in-operators-precedence-and-associativity.md)
47-
48-
45+
## See also
46+
[C++ Built-in Operators, Precedence and Associativity](../cpp/cpp-built-in-operators-precedence-and-associativity.md)

docs/cpp/bitwise-inclusive-or-operator-pipe.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,5 @@ int main() {
4646
```
4747

4848
## See also
49-
50-
- [C++ Built-in Operators, Precedence and Associativity](../cpp/cpp-built-in-operators-precedence-and-associativity.md)
51-
- [C Bitwise Operators](../c-language/c-bitwise-operators.md)
49+
[C++ Built-in Operators, Precedence and Associativity](../cpp/cpp-built-in-operators-precedence-and-associativity.md)
50+
[C Bitwise Operators](../c-language/c-bitwise-operators.md)

docs/cpp/bool-cpp.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,5 @@ The postfix or prefix **--** operator cannot be applied to a variable of this ty
4848
The **bool** type participates in integral promotions. An r-value of type **bool** can be converted to an r-value of type **int**, with FALSE becoming zero and TRUE becoming one. As a distinct type, **bool** participates in overload resolution.
4949

5050
## See also
51-
52-
[Keywords](../cpp/keywords-cpp.md)<br/>
53-
[Fundamental Types](../cpp/fundamental-types-cpp.md)<br/>
51+
[Keywords](../cpp/keywords-cpp.md)
52+
[Fundamental Types](../cpp/fundamental-types-cpp.md)

docs/cpp/break-statement-cpp.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -147,7 +147,7 @@ int main() {
147147
}
148148
```
149149

150-
## See Also
150+
## See also
151151
[Jump Statements](../cpp/jump-statements-cpp.md)
152152
[Keywords](../cpp/keywords-cpp.md)
153153
[continue Statement](../cpp/continue-statement-cpp.md)

docs/cpp/bstr-t-assign.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ void Assign(
3030
A `BSTR` to be copied into the `BSTR` wrapped by a `_bstr_t`.
3131

3232
## Remarks
33-
`Assign` does a binary copy, which means the entire length of the `BSTR` is copied, regardless of content.
33+
**Assign** does a binary copy, which means the entire length of the `BSTR` is copied, regardless of content.
3434

3535
## Example
3636

@@ -107,5 +107,5 @@ bstrWrapper2 = some text
107107

108108
**END Microsoft Specific**
109109

110-
## See Also
110+
## See also
111111
[_bstr_t Class](../cpp/bstr-t-class.md)

docs/cpp/bstr-t-attach.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,6 @@ ms.workload: ["cplusplus"]
2020
## Syntax
2121

2222
```
23-
2423
void Attach(
2524
BSTR s
2625
);
@@ -38,5 +37,5 @@ void Attach(
3837

3938
**END Microsoft Specific**
4039

41-
## See Also
40+
## See also
4241
[_bstr_t Class](../cpp/bstr-t-class.md)

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

+2-2
Original file line numberDiff line numberDiff line change
@@ -68,10 +68,10 @@ _bstr_t(
6868
|`_bstr_t( char*` `s2` `)`|Constructs a `_bstr_t` object by calling `SysAllocString` to create a new `BSTR` object and then encapsulates it.<br /><br /> This constructor first performs a multibyte to Unicode conversion.|
6969
|`_bstr_t( wchar_t*` `s3` `)`|Constructs a `_bstr_t` object by calling `SysAllocString` to create a new `BSTR` object and then encapsulates it.|
7070
|`_bstr_t( _variant_t&` `var` `)`|Constructs a `_bstr_t` object from a `_variant_t` object by first retrieving a `BSTR` object from the encapsulated VARIANT object.|
71-
|`_bstr_t( BSTR` `bstr` `, bool` `fCopy` `)`|Constructs a `_bstr_t` object from an existing `BSTR` (as opposed to a `wchar_t*` string). If `fCopy` is false, the supplied `BSTR` is attached to the new object without making a new copy with `SysAllocString`.<br /><br /> This constructor is used by wrapper functions in the type library headers to encapsulate and take ownership of a `BSTR` that is returned by an interface method.|
71+
|`_bstr_t( BSTR` `bstr` `, bool` `fCopy` `)`|Constructs a `_bstr_t` object from an existing `BSTR` (as opposed to a `wchar_t*` string). If *fCopy* is false, the supplied `BSTR` is attached to the new object without making a new copy with `SysAllocString`.<br /><br /> This constructor is used by wrapper functions in the type library headers to encapsulate and take ownership of a `BSTR` that is returned by an interface method.|
7272

7373
**END Microsoft Specific**
7474

75-
## See Also
75+
## See also
7676
[_bstr_t Class](../cpp/bstr-t-class.md)
7777
[_variant_t Class](../cpp/variant-t-class.md)

docs/cpp/bstr-t-class.md

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

18-
A `_bstr_t` object encapsulates the [BSTR data type](http://msdn.microsoft.com/1b2d7d2c-47af-4389-a6b6-b01b7e915228). The class manages resource allocation and deallocation through function calls to `SysAllocString` and `SysFreeString` and other `BSTR` APIs when appropriate. The `_bstr_t` class uses reference counting to avoid excessive overhead.
18+
A `_bstr_t` object encapsulates the [BSTR data type](http://msdn.microsoft.com/1b2d7d2c-47af-4389-a6b6-b01b7e915228). The class manages resource allocation and deallocation through function calls to `SysAllocString` and `SysFreeString` and other `BSTR` APIs when appropriate. The **_bstr_t** class uses reference counting to avoid excessive overhead.
1919

2020
### Construction
2121

@@ -53,5 +53,5 @@ ms.workload: ["cplusplus"]
5353

5454
**Lib:** comsuppw.lib or comsuppwd.lib (see [/Zc:wchar_t (wchar_t Is Native Type)](../build/reference/zc-wchar-t-wchar-t-is-native-type.md) for more information)
5555

56-
## See Also
56+
## See also
5757
[Compiler COM Support Classes](../cpp/compiler-com-support-classes.md)

docs/cpp/bstr-t-copy.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -20,13 +20,12 @@ ms.workload: ["cplusplus"]
2020
## Syntax
2121

2222
```
23-
2423
BSTR copy( bool fCopy = true ) const;
2524
```
2625

2726
#### Parameters
2827
*fCopy*
29-
If TRUE, `copy` returns a copy of the contained `BSTR`, otherwise `copy` returns the actual BSTR.
28+
If TRUE, **copy** returns a copy of the contained `BSTR`, otherwise **copy** returns the actual BSTR.
3029

3130
## Remarks
3231
Returns a newly allocated copy of the encapsulated `BSTR` object.
@@ -41,5 +40,5 @@ STDMETHODIMP CAlertMsg::get_ConnectionStr(BSTR *pVal){ // m_bsConStr is _bstr_t
4140
4241
**END Microsoft Specific**
4342
44-
## See Also
43+
## See also
4544
[_bstr_t Class](../cpp/bstr-t-class.md)

docs/cpp/bstr-t-detach.md

+2-4
Original file line numberDiff line numberDiff line change
@@ -20,18 +20,16 @@ ms.workload: ["cplusplus"]
2020
## Syntax
2121

2222
```
23-
2423
BSTR Detach( ) throw;
25-
2624
```
2725

2826
## Return Value
2927
The `BSTR` wrapped by the `_bstr_t`.
3028

3129
## Example
32-
See [_bstr_t::Assign](../cpp/bstr-t-assign.md) for a example using `Detach`.
30+
See [_bstr_t::Assign](../cpp/bstr-t-assign.md) for a example using **Detach**.
3331

3432
**END Microsoft Specific**
3533

36-
## See Also
34+
## See also
3735
[_bstr_t Class](../cpp/bstr-t-class.md)

docs/cpp/bstr-t-getaddress.md

+3-5
Original file line numberDiff line numberDiff line change
@@ -20,21 +20,19 @@ ms.workload: ["cplusplus"]
2020
## Syntax
2121

2222
```
23-
2423
BSTR* GetAddress( );
25-
2624
```
2725

2826
## Return Value
2927
A pointer to the `BSTR` wrapped by the `_bstr_t`.
3028

3129
## Remarks
32-
`GetAddress` affects all `_bstr_t` objects that share a `BSTR`. More than one `_bstr_t` can share a `BSTR` through the use of the copy constructor and and **operator=**.
30+
**GetAddress** affects all `_bstr_t` objects that share a `BSTR`. More than one `_bstr_t` can share a `BSTR` through the use of the copy constructor and and **operator=**.
3331

3432
## Example
35-
See [_bstr_t::Assign](../cpp/bstr-t-assign.md) for a example using `GetAddress`.
33+
See [_bstr_t::Assign](../cpp/bstr-t-assign.md) for a example using **GetAddress**.
3634

3735
**END Microsoft Specific**
3836

39-
## See Also
37+
## See also
4038
[_bstr_t Class](../cpp/bstr-t-class.md)

docs/cpp/bstr-t-getbstr.md

+3-5
Original file line numberDiff line numberDiff line change
@@ -20,21 +20,19 @@ ms.workload: ["cplusplus"]
2020
## Syntax
2121

2222
```
23-
2423
BSTR& GetBSTR( );
25-
2624
```
2725

2826
## Return Value
2927
The beginning of the `BSTR` wrapped by the `_bstr_t`.
3028

3129
## Remarks
32-
`GetBSTR` affects all `_bstr_t` objects that share a `BSTR`. More than one `_bstr_t` can share a `BSTR` through the use of the copy constructor and and **operator=**.
30+
**GetBSTR** affects all `_bstr_t` objects that share a `BSTR`. More than one `_bstr_t` can share a `BSTR` through the use of the copy constructor and and **operator=**.
3331

3432
## Example
35-
See [_bstr_t::Assign](../cpp/bstr-t-assign.md) for an example using `GetBSTR`.
33+
See [_bstr_t::Assign](../cpp/bstr-t-assign.md) for an example using **GetBSTR**.
3634

3735
**END Microsoft Specific**
3836

39-
## See Also
37+
## See also
4038
[_bstr_t Class](../cpp/bstr-t-class.md)

docs/cpp/bstr-t-length.md

+1-3
Original file line numberDiff line numberDiff line change
@@ -20,13 +20,11 @@ ms.workload: ["cplusplus"]
2020
## Syntax
2121

2222
```
23-
2423
unsigned int length ( ) const throw( );
25-
2624
```
2725

2826
## Remarks
2927
**END Microsoft Specific**
3028

31-
## See Also
29+
## See also
3230
[_bstr_t Class](../cpp/bstr-t-class.md)

docs/cpp/bstr-t-member-functions.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,5 +14,5 @@ ms.workload: ["cplusplus"]
1414
# _bstr_t Member Functions
1515
For information about `_bstr_t` member functions, see [_bstr_t Class](../cpp/bstr-t-class.md).
1616

17-
## See Also
17+
## See also
1818
[_bstr_t Class](../cpp/bstr-t-class.md)

docs/cpp/bstr-t-operator-add-equal-plus.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,6 @@ ms.workload: ["cplusplus"]
2020
## Syntax
2121

2222
```
23-
2423
_bstr_t& operator+=( const _bstr_t& s1 );
2524
_bstr_t operator+( const _bstr_t& s1 );
2625
friend _bstr_t operator+( const char* s2, const _bstr_t& s1);
@@ -50,5 +49,5 @@ friend _bstr_t operator+( const wchar_t* s3, const _bstr_t& s1);
5049

5150
**END Microsoft Specific**
5251

53-
## See Also
52+
## See also
5453
[_bstr_t Class](../cpp/bstr-t-class.md)

docs/cpp/bstr-t-operator-equal.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,6 @@ ms.workload: ["cplusplus"]
2020
## Syntax
2121

2222
```
23-
2423
_bstr_t& operator=(const _bstr_t& s1) throw ( );
2524
_bstr_t& operator=(const char* s2);
2625
_bstr_t& operator=(const wchar_t* s3);
@@ -45,5 +44,5 @@ _bstr_t& operator=(const _variant_t& var);
4544
## Example
4645
See [_bstr_t::Assign](../cpp/bstr-t-assign.md) for an example of using **operator=**.
4746

48-
## See Also
47+
## See also
4948
[_bstr_t Class](../cpp/bstr-t-class.md)

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

+1-3
Original file line numberDiff line numberDiff line change
@@ -20,15 +20,13 @@ ms.workload: ["cplusplus"]
2020
## Syntax
2121

2222
```
23-
2423
bool operator!( ) const throw( );
25-
2624
```
2725

2826
## Return Value
2927
It returns TRUE if yes, FALSE if not.
3028

3129
**END Microsoft Specific**
3230

33-
## See Also
31+
## See also
3432
[_bstr_t Class](../cpp/bstr-t-class.md)

docs/cpp/bstr-t-operators.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,5 +14,5 @@ ms.workload: ["cplusplus"]
1414
# _bstr_t Operators
1515
For information about the `_bstr_t` operators, see [_bstr_t Class](../cpp/bstr-t-class.md).
1616

17-
## See Also
17+
## See also
1818
[_bstr_t Class](../cpp/bstr-t-class.md)

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

+1-2
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,6 @@ ms.workload: ["cplusplus"]
2020
## Syntax
2121

2222
```
23-
2423
bool operator!( ) const throw( ); 
2524
bool operator==(const _bstr_t& str) const throw( );
2625
bool operator!=(const _bstr_t& str) const throw( );
@@ -35,5 +34,5 @@ bool operator>=(const _bstr_t& str) const throw( );
3534

3635
**END Microsoft Specific**
3736

38-
## See Also
37+
## See also
3938
[_bstr_t Class](../cpp/bstr-t-class.md)

docs/cpp/bstr-t-wchar-t-star-bstr-t-char-star.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,6 @@ ms.workload: ["cplusplus"]
2020
## Syntax
2121

2222
```
23-
2423
operator const wchar_t*( ) const throw( ); 
2524
operator wchar_t*( ) const throw( ); 
2625
operator const char*( ) const; 
@@ -32,5 +31,5 @@ operator char*( ) const;
3231

3332
**END Microsoft Specific**
3433

35-
## See Also
34+
## See also
3635
[_bstr_t Class](../cpp/bstr-t-class.md)

docs/cpp/calling-conventions.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -30,5 +30,5 @@ The Visual C/C++ compiler provides several different conventions for calling int
3030

3131
- [Obsolete calling conventions](../cpp/obsolete-calling-conventions.md)
3232

33-
## See Also
33+
## See also
3434
[Microsoft-Specific Modifiers](../cpp/microsoft-specific-modifiers.md)

docs/cpp/calling-example-function-prototype-and-call.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -38,5 +38,5 @@ MyFunc ('x', 12, 8192, 2.7183);
3838

3939
**END Microsoft Specific**
4040

41-
## See Also
41+
## See also
4242
[Calling Conventions](../cpp/calling-conventions.md)

0 commit comments

Comments
 (0)