Skip to content

Commit f382729

Browse files
authored
Merge pull request #1054 from msebolt/format-standard-pr1
format standard pr1
2 parents b471242 + dd7bb27 commit f382729

31 files changed

+706
-706
lines changed

docs/standard-library/add-const-class.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,12 +25,12 @@ struct add_const;
2525

2626
### Parameters
2727

28-
`Ty`
28+
*Ty*
2929
The type to modify.
3030

3131
## Remarks
3232

33-
An instance of the type modifier holds a modified-type that is `Ty` if `Ty` is a reference, a function, or a const-qualified type, otherwise `const Ty`.
33+
An instance of the type modifier holds a modified-type that is *Ty* if *Ty* is a reference, a function, or a const-qualified type, otherwise `const Ty`.
3434

3535
## Example
3636

docs/standard-library/add-cv-class.md

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

17-
Makes const volatile type from type.
17+
Makes **const volatile** type from type.
1818

1919
## Syntax
2020

@@ -33,7 +33,7 @@ The type to modify.
3333

3434
## Remarks
3535

36-
An instance of the modified type `add_cv<T>` has a `type` member typedef equivalent to *T* modified by both [add_volatile](../standard-library/add-volatile-class.md) and [add_const](../standard-library/add-const-class.md), unless *T* already has the cv-qualifiers, is a reference, or is a function.
36+
An instance of the modified type `add_cv<T>` has a `type` member **typedef** equivalent to *T* modified by both [add_volatile](../standard-library/add-volatile-class.md) and [add_const](../standard-library/add-const-class.md), unless *T* already has the cv-qualifiers, is a reference, or is a function.
3737

3838
The `add_cv_t<T>` helper type is a shortcut to access the `add_cv<T>` member typedef `type`.
3939

docs/standard-library/add-lvalue-reference-class.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,12 +28,12 @@ using add_lvalue_reference_t = typename add_lvalue_reference<T>::type;
2828

2929
### Parameters
3030

31-
`T`
31+
*T*
3232
The type to modify.
3333

3434
## Remarks
3535

36-
An instance of the type modifier holds a modified-type that is `T` if `T` is an lvalue reference, otherwise `T&`.
36+
An instance of the type modifier holds a modified-type that is *T* if *T* is an lvalue reference, otherwise `T&`.
3737

3838
## Example
3939

docs/standard-library/add-pointer-class.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ The type to modify.
3333

3434
## Remarks
3535

36-
The member typedef `type` names the same type as `remove_reference<T>::type*`. The alias `add_pointer_t` is a shortcut to access the member typedef `type`.
36+
The member **typedef** `type` names the same type as `remove_reference<T>::type*`. The alias `add_pointer_t` is a shortcut to access the member **typedef** `type`.
3737

3838
Because it is invalid to make a pointer from a reference, `add_pointer` removes the reference, if any, from the specified type before it makes a pointer-to-type. Consequently, you can use a type with `add_pointer` without being concerned about whether the type is a reference.
3939

docs/standard-library/add-rvalue-reference-class.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,12 +28,12 @@ using add_rvalue_reference_t = typename add_rvalue_reference<T>::type;
2828

2929
### Parameters
3030

31-
T
31+
*T*
3232
The type to modify.
3333

3434
## Remarks
3535

36-
The `add_rvalue_reference` class has a member named `type`, which is an alias for the type of an rvalue reference to the template parameter `T`. The semantics of reference collapsing imply that, for non-object and non-function types `T`, `T&&` is a `T`. For example, when `T` is an lvalue reference type, `add_rvalue_reference<T>::type` is the lvalue reference type, not an rvalue reference.
36+
The `add_rvalue_reference` class has a member named `type`, which is an alias for the type of an rvalue reference to the template parameter *T*. The semantics of reference collapsing imply that, for non-object and non-function types *T*, `T&&` is a *T*. For example, when *T* is an lvalue reference type, `add_rvalue_reference<T>::type` is the lvalue reference type, not an rvalue reference.
3737

