Skip to content

Commit d7df924

Browse files
authored
Merge pull request #1072 from msebolt/format-standard-pr13
format standard pr13
2 parents 9b7ee2e + 87efa2f commit d7df924

30 files changed

+379
-379
lines changed

docs/standard-library/reverse-iterator-class.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -253,7 +253,7 @@ reverse_iterator<RandomIterator> operator+(difference_type Off) const;
253253

254254
### Parameters
255255

256-
`Off`
256+
*Off*
257257
The offset to be added to the reverse iterator.
258258

259259
### Return Value
@@ -402,7 +402,7 @@ reverse_iterator<RandomIterator>& operator+=(difference_type Off);
402402

403403
### Parameters
404404

405-
`Off`
405+
*Off*
406406
The offset by which to increment the iterator.
407407

408408
### Return Value
@@ -475,7 +475,7 @@ reverse_iterator<RandomIterator> operator-(difference_type Off) const;
475475

476476
### Parameters
477477

478-
`Off`
478+
*Off*
479479
The offset to be subtracted from the reverse_iterator.
480480

481481
### Return Value
@@ -625,7 +625,7 @@ reverse_iterator<RandomIterator>& operator-=(difference_type Off);
625625

626626
### Parameters
627627

628-
`Off`
628+
*Off*
629629
The offset to be subtracted from the `reverse_iterator`.
630630

631631
### Remarks
@@ -779,7 +779,7 @@ reference operator[](difference_type Off) const;
779779

780780
### Parameters
781781

782-
`Off`
782+
*Off*
783783
The offset from the `reverse_iterator` address.
784784

785785
### Return Value
@@ -933,7 +933,7 @@ The type is a synonym for the iterator trait typename `iterator_traits`\< *Rando
933933

934934
### Example
935935

