Skip to content

Commit 6fef52d

Browse files
authored
Merge pull request #1069 from msebolt/format-standard-pr11
format standard pr11
2 parents d53b4ed + dfac302 commit 6fef52d

30 files changed

+279
-278
lines changed

docs/standard-library/negate-struct.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,11 +37,11 @@ struct negate<void>
3737

3838
### Parameters
3939

40-
`Type`
40+
*Type*
4141
Any type that supports an `operator-` that takes an operand of the specified or inferred type.
4242

43-
`Left`
44-
The operand to be negated. The specialized template does perfect forwarding of lvalue and rvalue reference arguments of inferred type `Type`.
43+
*Left*
44+
The operand to be negated. The specialized template does perfect forwarding of lvalue and rvalue reference arguments of inferred type *Type*.
4545

4646
## Return Value
4747

docs/standard-library/negative-binomial-distribution-class.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,15 +46,16 @@ public:
4646
result_type min() const;
4747
result_type max() const;
4848
};
49+
```
4950

5051
### Parameters
5152

5253
*IntType*
53-
The integer result type, defaults to `int`. For possible types, see [\<random>](../standard-library/random.md).
54+
The integer result type, defaults to **int**. For possible types, see [\<random>](../standard-library/random.md).
5455

5556
## Remarks
5657

57-
The template class describes a distribution that produces values of a user-specified integral type, or type `int` if none is provided, distributed according to the Negative Binomial Distribution discrete probability function. The following table links to articles about individual members.
58+
The template class describes a distribution that produces values of a user-specified integral type, or type **int** if none is provided, distributed according to the Negative Binomial Distribution discrete probability function. The following table links to articles about individual members.
5859

5960
||||
6061
|-|-|-|

docs/standard-library/new-functions.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ ms.assetid: e250f06a-b025-4509-ae7a-5356d56aad7d
1414

1515
## <a name="nothrow"></a> nothrow
1616

17-
Provides an object to be used as an argument for the `nothrow` versions of **new** and **delete**.
17+
Provides an object to be used as an argument for the **nothrow** versions of **new** and **delete**.
1818

1919
```cpp
2020
extern const std::nothrow_t nothrow;
@@ -30,24 +30,24 @@ See [operator new](../standard-library/new-operators.md#op_new) and [operator ne
3030

3131
## <a name="set_new_handler"></a> set_new_handler
3232

33-
Installs a user function that is to be called when `operator new` fails in its attempt to allocate memory.
33+
Installs a user function that is to be called when **operator new** fails in its attempt to allocate memory.
3434

3535
```cpp
3636
new_handler set_new_handler(new_handler Pnew) throw();
3737
```
3838
3939
### Parameters
4040
41-
`Pnew`
42-
The new_handler to be installed.
41+
*Pnew*
42+
The `new_handler` to be installed.
4343
4444
### Return Value
4545
4646
0 on the first call and the previous `new_handler` on subsequent calls.
4747
4848
### Remarks
4949
50-
The function stores `Pnew` in a static [new handler](../standard-library/new-typedefs.md#new_handler) pointer that it maintains, then returns the value previously stored in the pointer. The new handler is used by [operator new](../standard-library/new-operators.md#op_new)( **size_t**).
50+
The function stores *Pnew* in a static [new handler](../standard-library/new-typedefs.md#new_handler) pointer that it maintains, then returns the value previously stored in the pointer. The new handler is used by [operator new](../standard-library/new-operators.md#op_new)(**size_t**).
5151
5252
### Example
5353

docs/standard-library/new-operators.md

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -29,22 +29,22 @@ void operator delete(void* ptr,
2929

3030
### Parameters
3131

32-
`ptr`
32+
*ptr*
3333
The pointer whose value is to be rendered invalid by the deletion.
3434

3535
### Remarks
3636

37-
The first function is called by a delete expression to render the value of `ptr` invalid. The program can define a function with this function signature that replaces the default version defined by the C++ Standard Library. The required behavior is to accept a value of `ptr` that is null or that was returned by an earlier call to [operator new](../standard-library/new-operators.md#op_new)( **size_t**).
37+
The first function is called by a delete expression to render the value of *ptr* invalid. The program can define a function with this function signature that replaces the default version defined by the C++ Standard Library. The required behavior is to accept a value of *ptr* that is null or that was returned by an earlier call to [operator new](../standard-library/new-operators.md#op_new)(**size_t**).
3838

39-
The default behavior for a null value of `ptr` is to do nothing. Any other value of `ptr` must be a value returned earlier by a call as previously described. The default behavior for such a nonnull value of `ptr` is to reclaim storage allocated by the earlier call. It is unspecified under what conditions part or all of such reclaimed storage is allocated by a subsequent call to `operator new`( **size_t**), or to any of `calloc`( **size_t**), `malloc`( **size_t**), or `realloc`( **void\***, **size_t**).
39+
The default behavior for a null value of *ptr* is to do nothing. Any other value of *ptr* must be a value returned earlier by a call as previously described. The default behavior for such a nonnull value of *ptr* is to reclaim storage allocated by the earlier call. It is unspecified under what conditions part or all of such reclaimed storage is allocated by a subsequent call to `operator new`(**size_t**), or to any of `calloc`( **size_t**), `malloc`( **size_t**), or `realloc`( **void\***, **size_t**).
4040

4141
The second function is called by a placement delete expression corresponding to a new expression of the form **new**( **std::size_t**). It does nothing.
4242

43-
The third function is called by a placement delete expression corresponding to a new expression of the form **new**( **std::size_t**, **conststd::nothrow_t&**). The program can define a function with this function signature that replaces the default version defined by the C++ Standard Library. The required behavior is to accept a value of `ptr` that is null or that was returned by an earlier call to `operator new`( **size_t**). The default behavior is to evaluate **delete**( `ptr`).
43+
The third function is called by a placement delete expression corresponding to a new expression of the form **new**( **std::size_t**, **conststd::nothrow_t&**). The program can define a function with this function signature that replaces the default version defined by the C++ Standard Library. The required behavior is to accept a value of `ptr` that is null or that was returned by an earlier call to `operator new`( **size_t**). The default behavior is to evaluate **delete**(`ptr`).
4444

4545
### Example
4646

47-
See [operator new](../standard-library/new-operators.md#op_new) for an example that use `operator delete`.
47+
See [operator new](../standard-library/new-operators.md#op_new) for an example that use **operator delete**.
4848

4949
## <a name="op_delete_arr"></a> operator delete[]
5050

@@ -62,16 +62,16 @@ void operator delete[](void* ptr,
6262

6363
### Parameters
6464

65-
`ptr`
65+
*ptr*
6666
The pointer whose value is to be rendered invalid by the deletion.
6767

6868
### Remarks
6969

70-
The first function is called by an `delete[]` expression to render the value of `ptr` invalid. The function is replaceable because the program can define a function with this function signature that replaces the default version defined by the C++ Standard Library. The required behavior is to accept a value of `ptr` that is null or that was returned by an earlier call to [operator new&#91;&#93;](../standard-library/new-operators.md#op_new_arr)( **size_t**). The default behavior for a null value of `ptr` is to do nothing. Any other value of `ptr` must be a value returned earlier by a call as previously described. The default behavior for such a nonnull value of `ptr` is to reclaim storage allocated by the earlier call. It is unspecified under what conditions part or all of such reclaimed storage is allocated by a subsequent call to [operator new](../standard-library/new-operators.md#op_new)( **size_t**), or to any of `calloc`( **size_t**), `malloc`( **size_t**), or `realloc`( **void\***, **size_t**).
70+
The first function is called by an `delete[]` expression to render the value of *ptr* invalid. The function is replaceable because the program can define a function with this function signature that replaces the default version defined by the C++ Standard Library. The required behavior is to accept a value of *ptr* that is null or that was returned by an earlier call to [operator new&#91;&#93;](../standard-library/new-operators.md#op_new_arr)(**size_t**). The default behavior for a null value of *ptr* is to do nothing. Any other value of *ptr* must be a value returned earlier by a call as previously described. The default behavior for such a nonnull value of *ptr* is to reclaim storage allocated by the earlier call. It is unspecified under what conditions part or all of such reclaimed storage is allocated by a subsequent call to [operator new](../standard-library/new-operators.md#op_new)(**size_t**), or to any of `calloc`(**size_t**), `malloc`(**size_t**), or `realloc`( **void\***, **size_t**).
7171

72-
The second function is called by a placement `delete[]` expression corresponding to a `new[]` expression of the form `new[]`( **std::size_t**). It does nothing.
72+
The second function is called by a placement `delete[]` expression corresponding to a `new[]` expression of the form `new[]`(**std::size_t**). It does nothing.
7373

74-
The third function is called by a placement delete expression corresponding to a `new[]` expression of the form `new[]`( **std::size_t**, **const std::nothrow_t&**). The program can define a function with this function signature that replaces the default version defined by the C++ Standard Library. The required behavior is to accept a value of `ptr` that is null or that was returned by an earlier call to operator `new[]`( **size_t**). The default behavior is to evaluate `delete[]`( `ptr`).
74+
The third function is called by a placement delete expression corresponding to a `new[]` expression of the form `new[]`( **std::size_t**, **const std::nothrow_t&**). The program can define a function with this function signature that replaces the default version defined by the C++ Standard Library. The required behavior is to accept a value of *ptr* that is null or that was returned by an earlier call to operator `new[]`(**size_t**). The default behavior is to evaluate `delete[]`( `ptr`).
7575

7676
### Example
7777

@@ -93,15 +93,15 @@ void* operator new(std::size_t count,
9393

9494
### Parameters
9595

96-
`count`
96+
*count*
9797
The number of bytes of storage to be allocated.
9898

99-
`ptr`
99+
*ptr*
100100
The pointer to be returned.
101101

102102
### Return Value
103103

104-
A pointer to the lowest byte address of the newly-allocated storage. Or `ptr.`
104+
A pointer to the lowest byte address of the newly-allocated storage. Or *ptr*.
105105

106106
### Remarks
107107

@@ -115,21 +115,21 @@ The required behavior of a new handler is to perform one of the following operat
115115

116116
- Make more storage available for allocation and then return.
117117

118-
- Call either **abort** or **exit**( `int`).
118+
- Call either **abort** or **exit**(`int`).
119119

120120
- Throw an object of type **bad_alloc.**
121121

122122
The default behavior of a [new handler](../standard-library/new-typedefs.md#new_handler) is to throw an object of type `bad_alloc`. A null pointer designates the default new handler.
123123

124-
The order and contiguity of storage allocated by successive calls to `operator new`( **size_t**) is unspecified, as are the initial values stored there.
124+
The order and contiguity of storage allocated by successive calls to `operator new`(**size_t**) is unspecified, as are the initial values stored there.
125125

126126
The second function is called by a placement new expression to allocate `count` bytes of storage suitably aligned to represent any object of that size. The program can define an alternate function with this function signature that replaces the default version defined by the C++ Standard Library and so is replaceable.
127127

128-
The default behavior is to return `operator new`( `count`) if that function succeeds. Otherwise, it returns a null pointer.
128+
The default behavior is to return `operator new`(`count`) if that function succeeds. Otherwise, it returns a null pointer.
129129

130130
The third function is called by a placement **new** expression, of the form **new** ( *args*) T. Here, *args* consists of a single object pointer. This can be useful for constructing an object at a known address. The function returns *ptr*.
131131

132-
To free storage allocated by `operator new`, call [operator delete](../standard-library/new-operators.md#op_delete).
132+
To free storage allocated by **operator new**, call [operator delete](../standard-library/new-operators.md#op_delete).
133133

134134
For information on throwing or nonthrowing behavior of new, see [The new and delete Operators](../cpp/new-and-delete-operators.md).
135135

@@ -192,21 +192,21 @@ void* operator new[](std::size_t count,
192192

193193
### Parameters
194194

195-
`count`
195+
*count*
196196
The number of bytes of storage to be allocated for the array object.
197197

198-
`ptr`
198+
*ptr*
199199
The pointer to be returned.
200200

201201
### Return Value
202202

203-
A pointer to the lowest byte address of the newly-allocated storage. Or `ptr.`
203+
A pointer to the lowest byte address of the newly-allocated storage. Or *ptr*.
204204

205205
### Remarks
206206

207-
The first function is called by a `new[]` expression to allocate `count` bytes of storage suitably aligned to represent any array object of that size or smaller. The program can define a function with this function signature that replaces the default version defined by the C++ Standard Library. The required behavior is the same as for [operator new](../standard-library/new-operators.md#op_new)( **size_t**). The default behavior is to return `operator new`( `count`).
207+
The first function is called by a `new[]` expression to allocate `count` bytes of storage suitably aligned to represent any array object of that size or smaller. The program can define a function with this function signature that replaces the default version defined by the C++ Standard Library. The required behavior is the same as for [operator new](../standard-library/new-operators.md#op_new)(**size_t**). The default behavior is to return `operator new`( `count`).
208208

209-
The second function is called by a placement `new[]` expression to allocate `count` bytes of storage suitably aligned to represent any array object of that size. The program can define a function with this function signature that replaces the default version defined by the C++ Standard Library. The default behavior is to return **operatornew**( `count`) if that function succeeds. Otherwise, it returns a null pointer.
209+
The second function is called by a placement `new[]` expression to allocate `count` bytes of storage suitably aligned to represent any array object of that size. The program can define a function with this function signature that replaces the default version defined by the C++ Standard Library. The default behavior is to return **operatornew**(`count`) if that function succeeds. Otherwise, it returns a null pointer.
210210

211211
The third function is called by a placement `new[]` expression, of the form **new** ( *args*) **T**[ **N**]. Here, *args* consists of a single object pointer. The function returns `ptr`.
212212

docs/standard-library/new.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Some of the functions declared in this header are replaceable. The implementatio
3131

3232
|||
3333
|-|-|
34-
|[nothrow](../standard-library/new-functions.md#nothrow)|Provides an object to be used as an argument for the `nothrow` versions of **new** and **delete**.|
34+
|[nothrow](../standard-library/new-functions.md#nothrow)|Provides an object to be used as an argument for the **nothrow** versions of **new** and **delete**.|
3535

3636
### Typedefs
3737

docs/standard-library/normal-distribution-class.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -51,18 +51,18 @@ public:
5151
### Parameters
5252
5353
*RealType*
54-
The floating-point result type, defaults to `double`. For possible types, see [\<random>](../standard-library/random.md).
54+
The floating-point result type, defaults to **double**. For possible types, see [\<random>](../standard-library/random.md).
5555
5656
## Remarks
5757
58-
The template class describes a distribution that produces values of a user-specified integral type, or type `double` if none is provided, distributed according to the Normal Distribution. The following table links to articles about individual members.
58+
The template class describes a distribution that produces values of a user-specified integral type, or type **double** if none is provided, distributed according to the Normal Distribution. The following table links to articles about individual members.
5959
6060
||||
6161
|-|-|-|
6262
|[normal_distribution](#normal_distribution)|`normal_distribution::mean`|`normal_distribution::param`|
6363
|`normal_distribution::operator()`|`normal_distribution::stddev`|[param_type](#param_type)|
6464
65-
The property functions `mean()` and `stddev()` return the values for the stored distribution parameters `mean` and `stddev` respectively.
65+
The property functions `mean()` and `stddev()` return the values for the stored distribution parameters *mean* and *stddev* respectively.
6666
6767
The property member `param()` sets or returns the `param_type` stored distribution parameter package.
6868

docs/standard-library/not-equal-to-struct.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ ms.workload: ["cplusplus"]
1414
---
1515
# not_equal_to Struct
1616

17-
A binary predicate that performs the inequality operation ( `operator!=`) on its arguments.
17+
A binary predicate that performs the inequality operation (`operator!=`) on its arguments.
1818

1919
## Syntax
2020

@@ -37,22 +37,22 @@ struct not_equal_to<void>
3737

3838
### Parameters
3939

40-
`Type`, `T`, `U`
40+
*Type*, *T*, *U*
4141
Any type that supports an `operator!=` that takes operands of the specified or inferred types.
4242

43-
`Left`
44-
The left operand of the inequality operation. The unspecialized template takes an lvalue reference argument of type `Type`. The specialized template does perfect forwarding of lvalue and rvalue reference arguments of inferred type `T`.
43+
*Left*
44+
The left operand of the inequality operation. The unspecialized template takes an lvalue reference argument of type *Type*. The specialized template does perfect forwarding of lvalue and rvalue reference arguments of inferred type *T*.
4545

46-
`Right`
47-
The right operand of the inequality operation. The unspecialized template takes an lvalue reference argument of type `Type`. The specialized template does perfect forwarding of lvalue and rvalue reference arguments of inferred type `U`.
46+
*Right*
47+
The right operand of the inequality operation. The unspecialized template takes an lvalue reference argument of type *Type*. The specialized template does perfect forwarding of lvalue and rvalue reference arguments of inferred type *U*.
4848

4949
## Return Value
5050

5151
The result of `Left != Right`. The specialized template does perfect forwarding of the result, which has the type that's returned by `operator!=`.
5252

5353
## Remarks
5454

55-
The objects of type `Type` must be equality-comparable. This requires that the `operator!=` defined on the set of objects satisfies the mathematical properties of an equivalence relation. All of the built-in numeric and pointer types satisfy this requirement.
55+
The objects of type *Type* must be equality-comparable. This requires that the `operator!=` defined on the set of objects satisfies the mathematical properties of an equivalence relation. All of the built-in numeric and pointer types satisfy this requirement.
5656

5757
## Example
5858

0 commit comments

Comments
 (0)