Skip to content

Commit 2e62d62

Browse files
authored
Merge pull request #1073 from msebolt/format-standard-pr14
format standard pr14
2 parents d7df924 + a62f9b8 commit 2e62d62

30 files changed

+310
-309
lines changed

docs/standard-library/strstream-class.md

+11-11
Original file line numberDiff line numberDiff line change
@@ -60,16 +60,16 @@ void freeze(bool _Freezeit = true);
6060

6161
### Parameters
6262

63-
`_Freezeit`
64-
A `bool` indicating whether you want the stream to be frozen.
63+
*_Freezeit*
64+
A **bool** indicating whether you want the stream to be frozen.
6565

6666
### Remarks
6767

6868
The member function calls [rdbuf](#rdbuf) -> [freeze](../standard-library/strstreambuf-class.md#freeze)(_ *Freezeit*).
6969

7070
### Example
7171

72-
See [strstreambuf::freeze](../standard-library/strstreambuf-class.md#freeze) for an example that uses **freeze**.
72+
See [strstreambuf::freeze](../standard-library/strstreambuf-class.md#freeze) for an example that uses `freeze`.
7373

7474
## <a name="pcount"></a> strstream::pcount
7575

@@ -105,7 +105,7 @@ A pointer to the stream's associated strstreambuf object.
105105
106106
### Remarks
107107
108-
The member function returns the address of the stored stream buffer of type **pointer** to [strstreambuf](../standard-library/strstreambuf-class.md).
108+
The member function returns the address of the stored stream buffer of type `pointer` to [strstreambuf](../standard-library/strstreambuf-class.md).
109109
110110
### Example
111111
@@ -129,7 +129,7 @@ The member function returns [rdbuf](#rdbuf) -> [str](../standard-library/strstre
129129
130130
### Example
131131
132-
See [strstreambuf::str](../standard-library/strstreambuf-class.md#str) for a sample that uses **str**.
132+
See [strstreambuf::str](../standard-library/strstreambuf-class.md#str) for a sample that uses `str`.
133133
134134
## <a name="strstream"></a> strstream::strstream
135135
@@ -145,22 +145,22 @@ strstream(char* ptr,
145145
146146
### Parameters
147147
148-
`count`
148+
*count*
149149
The size of the buffer.
150150
151-
`_Mode`
151+
*_Mode*
152152
The input and output mode of the buffer. See [ios_base::openmode](../standard-library/ios-base-class.md#openmode) for more information.
153153
154-
`ptr`
154+
*ptr*
155155
The buffer.
156156
157157
### Remarks
158158
159-
Both constructors initialize the base class by calling [streambuf](../standard-library/streambuf-typedefs.md#streambuf)( **sb**), where **sb** is the stored object of class [strstreambuf](../standard-library/strstreambuf-class.md). The first constructor also initializes **sb** by calling [strstreambuf](../standard-library/strstreambuf-class.md#strstreambuf). The second constructor initializes the base class one of two ways:
159+
Both constructors initialize the base class by calling [streambuf](../standard-library/streambuf-typedefs.md#streambuf)( **sb**), where `sb` is the stored object of class [strstreambuf](../standard-library/strstreambuf-class.md). The first constructor also initializes `sb` by calling [strstreambuf](../standard-library/strstreambuf-class.md#strstreambuf). The second constructor initializes the base class one of two ways:
160160
161-
- If `_Mode` & **ios_base::app**== 0, then `ptr` must designate the first element of an array of `count` elements, and the constructor calls `strstreambuf`( `ptr`, `count`, `ptr`).
161+
- If `_Mode` & **ios_base::app**== 0, then *ptr* must designate the first element of an array of `count` elements, and the constructor calls `strstreambuf`( `ptr`, `count`, `ptr`).
162162
163-
- Otherwise, `ptr` must designate the first element of an array of count elements that contains a C string whose first element is designated by `ptr`, and the constructor calls `strstreambuf`( `ptr`, `count`, `ptr` + `strlen`( `ptr`) ).
163+
- Otherwise, *ptr* must designate the first element of an array of count elements that contains a C string whose first element is designated by *ptr*, and the constructor calls `strstreambuf`( `ptr`, `count`, `ptr` + `strlen`( `ptr`) ).
164164
165165
## See also
166166

docs/standard-library/strstream.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ ms.workload: ["cplusplus"]
1414
---
1515
# &lt;strstream&gt;
1616

17-
Defines several classes that support iostreams operations on sequences stored in an allocated array of `char` object. Such sequences are easily converted to and from C strings.
17+
Defines several classes that support iostreams operations on sequences stored in an allocated array of **char** object. Such sequences are easily converted to and from C strings.
1818

1919
## Syntax
2020

@@ -34,7 +34,7 @@ Objects of type `strstream` work with `char` *, which are C strings. Use [\<sstr
3434

3535
|Class|Description|
3636
|-|-|
37-
|[strstreambuf Class](../standard-library/strstreambuf-class.md)|The class describes a stream buffer that controls the transmission of elements to and from a sequence of elements stored in a `char` array object.|
37+
|[strstreambuf Class](../standard-library/strstreambuf-class.md)|The class describes a stream buffer that controls the transmission of elements to and from a sequence of elements stored in a **char** array object.|
3838
|[istrstream Class](../standard-library/istrstream-class.md)|The class describes an object that controls extraction of elements and encoded objects from a stream buffer of class [strstreambuf](../standard-library/strstreambuf-class.md).|
3939
|[ostrstream Class](../standard-library/ostrstream-class.md)|The class describes an object that controls insertion of elements and encoded objects into a stream buffer of class [strstreambuf](../standard-library/strstreambuf-class.md).|
4040
|[strstream Class](../standard-library/strstream-class.md)|The class describes an object that controls insertion and extraction of elements and encoded objects using a stream buffer of class [strstreambuf](../standard-library/strstreambuf-class.md).|

docs/standard-library/strstreambuf-class.md

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

17-
Describes a stream buffer that controls the transmission of elements to and from a sequence of elements stored in a `char` array object.
17+
Describes a stream buffer that controls the transmission of elements to and from a sequence of elements stored in a **char** array object.
1818

1919
## Syntax
2020

@@ -78,12 +78,12 @@ void freeze(bool _Freezeit = true);
7878

7979
### Parameters
8080

81-
`_Freezeit`
82-
A `bool` indicating whether you want the stream to be frozen.
81+
*_Freezeit*
82+
A **bool** indicating whether you want the stream to be frozen.
8383

8484
### Remarks
8585

86-
If `_Freezeit` is true, the function alters the stored `strstreambuf` mode to make the controlled sequence frozen. Otherwise, it makes the controlled sequence not frozen.
86+
If *_Freezeit* is true, the function alters the stored `strstreambuf` mode to make the controlled sequence frozen. Otherwise, it makes the controlled sequence not frozen.
8787

8888
[str](#str) implies `freeze`.
8989

@@ -166,7 +166,7 @@ virtual int overflow(int _Meta = EOF);
166166
167167
### Parameters
168168
169-
`_Meta`
169+
*_Meta*
170170
The character to insert into the buffer, or `EOF`.
171171
172172
### Return Value
@@ -191,7 +191,7 @@ virtual int pbackfail(int _Meta = EOF);
191191

192192
### Parameters
193193

194-
`_Meta`
194+
*_Meta*
195195
The character to insert into the buffer, or `EOF`.
196196

197197
### Return Value
@@ -204,9 +204,9 @@ The protected virtual member function tries to put back an element into the inpu
204204

205205
If _ *Meta* == `EOF`, the element to push back is effectively the one already in the stream before the current element. Otherwise, that element is replaced by **ch** = ( `char`)\_ *Meta*. The function can put back an element in various ways:
206206

207-
- If a putback position is available, and the element stored there compares equal to **ch**, it can decrement the next pointer for the input buffer.
207+
- If a putback position is available, and the element stored there compares equal to `ch`, it can decrement the next pointer for the input buffer.
208208

209-
- If a putback position is available, and if the strstreambuf mode says the controlled sequence is modifiable, the function can store **ch** into the putback position and decrement the next pointer for the input buffer.
209+
- If a putback position is available, and if the strstreambuf mode says the controlled sequence is modifiable, the function can store `ch` into the putback position and decrement the next pointer for the input buffer.
210210

211211
## <a name="pcount"></a> strstreambuf::pcount
212212

@@ -255,13 +255,13 @@ virtual streampos seekoff(streamoff _Off,
255255

256256
### Parameters
257257

258-
`_Off`
259-
The position to seek for relative to `_Way`.
258+
*_Off*
259+
The position to seek for relative to *_Way*.
260260

261-
`_Way`
261+
*_Way*
262262
The starting point for offset operations. See [seekdir](../standard-library/ios-base-class.md#seekdir) for possible values.
263263

264-
`_Which`
264+
*_Which*
265265
Specifies the mode for the pointer position. The default is to allow you to modify the read and write positions.
266266

267267
### Return Value
@@ -294,10 +294,10 @@ virtual streampos seekpos(streampos _Sp, ios_base::openmode _Which = ios_base::i
294294
295295
### Parameters
296296
297-
`_Sp`
297+
*_Sp*
298298
The position to seek for.
299299
300-
`_Which`
300+
*_Which*
301301
Specifies the mode for the pointer position. The default is to allow you to modify the read and write positions.
302302
303303
### Return Value
@@ -364,24 +364,24 @@ strstreambuf(const unsigned char* _Getptr,
364364
365365
### Parameters
366366
367-
*_Allocfunc*
367+
*_Allocfunc*
368368
The function used to allocate buffer memory.
369369
370-
`count`
371-
Determines the length of the buffer pointed to by `_Getptr`. If `_Getptr` is not an argument (first constructor form), a suggested allocation size for the buffers.
370+
*count*
371+
Determines the length of the buffer pointed to by *_Getptr*. If *_Getptr* is not an argument (first constructor form), a suggested allocation size for the buffers.
372372
373-
*_Freefunc*
373+
*_Freefunc*
374374
The function used to free buffer memory.
375375
376-
`_Getptr`
376+
*_Getptr*
377377
A buffer used for input.
378378
379-
`_Putptr`
379+
*_Putptr*
380380
A buffer used for output.
381381
382382
### Remarks
383383
384-
The first constructor stores a null pointer in all the pointers controlling the input buffer, the output buffer, and strstreambuf allocation. It sets the stored strstreambuf mode to make the controlled sequence modifiable and extendable. It also accepts `count` as a suggested initial allocation size.
384+
The first constructor stores a null pointer in all the pointers controlling the input buffer, the output buffer, and strstreambuf allocation. It sets the stored strstreambuf mode to make the controlled sequence modifiable and extendable. It also accepts *count* as a suggested initial allocation size.
385385
386386
The second constructor behaves like the first, except that it stores _ *Allocfunc* as the pointer to the function to call to allocate storage and \_ *Freefunc* as the pointer to the function to call to free that storage.
387387
@@ -465,7 +465,7 @@ If the function cannot succeed, it returns `EOF`. Otherwise, it returns the curr
465465

466466
### Remarks
467467

468-
The protected virtual member function endeavors to extract the current element **ch** from the input buffer, then advance the current stream position, and return the element as (`int`)(`unsigned char`) **ch**. It can do so in only one way: if a read position is available, it takes **ch** as the element stored in the read position and advances the next pointer for the input buffer.
468+
The protected virtual member function endeavors to extract the current element `ch` from the input buffer, then advance the current stream position, and return the element as (`int`)(`unsigned char`) **ch**. It can do so in only one way: if a read position is available, it takes `ch` as the element stored in the read position and advances the next pointer for the input buffer.
469469

470470
## See also
471471

docs/standard-library/student-t-distribution-class.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -49,11 +49,11 @@ public:
4949
### Parameters
5050
5151
*RealType*
52-
The floating-point result type, defaults to `double`. For possible types, see [\<random>](../standard-library/random.md).
52+
The floating-point result type, defaults to **double**. For possible types, see [\<random>](../standard-library/random.md).
5353
5454
## Remarks
5555
56-
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 Student's *t*-Distribution. The following table links to articles about individual members.
56+
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 Student's *t*-Distribution. The following table links to articles about individual members.
5757
5858
||||
5959
|-|-|-|
@@ -158,7 +158,7 @@ explicit student_t_distribution(const param_type& parm);
158158
159159
### Parameters
160160
161-
*n*
161+
*n*
162162
The `n` distribution parameter.
163163
164164
*parm*
@@ -189,10 +189,10 @@ struct param_type {
189189

190190
### Parameters
191191

192-
*n*
192+
*n*
193193
The `n` distribution parameter.
194194

195-
*right*
195+
*right*
196196
The `param_type` object to compare to this.
197197

198198
### Remarks

docs/standard-library/sub-match-class.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ public:
4040
4141
### Parameters
4242
43-
`BidIt`
43+
*BidIt*
4444
The iterator type for submatches.
4545
4646
## Remarks
@@ -73,13 +73,13 @@ int compare(const value_type *ptr) const;
7373

7474
### Parameters
7575

76-
`right`
76+
*right*
7777
The submatch to compare to.
7878

79-
`str`
79+
*str*
8080
The string to compare to.
8181

82-
`ptr`
82+
*ptr*
8383
The null-terminated sequence to compare to.
8484

8585
### Remarks
@@ -352,7 +352,7 @@ bool matched;
352352

353353
### Remarks
354354

355-
The member holds `true` only if the capture group associated with `*this` was part of the regular expression match.
355+
The member holds **true** only if the capture group associated with `*this` was part of the regular expression match.
356356

357357
### Example
358358

docs/standard-library/subtract-with-carry-engine-class.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -25,16 +25,16 @@ class subtract_with_carry_engine;
2525
2626
### Parameters
2727
28-
`UIntType`
28+
*UIntType*
2929
The unsigned integer result type. For possible types, see [\<random>](../standard-library/random.md).
3030
31-
`W`
31+
*W*
3232
**Word size**. Size of each word, in bits, of the state sequence. **Precondition**: `0 < W ≤ numeric_limits<UIntType>::digits`
3333
34-
`S`
34+
*S*
3535
**Short lag**. Number of integer values. **Precondition**: `0 < S < R`
3636
37-
`R`
37+
*R*
3838
**Long lag**. Determines recurrence in the series generated.
3939
4040
## Members
@@ -51,7 +51,7 @@ For more information about engine members, see [\<random>](../standard-library/r
5151
5252
The `substract_with_carry_engine` template class is an improvement over the [linear_congruential_engine](../standard-library/linear-congruential-engine-class.md). Neither for these engines is as fast or with as high quality results as the [mersenne_twister_engine](../standard-library/mersenne-twister-engine-class.md).
5353
54-
This engine produces values of a user-specified unsigned integral type using the recurrence relation ( *period*) `x(i) = (x(i - R) - x(i - S) - cy(i - 1)) mod M`, where `cy(i)` has the value `1` if `x(i - S) - x(i - R) - cy(i - 1) < 0`, otherwise `0`, and `M` has the value `2`<sup>W</sup>. The engine's state is a carry indicator plus `R` values. These values consist of the last `R` values returned if `operator()` has been called at least `R` times, otherwise the `N` values that have been returned and the last `R - N` values of the seed.
54+
This engine produces values of a user-specified unsigned integral type using the recurrence relation ( *period*) `x(i) = (x(i - R) - x(i - S) - cy(i - 1)) mod M`, where `cy(i)` has the value `1` if `x(i - S) - x(i - R) - cy(i - 1) < 0`, otherwise `0`, and `M` has the value `2`<sup>W</sup>. The engine's state is a carry indicator plus *R* values. These values consist of the last *R* values returned if `operator()` has been called at least *R* times, otherwise the `N` values that have been returned and the last `R - N` values of the seed.
5555
5656
The template argument `UIntType` must be large enough to hold values up to `M - 1`.
5757

docs/standard-library/sync-none-class.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ void *allocate(std::size_t count);
5555

5656
|Parameter|Description|
5757
|---------------|-----------------|
58-
|`count`|The number of elements in the array to be allocated.|
58+
|*count*|The number of elements in the array to be allocated.|
5959

6060
### Remarks
6161

@@ -73,8 +73,8 @@ void deallocate(void* ptr, std::size_t count);
7373
7474
|Parameter|Description|
7575
|---------------|-----------------|
76-
|`ptr`|A pointer to the first object to be deallocated from storage.|
77-
|`count`|The number of objects to be deallocated from storage.|
76+
|*ptr*|A pointer to the first object to be deallocated from storage.|
77+
|*count*|The number of objects to be deallocated from storage.|
7878
7979
### Remarks
8080
@@ -92,12 +92,12 @@ bool equals(const sync<Cache>& Other) const;
9292

9393
|Parameter|Description|
9494
|---------------|-----------------|
95-
|`Cache`|The cache object of the synchronization filter.|
96-
|`Other`|The cache object to compare for equality.|
95+
|*Cache*|The cache object of the synchronization filter.|
96+
|*Other*|The cache object to compare for equality.|
9797

9898
### Return Value
9999

100-
The member function always returns `true`.
100+
The member function always returns **true**.
101101

102102
### Remarks
103103

docs/standard-library/sync-per-container-class.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ class sync_per_container
2828
2929
|Parameter|Description|
3030
|---------------|-----------------|
31-
|`Cache`|The type of cache associated with the synchronization filter. This can be [cache_chunklist](../standard-library/cache-chunklist-class.md), [cache_freelist](../standard-library/cache-freelist-class.md), or [cache_suballoc](../standard-library/cache-suballoc-class.md).|
31+
|*Cache*|The type of cache associated with the synchronization filter. This can be [cache_chunklist](../standard-library/cache-chunklist-class.md), [cache_freelist](../standard-library/cache-freelist-class.md), or [cache_suballoc](../standard-library/cache-suballoc-class.md).|
3232
3333
### Member functions
3434
@@ -54,12 +54,12 @@ bool equals(const sync_per_container<Cache>& Other) const;
5454

5555
|Parameter|Description|
5656
|---------------|-----------------|
57-
|`Cache`|The cache object of the synchronization filter.|
58-
|`Other`|The cache object to compare for equality.|
57+
|*Cache*|The cache object of the synchronization filter.|
58+
|*Other*|The cache object to compare for equality.|
5959

6060
### Return Value
6161

62-
The member function always returns `false`.
62+
The member function always returns **false**.
6363

6464
### Remarks
6565

0 commit comments

Comments
 (0)