936-
See [reverse_iterator::operator&#91;&#93;](#op_at) or [reverse_iterator::operator*](#op_star) for examples of how to declare and use **reference**.
936+
See [reverse_iterator::operator&#91;&#93;](#op_at) or [reverse_iterator::operator*](#op_star) for examples of how to declare and use `reference`.
937937

938938
## <a name="reverse_iterator"></a> reverse_iterator::reverse_iterator
939939

@@ -949,7 +949,7 @@ reverse_iterator(const reverse_iterator<Type>& right);
949949
950950
### Parameters
951951
952-
`right`
952+
*right*
953953
The iterator that is to be adapted to a `reverse_iterator`.
954954
955955
### Return Value

docs/standard-library/rts-alloc-class.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ class rts_alloc
2727
2828
|Parameter|Description|
2929
|---------------|-----------------|
30-
|`Cache`|The type of cache instances contained in the array. This can be [cache_chunklist Class](../standard-library/cache-chunklist-class.md), [cache_freelist](../standard-library/cache-freelist-class.md), or [cache_suballoc](../standard-library/cache-suballoc-class.md).|
30+
|*Cache*|The type of cache instances contained in the array. This can be [cache_chunklist Class](../standard-library/cache-chunklist-class.md), [cache_freelist](../standard-library/cache-freelist-class.md), or [cache_suballoc](../standard-library/cache-suballoc-class.md).|
3131
3232
## Remarks
3333
@@ -59,15 +59,15 @@ void *allocate(std::size_t count);
5959

6060
|Parameter|Description|
6161
|---------------|-----------------|
62-
|`count`|The number of elements in the array to be allocated.|
62+
|*count*|The number of elements in the array to be allocated.|
6363

6464
### Return Value
6565

6666
A pointer to the allocated object.
6767

6868
### Remarks
6969

70-
The member function returns `caches[_IDX].allocate(count)`, where the index `_IDX` is determined by the requested block size `count`, or, if `count` is too large, it returns `operator new(count)`. `cache`, which represents the cache object.
70+
The member function returns `caches[_IDX].allocate(count)`, where the index `_IDX` is determined by the requested block size *count*, or, if *count* is too large, it returns `operator new(count)`. `cache`, which represents the cache object.
7171

7272
## <a name="deallocate"></a> rts_alloc::deallocate
7373

@@ -81,12 +81,12 @@ void deallocate(void* ptr, std::size_t count);
8181
8282
|Parameter|Description|
8383
|---------------|-----------------|
84-
|`ptr`|A pointer to the first object to be deallocated from storage.|
85-
|`count`|The number of objects to be deallocated from storage.|
84+
|*ptr*|A pointer to the first object to be deallocated from storage.|
85+
|*count*|The number of objects to be deallocated from storage.|
8686
8787
### Remarks
8888
89-
The member function calls `caches[_IDX].deallocate(ptr, count)`, where the index `_IDX` is determined by the requested block size `count`, or, if `count` is too large, it returns `operator delete(ptr)`.
89+
The member function calls `caches[_IDX].deallocate(ptr, count)`, where the index `_IDX` is determined by the requested block size *count*, or, if *count* is too large, it returns `operator delete(ptr)`.
9090
9191
## <a name="equals"></a> rts_alloc::equals
9292
@@ -100,12 +100,12 @@ bool equals(const sync<_Cache>& _Other) const;
100100

101101
|Parameter|Description|
102102
|---------------|-----------------|
103-
|`_Cache`|The cache object associated with the filter.|
104-
|`_Other`|The cache object to compare for equality.|
103+
|*_Cache*|The cache object associated with the filter.|
104+
|*_Other*|The cache object to compare for equality.|
105105

106106
### Remarks
107107

108-
`true` if the result of `caches[0].equals(other.caches[0])`; otherwise, `false`. `caches` represents the array of cache objects.
108+
**true** if the result of `caches[0].equals(other.caches[0])`; otherwise, **false**. `caches` represents the array of cache objects.
109109

110110
## See also
111111

docs/standard-library/sample-container-class.md

+12-12
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,13 @@ ms.workload: ["cplusplus"]
1616
> [!NOTE]
1717
> This topic is in the Visual C++ documentation as a nonfunctional example of containers used in the C++ Standard Library. For more information, see [C++ Standard Library Containers](../standard-library/stl-containers.md).
1818
19-
Describes an object that controls a varying-length sequence of elements, typically of type **Ty**. The sequence is stored in different ways, depending on the actual container.
19+
Describes an object that controls a varying-length sequence of elements, typically of type `Ty`. The sequence is stored in different ways, depending on the actual container.
2020

2121
A container constructor or member function may find occasion to call the constructor **Ty**(**const Ty&**) or the function **Ty::operator=**(**const Ty&**). If such a call throws an exception, the container object is obliged to maintain its integrity, and to rethrow any exception it catches. You can safely swap, assign to, erase, or destroy a container object after it throws one of these exceptions. In general, however, you cannot otherwise predict the state of the sequence controlled by the container object.
2222

2323
A few additional caveats:
2424

25-
- If the expression **~Ty** throws an exception, the resulting state of the container object is undefined.
25+
- If the expression `~Ty` throws an exception, the resulting state of the container object is undefined.
2626

2727
- If the container stores an allocator object *al*, and *al* throws an exception other than as a result of a call to *al***.allocate**, the resulting state of the container object is undefined.
2828

@@ -32,9 +32,9 @@ The container classes defined by C++ Standard Library satisfy several additional
3232

3333
Container template class [list](../standard-library/list-class.md) provides deterministic, and useful, behavior even in the presence of the exceptions described above. For example, if an exception is thrown during the insertion of one or more elements, the container is left unaltered and the exception is rethrown.
3434

35-
For *all* the container classes defined by C++ Standard Library, if an exception is thrown during calls to the following member functions, **insert**, **push_back**, or **push_front**, the container is left unaltered and the exception is rethrown.
35+
For *all* the container classes defined by C++ Standard Library, if an exception is thrown during calls to the following member functions, `insert`, `push_back`, or `push_front`, the container is left unaltered and the exception is rethrown.
3636

37-
For *all* the container classes defined by C++ Standard Library, no exception is thrown during calls to the following member functions: **pop_back**, **pop_front**.
37+
For *all* the container classes defined by C++ Standard Library, no exception is thrown during calls to the following member functions: `pop_back`, `pop_front`.
3838

3939
The member function [erase](../standard-library/container-class-erase.md) throws an exception only if a copy operation (assignment or copy construction) throws an exception.
4040

@@ -46,29 +46,29 @@ The member function [swap](../standard-library/container-class-swap.md) makes ad
4646

4747
- References, pointers, and iterators that designate elements of the controlled sequences being swapped remain valid.
4848

49-
An object of a container class defined by C++ Standard Library allocates and frees storage for the sequence it controls through a stored object of type `Alloc`, which is typically a template parameter. Such an allocator object must have the same external interface as an object of class **allocator\<Ty>**. In particular, `Alloc` must be the same type as **Alloc::rebind<value_type>::other**
49+
An object of a container class defined by C++ Standard Library allocates and frees storage for the sequence it controls through a stored object of type `Alloc`, which is typically a template parameter. Such an allocator object must have the same external interface as an object of class `allocator<Ty>`. In particular, `Alloc` must be the same type as `Alloc::rebind<value_type>::other`
5050

51-
For *all* container classes defined by C++ Standard Library, the member function **Alloc get_allocator const;** returns a copy of the stored allocator object. Note that the stored allocator object is *not* copied when the container object is assigned. All constructors initialize the value stored in **allocator**, to `Alloc` if the constructor contains no allocator parameter.
51+
For *all* container classes defined by C++ Standard Library, the member function `Alloc get_allocator const;` returns a copy of the stored allocator object. Note that the stored allocator object is *not* copied when the container object is assigned. All constructors initialize the value stored in `allocator`, to `Alloc` if the constructor contains no allocator parameter.
5252

5353
According to the C++ Standard, a container class defined by the C++ Standard Library can assume that:
5454

5555
- All objects of class `Alloc` compare equal.
5656

57-
- Type **Alloc::const_pointer** is the same as **const Ty \***.
57+
- Type `Alloc::const_pointer` is the same as `const Ty *`.
5858

59-
- Type **Alloc::const_reference** is the same as **const Ty&**.
59+
- Type `Alloc::const_reference` is the same as `const Ty&`.
6060

61-
- Type **Alloc::pointer** is the same as **Ty \***.
61+
- Type `Alloc::pointer` is the same as `Ty *`.
6262

63-
- Type **Alloc::reference** is the same as **Ty&**.
63+
- Type `Alloc::reference` is the same as `Ty&`.
6464

6565
In this implementation, however, containers do not make such simplifying assumptions. Thus, they work properly with allocator objects that are more ambitious:
6666

6767
- All objects of class `Alloc` does not need to compare equal. (You can maintain multiple pools of storage.)
6868

69-
- Type **Alloc::const_pointer** does not need to be the same as **const Ty \***. (A const pointer can be a class.)
69+
- Type `Alloc::const_pointer` does not need to be the same as `const Ty *`. (A const pointer can be a class.)
7070

71-
- Type **Alloc::pointer** does not need to be the same as **Ty \***. (A pointer can be a class.)
71+
- Type `Alloc::pointer` does not need to be the same as `Ty *`. (A pointer can be a class.)
7272

7373
## Requirements
7474

docs/standard-library/sample-container-members.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ ms.workload: ["cplusplus"]
3030
|[reference](../standard-library/container-class-reference.md)|Describes an object that can serve as a reference to an element of the controlled sequence.|
3131
|[reverse_iterator](../standard-library/container-class-reverse-iterator.md)|Describes an object that can serve as a reverse iterator for the controlled sequence.|
3232
|[size_type](../standard-library/container-class-size-type.md)|Describes an object that can represent the length of any controlled sequence.|
33-
|[value_type](../standard-library/container-class-value-type.md)|Acts a synonym for the template parameter **Ty**.|
33+
|[value_type](../standard-library/container-class-value-type.md)|Acts a synonym for the template parameter `Ty`.|
3434

3535
## Member Functions
3636

docs/standard-library/scl-secure-no-warnings.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ ms.workload: ["cplusplus"]
1414
---
1515
# _SCL_SECURE_NO_WARNINGS
1616

17-
Calling any of the potentially unsafe methods in the C++ Standard Library results in [Compiler Warning (level 3) C4996](../error-messages/compiler-warnings/compiler-warning-level-3-c4996.md). To disable this warning, define the macro **_SCL_SECURE_NO_WARNINGS** in your code:
17+
Calling any of the potentially unsafe methods in the C++ Standard Library results in [Compiler Warning (level 3) C4996](../error-messages/compiler-warnings/compiler-warning-level-3-c4996.md). To disable this warning, define the macro _SCL_SECURE_NO_WARNINGS in your code:
1818

1919
```cpp
2020
#define _SCL_SECURE_NO_WARNINGS

docs/standard-library/scoped-allocator-adaptor-class.md

+17-17
Original file line numberDiff line numberDiff line change
@@ -103,10 +103,10 @@ pointer allocate(size_type count);pointer allocate(size_type count, const_void_p
103103

104104
### Parameters
105105

106-
`count`
106+
*count*
107107
The number of elements for which sufficient storage is to be allocated.
108108

109-
`hint`
109+
*hint*
110110
A pointer that might assist the allocator object by locating the address of an object allocated prior to the request.
111111

112112
### Return Value
@@ -142,32 +142,32 @@ void construct(pair<Ty1, Ty2>* ptr, pair<Uy1, Uy2>&& right);
142142
143143
### Parameters
144144
145-
`ptr`
145+
*ptr*
146146
A pointer to the memory location where the object is to be constructed.
147147
148-
`args`
148+
*args*
149149
A list of arguments.
150150
151-
`first`
151+
*first*
152152
An object of the first type in a pair.
153153
154-
`second`
154+
*second*
155155
An object of the second type in a pair.
156156
157-
`right`
157+
*right*
158158
An existing object to be moved or copied.
159159
160160
### Remarks
161161
162-
The first method constructs the object at `ptr` by calling `Outermost_traits::construct(OUTERMOST(*this), ptr, xargs...)`, where `xargs...` is one of the following.
162+
The first method constructs the object at *ptr* by calling `Outermost_traits::construct(OUTERMOST(*this), ptr, xargs...)`, where `xargs...` is one of the following.
163163
164164
- If `uses_allocator<Ty, inner_allocator_type>` holds false, then `xargs...` is `args...`.
165165
166166
- If `uses_allocator<Ty, inner_allocator_type>` holds true, and `is_constructible<Ty, allocator_arg_t, inner_allocator_type, args...>` holds true, then `xargs...` is `allocator_arg, inner_allocator(), args...`.
167167
168168
- If `uses_allocator<Ty, inner_allocator_type>` holds true, and `is_constructible<Ty, args..., inner_allocator()>` holds true, then `xargs...` is `args..., inner_allocator()`.
169169
170-
The second method constructs the pair object at `ptr` by calling `Outermost_traits::construct(OUTERMOST(*this), &ptr->first, xargs...)`, where `xargs...` is `first...` modified as in the above list, and `Outermost_traits::construct(OUTERMOST(*this), &ptr->second, xargs...)`, where `xargs...` is `second...` modified as in the above list.
170+
The second method constructs the pair object at *ptr* by calling `Outermost_traits::construct(OUTERMOST(*this), &ptr->first, xargs...)`, where `xargs...` is `first...` modified as in the above list, and `Outermost_traits::construct(OUTERMOST(*this), &ptr->second, xargs...)`, where `xargs...` is `second...` modified as in the above list.
171171
172172
The third method behaves the same as `this->construct(ptr, piecewise_construct, tuple<>, tuple<>)`.
173173
@@ -187,10 +187,10 @@ void deallocate(pointer ptr, size_type count);
187187

188188
### Parameters
189189

190-
`ptr`
190+
*ptr*
191191
A pointer to the starting location of the objects to be deallocated.
192192

193-
`count`
193+
*count*
194194
The number of objects to deallocate.
195195

196196
## <a name="destroy"></a> scoped_allocator_adaptor::destroy
@@ -204,7 +204,7 @@ void destroy(Ty* ptr)
204204
205205
### Parameters
206206
207-
`ptr`
207+
*ptr*
208208
A pointer to the object to be destroyed.
209209
210210
### Return Value
@@ -280,18 +280,18 @@ scoped_allocator_adaptor(Outer2&& al,
280280
281281
### Parameters
282282
283-
`right`
283+
*right*
284284
An existing `scoped_allocator_adaptor`.
285285
286-
`al`
286+
*al*
287287
An existing allocator to be used as the outer allocator.
288288
289-
`rest`
289+
*rest*
290290
A list of allocators to be used as the inner allocators.
291291
292292
### Remarks
293293
294-
The first constructor default constructs its stored allocator objects. Each of the next three constructors constructs its stored allocator objects from the corresponding objects in `right`. The last constructor constructs its stored allocator objects from the corresponding arguments in the argument list.
294+
The first constructor default constructs its stored allocator objects. Each of the next three constructors constructs its stored allocator objects from the corresponding objects in *right*. The last constructor constructs its stored allocator objects from the corresponding arguments in the argument list.
295295
296296
## <a name="select_on_container_copy_construction"></a> scoped_allocator_adaptor::select_on_container_copy_construction
297297
@@ -303,7 +303,7 @@ scoped_allocator_adaptor select_on_container_copy_construction();
303303

304304
### Return Value
305305

306-
This method effectively returns `scoped_allocator_adaptor(Outer_traits::select_on_container_copy_construction(*this), inner_allocator().select_on_container_copy_construction())`. The result is a new `scoped_allocator_adaptor` object with each stored allocator object initialized by calling `al.select_on_container_copy_construction()` for the corresponding allocator `al`.
306+
This method effectively returns `scoped_allocator_adaptor(Outer_traits::select_on_container_copy_construction(*this), inner_allocator().select_on_container_copy_construction())`. The result is a new `scoped_allocator_adaptor` object with each stored allocator object initialized by calling `al.select_on_container_copy_construction()` for the corresponding allocator *al*.
307307

308308
## See also
309309

docs/standard-library/scoped-allocator-operators.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -26,10 +26,10 @@ bool operator!=(
2626
2727
### Parameters
2828
29-
`left`
29+
*left*
3030
The left `scoped_allocator_adaptor` object.
3131
32-
`right`
32+
*right*
3333
The right `scoped_allocator_adaptor` object.
3434
3535
### Return Value
@@ -49,10 +49,10 @@ bool operator==(
4949

5050
### Parameters
5151

52-
`left`
52+
*left*
5353
The left `scoped_allocator_adaptor` object.
5454

55-
`right`
55+
*right*
5656
The right `scoped_allocator_adaptor` object.
5757

5858
### Return Value

docs/standard-library/secure-scl.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -17,17 +17,17 @@ ms.workload: ["cplusplus"]
1717
Superseded by [_ITERATOR_DEBUG_LEVEL](../standard-library/iterator-debug-level.md), this macro defines whether [Checked Iterators](../standard-library/checked-iterators.md) are enabled. By default, checked iterators are enabled in Debug builds, and disabled in Retail builds.
1818

1919
> [!IMPORTANT]
20-
> Direct use of the `_SECURE_SCL` macro is deprecated. Instead, use `_ITERATOR_DEBUG_LEVEL` to control checked iterator settings. For more information, see [_ITERATOR_DEBUG_LEVEL](../standard-library/iterator-debug-level.md).
20+
> Direct use of the _SECURE_SCL macro is deprecated. Instead, use _ITERATOR_DEBUG_LEVEL to control checked iterator settings. For more information, see [_ITERATOR_DEBUG_LEVEL](../standard-library/iterator-debug-level.md).
2121
2222
## Remarks
2323

24-
When checked iterators are enabled, unsafe iterator use causes a runtime error and the program is terminated. To enable checked iterators, set `_ITERATOR_DEBUG_LEVEL` to 1 or 2. This is equivalent to a `_SECURE_SCL` setting of 1, or enabled:
24+
When checked iterators are enabled, unsafe iterator use causes a runtime error and the program is terminated. To enable checked iterators, set _ITERATOR_DEBUG_LEVEL to 1 or 2. This is equivalent to a _SECURE_SCL setting of 1, or enabled:
2525

2626
```cpp
2727
#define _ITERATOR_DEBUG_LEVEL 1
2828
```
2929
30-
To disable checked iterators, set `_ITERATOR_DEBUG_LEVEL` to 0. This is equivalent to a `_SECURE_SCL` setting of 0, or disabled:
30+
To disable checked iterators, set _ITERATOR_DEBUG_LEVEL to 0. This is equivalent to a _SECURE_SCL setting of 0, or disabled:
3131
3232
```cpp
3333
#define _ITERATOR_DEBUG_LEVEL 0

0 commit comments

Comments
 (0)