3838
For convenience, \<type_traits> defines a helper template, `add_rvalue_reference_t`, that aliases the `type` member of `add_rvalue_reference`.
3939

docs/standard-library/add-volatile-class.md

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

17-
Makes a volatile type from the specified type.
17+
Makes a **volatile** type from the specified type.
1818

1919
## Syntax
2020

@@ -33,7 +33,7 @@ The type to modify.
3333

3434
## Remarks
3535

36-
An instance of `add_volatile<T>` has a member typedef `type` that is *T* if *T* is a reference, a function, or a volatile-qualified type, otherwise `volatile` *T*. The alias `add_volatile_t` is a shortcut to access the member typedef `type`.
36+
An instance of `add_volatile<T>` has a member **typedef** `type` that is *T* if *T* is a reference, a function, or a volatile-qualified type, otherwise **volatile** *T*. The alias `add_volatile_t` is a shortcut to access the member **typedef** `type`.
3737

3838
## Example
3939

docs/standard-library/algorithm-functions.md

Lines changed: 420 additions & 420 deletions
Large diffs are not rendered by default.

docs/standard-library/algorithm.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -43,12 +43,12 @@ The C++ Standard Library numeric algorithms that are provided for numerical proc
4343
|Function template|Description|
4444
|-|-|
4545
|[adjacent_find](../standard-library/algorithm-functions.md#adjacent_find)|Searches for two adjacent elements that are either equal or satisfy a specified condition.|
46-
|[all_of](../standard-library/algorithm-functions.md#all_of)|Returns `true` when a condition is present at each element in the given range.|
47-
|[any_of](../standard-library/algorithm-functions.md#any_of)|Returns `true` when a condition is present at least once in the specified range of elements.|
46+
|[all_of](../standard-library/algorithm-functions.md#all_of)|Returns **true** when a condition is present at each element in the given range.|
47+
|[any_of](../standard-library/algorithm-functions.md#any_of)|Returns **true** when a condition is present at least once in the specified range of elements.|
4848
|[binary_search](../standard-library/algorithm-functions.md#binary_search)|Tests whether there is an element in a sorted range that is equal to a specified value or that is equivalent to it in a sense specified by a binary predicate.|
4949
|[copy](../standard-library/algorithm-functions.md#copy)|Assigns the values of elements from a source range to a destination range, iterating through the source sequence of elements and assigning them new positions in a forward direction.|
5050
|[copy_backward](../standard-library/algorithm-functions.md#copy_backward)|Assigns the values of elements from a source range to a destination range, iterating through the source sequence of elements and assigning them new positions in a backward direction.|
51-
|[copy_if](../standard-library/algorithm-functions.md#copy_if)|Copy all elements in a given range that test `true` for a specified condition|
51+
|[copy_if](../standard-library/algorithm-functions.md#copy_if)|Copy all elements in a given range that test **true** for a specified condition|
5252
|[copy_n](../standard-library/algorithm-functions.md#copy_n)|Copies a specified number of elements.|
5353
|[count](../standard-library/algorithm-functions.md#count)|Returns the number of elements in a range whose values match a specified value.|
5454
|[count_if](../standard-library/algorithm-functions.md#count_if)|Returns the number of elements in a range whose values match a specified condition.|
@@ -66,12 +66,12 @@ The C++ Standard Library numeric algorithms that are provided for numerical proc
6666
|[generate_n](../standard-library/algorithm-functions.md#generate_n)|Assigns the values generated by a function object to a specified number of element is a range and returns to the position one past the last assigned value.|
6767
|[includes](../standard-library/algorithm-functions.md#includes)|Tests whether one sorted range contains all the elements contained in a second sorted range, where the ordering or equivalence criterion between elements may be specified by a binary predicate.|
6868
|[inplace_merge](../standard-library/algorithm-functions.md#inplace_merge)|Combines the elements from two consecutive sorted ranges into a single sorted range, where the ordering criterion may be specified by a binary predicate.|
69-
|[is_heap](../standard-library/algorithm-functions.md#is_heap)|Returns `true` if the elements in the specified range form a heap.|
70-
|[is_heap_until](../standard-library/algorithm-functions.md#is_heap_until)|Returns `true` if the specified range forms a heap until the last element.|
71-
|[is_partitioned](../standard-library/algorithm-functions.md#is_partitioned)|Returns `true` if all the elements in the given range that test `true` for a condition come before any elements that test `false`.|
69+
|[is_heap](../standard-library/algorithm-functions.md#is_heap)|Returns **true** if the elements in the specified range form a heap.|
70+
|[is_heap_until](../standard-library/algorithm-functions.md#is_heap_until)|Returns **true** if the specified range forms a heap until the last element.|
71+
|[is_partitioned](../standard-library/algorithm-functions.md#is_partitioned)|Returns **true** if all the elements in the given range that test **true** for a condition come before any elements that test **false**.|
7272
|[is_permutation](../standard-library/algorithm-functions.md#is_permutation)|Determines whether the elements in a given range form a valid permutation.|
73-
|[is_sorted](../standard-library/algorithm-functions.md#is_sorted)|Returns `true` if the elements in the specified range are in sorted order.|
74-
|[is_sorted_until](../standard-library/algorithm-functions.md#is_sorted_until)|Returns `true` if the elements in the specified range are in sorted order.|
73+
|[is_sorted](../standard-library/algorithm-functions.md#is_sorted)|Returns **true** if the elements in the specified range are in sorted order.|
74+
|[is_sorted_until](../standard-library/algorithm-functions.md#is_sorted_until)|Returns **true** if the elements in the specified range are in sorted order.|
7575
|[iter_swap](../standard-library/algorithm-functions.md#iter_swap)|Exchanges two values referred to by a pair of specified iterators.|
7676
|[lexicographical_compare](../standard-library/algorithm-functions.md#lexicographical_compare)|Compares element by element between two sequences to determine which is lesser of the two.|
7777
|[lower_bound](../standard-library/algorithm-functions.md#lower_bound)|Finds the position of the first element in an ordered range that has a value greater than or equivalent to a specified value, where the ordering criterion may be specified by a binary predicate.|
@@ -87,12 +87,12 @@ The C++ Standard Library numeric algorithms that are provided for numerical proc
8787
|[&lt;alg&gt; move](../standard-library/algorithm-functions.md#alg_move)|Move elements associated with a specified range.|
8888
|[move_backward](../standard-library/algorithm-functions.md#move_backward)|Moves the elements of one iterator to another. The move starts with the last element in a specified range, and ends with the first element in that range.|
8989
|[next_permutation](../standard-library/algorithm-functions.md#next_permutation)|Reorders the elements in a range so that the original ordering is replaced by the lexicographically next greater permutation if it exists, where the sense of next may be specified with a binary predicate.|
90-
|[none_of](../standard-library/algorithm-functions.md#none_of)|Returns `true` when a condition is never present among elements in the given range.|
90+
|[none_of](../standard-library/algorithm-functions.md#none_of)|Returns **true** when a condition is never present among elements in the given range.|
9191
|[nth_element](../standard-library/algorithm-functions.md#nth_element)|Partitions a range of elements, correctly locating the *n*th element of the sequence in the range so that all the elements in front of it are less than or equal to it and all the elements that follow it in the sequence are greater than or equal to it.|
9292
|[partial_sort](../standard-library/algorithm-functions.md#partial_sort)|Arranges a specified number of the smaller elements in a range into a nondescending order or according to an ordering criterion specified by a binary predicate.|
9393
|[partial_sort_copy](../standard-library/algorithm-functions.md#partial_sort_copy)|Copies elements from a source range into a destination range where the source elements are ordered by either less than or another specified binary predicate.|
9494
|[partition](../standard-library/algorithm-functions.md#partition)|Classifies elements in a range into two disjoint sets, with those elements satisfying a unary predicate preceding those that fail to satisfy it.|
95-
|[partition_copy](../standard-library/algorithm-functions.md#partition_copy)|Copies elements for which a condition is `true` to one destination, and for which the condition is `false` to another. The elements must come from a specified range.|
95+
|[partition_copy](../standard-library/algorithm-functions.md#partition_copy)|Copies elements for which a condition is **true** to one destination, and for which the condition is **false** to another. The elements must come from a specified range.|
9696
|[partition_point](../standard-library/algorithm-functions.md#partition_point)|Returns the first element in the given range that does not satisfy the condition. The elements are sorted so that those that satisfy the condition come before those that do not.|
9797
|[pop_heap](../standard-library/algorithm-functions.md#pop_heap)|Removes the largest element from the front of a heap to the next-to-last position in the range and then forms a new heap from the remaining elements.|
9898
|[prev_permutation](../standard-library/algorithm-functions.md#prev_permutation)|Reorders the elements in a range so that the original ordering is replaced by the lexicographically next greater permutation if it exists, where the sense of next may be specified with a binary predicate.|

docs/standard-library/algorithms.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ The descriptions of the algorithm template functions employ several shorthand ph
2929

3030
- Expressions such as *X* - *Y*, where *X* and *Y* can be iterators other than random-access iterators, are intended in the mathematical sense. The function does not necessarily evaluate operator**-** if it must determine such a value. The same is also true for expressions such as *X* + *N* and *X* - *N*, where *N* is an integer type.
3131

32-
Several algorithms make use of a predicate that performs a pairwise comparison, such as with `operator==`, to yield a `bool` result. The predicate function `operator==`, or any replacement for it, must not alter either of its operands. It must yield the same `bool` result every time it is evaluated, and it must yield the same result if a copy of either operand is substituted for the operand.
32+
Several algorithms make use of a predicate that performs a pairwise comparison, such as with `operator==`, to yield a **bool** result. The predicate function `operator==`, or any replacement for it, must not alter either of its operands. It must yield the same **bool** result every time it is evaluated, and it must yield the same result if a copy of either operand is substituted for the operand.
3333

3434
Several algorithms make use of a predicate that must impose a strict weak ordering on pairs of elements from a sequence. For the predicate `pr`(*X*, *Y*):
3535

@@ -39,11 +39,11 @@ Several algorithms make use of a predicate that must impose a strict weak orderi
3939

4040
- Ordering means that `pr`(*X*, *Y*) && `pr`(*Y*, Z) implies `pr`(*X*, Z).
4141

42-
Some of these algorithms implicitly use the predicate *X* \< *Y*. Other predicates that typically satisfy the strict weak ordering requirement are *X* > *Y*, **less**(*X*, *Y*), and `greater`(*X*, *Y*). Note, however, that predicates such as *X* \<= *Y* and *X* >= *Y* do not satisfy this requirement.
42+
Some of these algorithms implicitly use the predicate *X* \< *Y*. Other predicates that typically satisfy the strict weak ordering requirement are *X* > *Y*, `less`(*X*, *Y*), and `greater`(*X*, *Y*). Note, however, that predicates such as *X* \<= *Y* and *X* >= *Y* do not satisfy this requirement.
4343

44-
A sequence of elements designated by iterators in the range [`First`, `Last`) is a sequence ordered by operator**<** if, for each *N* in the range [0, `Last` - `First`) and for each *M* in the range (N, `Last` - `First`) the predicate !(\*(`First` + *M*) < \*(*First* + *N*)) is true. (Note that the elements are sorted in ascending order.) The predicate function **operator<**, or any replacement for it, must not alter either of its operands. It must yield the same `bool` result every time it is evaluated, and it must yield the same result if a copy of either operand is substituted for the operand. Moreover, it must impose a strict weak ordering on the operands it compares.
44+
A sequence of elements designated by iterators in the range [`First`, `Last`) is a sequence ordered by operator**<** if, for each *N* in the range [0, `Last` - `First`) and for each *M* in the range (N, `Last` - `First`) the predicate !(\*(`First` + *M*) < \*(*First* + *N*)) is true. (Note that the elements are sorted in ascending order.) The predicate function `operator<`, or any replacement for it, must not alter either of its operands. It must yield the same `bool` result every time it is evaluated, and it must yield the same result if a copy of either operand is substituted for the operand. Moreover, it must impose a strict weak ordering on the operands it compares.
4545

46-
A sequence of elements designated by iterators in the range [`First`, `Last`) is a heap ordered by **operator<** if, for each *N* in the range [1, `Last` - `First`) the predicate !(\*`First` < \*(`First` + *N*)) is true. (The first element is the largest.) Its internal structure is otherwise known only to the template functions [make_heap](../standard-library/algorithm-functions.md#make_heap), [pop_heap](../standard-library/algorithm-functions.md#pop_heap), and [push_heap](../standard-library/algorithm-functions.md#push_heap). As with an ordered sequence, the predicate function **operator<**, or any replacement for it, must not alter either of its operands, and it must impose a strict weak ordering on the operands it compares. It must yield the same `bool` result every time it is evaluated, and it must yield the same result if a copy of either operand is substituted for the operand.
46+
A sequence of elements designated by iterators in the range [`First`, `Last`) is a heap ordered by `operator<` if, for each *N* in the range [1, `Last` - `First`) the predicate !(\*`First` < \*(`First` + *N*)) is true. (The first element is the largest.) Its internal structure is otherwise known only to the template functions [make_heap](../standard-library/algorithm-functions.md#make_heap), [pop_heap](../standard-library/algorithm-functions.md#pop_heap), and [push_heap](../standard-library/algorithm-functions.md#push_heap). As with an ordered sequence, the predicate function `operator<`, or any replacement for it, must not alter either of its operands, and it must impose a strict weak ordering on the operands it compares. It must yield the same **bool** result every time it is evaluated, and it must yield the same result if a copy of either operand is substituted for the operand.
4747

4848
The C++ Standard Library algorithms are located in the [\<algorithm>](../standard-library/algorithm.md) and [\<numeric>](../standard-library/numeric.md) header files.
4949

docs/standard-library/aligned-storage-class.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,15 +28,15 @@ using aligned_storage_t = typename aligned_storage<Len, Align>::type;
2828

2929
### Parameters
3030

31-
`Len`
31+
*Len*
3232
The object size.
3333

34-
`Align`
34+
*Align*
3535
The object alignment.
3636

3737
## Remarks
3838

39-
The template member typedef `type` is a synonym for a POD type with alignment `Align` and size `Len`. `Align` must be equal to `alignment_of<T>::value` for some type `T`, or to the default alignment.
39+
The template member typedef `type` is a synonym for a POD type with alignment *Align* and size *Len*. *Align* must be equal to `alignment_of<T>::value` for some type `T`, or to the default alignment.
4040

4141
## Example
4242

docs/standard-library/aligned-union-class.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,15 +28,15 @@ using aligned_union_t = typename aligned_union<Len, Types...>::type;
2828
2929
### Parameters
3030
31-
`Len`
31+
*Len*
3232
The alignment value for the largest type in the union.
3333
34-
`Types`
34+
*Types*
3535
The distinct types in the underlying union.
3636
3737
## Remarks
3838
39-
Use the template class to get the alignment and size needed to store a union in uninitialized storage. The member typedef `type` names a POD type suitable for storage of any type listed in `Types`; the minimum size is `Len`. The static member `alignment_value` of type `std::size_t` contains the strictest alignment required of all the types listed in `Types`.
39+
Use the template class to get the alignment and size needed to store a union in uninitialized storage. The member typedef `type` names a POD type suitable for storage of any type listed in *Types*; the minimum size is *Len*. The static member `alignment_value` of type `std::size_t` contains the strictest alignment required of all the types listed in *Types*.
4040
4141
## Example
4242

0 commit comments

Comments
 (0)