Skip to content

Commit 520931f

Browse files
authored
Merge pull request #1067 from msebolt/format-standard-pr9
format standard pr9
2 parents ee77031 + ddcbd2c commit 520931f

30 files changed

+351
-351
lines changed

docs/standard-library/istream-functions.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -33,10 +33,10 @@ void swap(
3333
3434
### Parameters
3535
36-
`left`
36+
*left*
3737
A stream.
3838
39-
`right`
39+
*right*
4040
A stream.
4141
4242
## <a name="ws"></a> ws
@@ -49,7 +49,7 @@ template class<Elem, Tr> basic_istream<Elem, Tr>& ws(basic_istream<Elem, Tr>& _I
4949

5050
### Parameters
5151

52-
`_Istr`
52+
*_Istr*
5353
A stream.
5454

5555
### Return Value
@@ -60,7 +60,7 @@ The stream.
6060

6161
The manipulator extracts and discards any elements `ch` for which [use_facet](../standard-library/basic-filebuf-class.md#open)< **ctype**\< **Elem**> >( [getloc](../standard-library/ios-base-class.md#getloc)). **is**( **ctype**\< **Elem**>:: **space**, **ch**) is true.
6262

63-
The function calls [setstate](../standard-library/basic-ios-class.md#setstate)( **eofbit**) if it encounters end of file while extracting elements. It returns `_Istr`.
63+
The function calls [setstate](../standard-library/basic-ios-class.md#setstate)( **eofbit**) if it encounters end of file while extracting elements. It returns *_Istr*.
6464

6565
### Example
6666

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

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -29,16 +29,16 @@ class istream_iterator
2929
3030
### Parameters
3131
32-
`Type`
32+
*Type*
3333
The type of object to be extracted from the input stream.
3434
35-
`CharType`
36-
The type that represents the character type for the `istream_iterator`. This argument is optional and the default value is `char`.
35+
*CharType*
36+
The type that represents the character type for the `istream_iterator`. This argument is optional and the default value is **char**.
3737
38-
`Traits`
38+
*Traits*
3939
The type that represents the character type for the `istream_iterator`. This argument is optional and the default value is `char_traits`< `CharType`>.
4040
41-
`Distance`
41+
*Distance*
4242
A signed integral type that represents the difference type for the `istream_iterator`. This argument is optional and the default value is `ptrdiff_t`.
4343
4444
After constructing or incrementing an object of class istream_iterator with a nonnull stored pointer, the object attempts to extract and store an object of type `Type` from the associated input stream. If the extraction fails, the object effectively replaces the stored pointer with a null pointer, thus making an end-of-sequence indicator.
@@ -81,7 +81,7 @@ typedef CharType char_type;
8181

8282
### Remarks
8383

84-
The type is a synonym for the template parameter **Chartype**.
84+
The type is a synonym for the template parameter `Chartype`.
8585

8686
### Example
8787

@@ -131,12 +131,12 @@ istream_iterator(istream_type& _Istr);
131131

132132
### Parameters
133133

134-
`_Istr`
134+
*_Istr*
135135
The input stream to be read use to initialize the `istream_iterator`.
136136

137137
### Remarks
138138

139-
The First constructor initializes the input stream pointer with a null pointer and creates an end-of-stream iterator. The second constructor initializes the input stream pointer with *&_Istr*, then attempts to extract and store an object of type **Type**.
139+
The First constructor initializes the input stream pointer with a null pointer and creates an end-of-stream iterator. The second constructor initializes the input stream pointer with *&_Istr*, then attempts to extract and store an object of type `Type`.
140140

141141
The end-of-stream iterator can be use to test whether an `istream_iterator` has reached the end of a stream.
142142

@@ -192,15 +192,15 @@ See [istream_iterator](#istream_iterator) for an example of how to declare and u
192192

193193
## <a name="op_star"></a> istream_iterator::operator*
194194

195-
The dereferencing operator returns the stored object of type **Type** addressed by the `istream_iterator`.
195+
The dereferencing operator returns the stored object of type `Type` addressed by the `istream_iterator`.
196196

197197
```cpp
198198
const Type& operator*() const;
199199
```
200200

201201
### Return Value
202202

203-
The stored object of type **Type**.
203+
The stored object of type `Type`.
204204

205205
### Example
206206

@@ -296,7 +296,7 @@ istream_iterator<Type, CharType, Traits, Distance> operator++(int);
296296

297297
### Return Value
298298

299-
The first member operator returns a reference to the incremented object of type **Type** extracted from the input stream and the second member function returns a copy of the object.
299+
The first member operator returns a reference to the incremented object of type `Type` extracted from the input stream and the second member function returns a copy of the object.
300300

301301
### Example
302302

@@ -340,7 +340,7 @@ typedef Traits traits_type;
340340

341341
### Remarks
342342

343-
The type is a synonym for the template parameter **Traits**.
343+
The type is a synonym for the template parameter *Traits*.
344344

345345
### Example
346346

docs/standard-library/istream-operators.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -55,16 +55,16 @@ basic_istream<Elem, Tr>& operator>>(
5555
5656
### Parameters
5757
58-
`Ch`
58+
*Ch*
5959
A character.
6060
61-
`Istr`
61+
*Istr*
6262
A stream.
6363
64-
`str`
64+
*str*
6565
A string.
6666
67-
`val`
67+
*val*
6868
A type.
6969
7070
### Return Value
@@ -83,9 +83,9 @@ basic_istream<Elem, Tr>& operator>>(
8383
basic_istream<Elem, Tr>& Istr, Elem* str);
8484
```
8585

86-
extracts up to *N* - 1 elements and stores them in the array starting at _ *Str*. If `Istr`. [width](../standard-library/ios-base-class.md#width) is greater than zero, *N* is `Istr`. **width**; otherwise, it is the size of the largest array of **Elem** that can be declared. The function always stores the value **Elem()** after any extracted elements it stores. Extraction stops early on end of file, on a character with value **Elem**(0) (which is not extracted), or on any element (which is not extracted) that would be discarded by [ws](../standard-library/istream-functions.md#ws). If the function extracts no elements, it calls `Istr`. [setstate](../standard-library/basic-ios-class.md#setstate)( **failbit**). In any case, it calls `Istr`. **width**(0) and returns `Istr`.
86+
extracts up to *N* - 1 elements and stores them in the array starting at _ *Str*. If `Istr`. [width](../standard-library/ios-base-class.md#width) is greater than zero, *N* is `Istr`. **width**; otherwise, it is the size of the largest array of `Elem` that can be declared. The function always stores the value `Elem()` after any extracted elements it stores. Extraction stops early on end of file, on a character with value **Elem**(0) (which is not extracted), or on any element (which is not extracted) that would be discarded by [ws](../standard-library/istream-functions.md#ws). If the function extracts no elements, it calls `Istr`. [setstate](../standard-library/basic-ios-class.md#setstate)(**failbit**). In any case, it calls `Istr`. **width**(0) and returns *Istr*.
8787

88-
**Security Note** The null-terminated string being extracted from the input stream must not exceed the size of the destination buffer `str`. For more information, see [Avoiding Buffer Overruns](http://msdn.microsoft.com/library/windows/desktop/ms717795).
88+
**Security Note** The null-terminated string being extracted from the input stream must not exceed the size of the destination buffer *str*. For more information, see [Avoiding Buffer Overruns](http://msdn.microsoft.com/library/windows/desktop/ms717795).
8989

9090
The template function:
9191

@@ -95,7 +95,7 @@ basic_istream<Elem, Tr>& operator>>(
9595
basic_istream<Elem, Tr>& Istr, Elem& Ch);
9696
```
9797
98-
extracts an element, if it is possible, and stores it in `Ch`. Otherwise, it calls **is**. [setstate](../standard-library/basic-ios-class.md#setstate)( **failbit**). In any case, it returns `Istr`.
98+
extracts an element, if it is possible, and stores it in *Ch*. Otherwise, it calls **is**. [setstate](../standard-library/basic-ios-class.md#setstate)( **failbit**). In any case, it returns *Istr*.
9999
100100
The template function:
101101

docs/standard-library/istream-typedefs.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -15,51 +15,51 @@ ms.assetid: 55bc1f84-53a7-46ca-a36f-ac6ef75d0374
1515

1616
## <a name="iostream"></a> iostream
1717

18-
A type `basic_iostream` specialized on `char`.
18+
A type `basic_iostream` specialized on **char**.
1919

2020
```cpp
2121
typedef basic_iostream<char, char_traits<char>> iostream;
2222
```
2323

2424
### Remarks
2525

26-
The type is a synonym for template class [basic_iostream](../standard-library/basic-iostream-class.md), specialized for elements of type `char` with default character traits.
26+
The type is a synonym for template class [basic_iostream](../standard-library/basic-iostream-class.md), specialized for elements of type **char** with default character traits.
2727

2828
## <a name="istream"></a> istream
2929

30-
A type `basic_istream` specialized on `char`.
30+
A type `basic_istream` specialized on **char**.
3131

3232
```cpp
3333
typedef basic_istream<char, char_traits<char>> istream;
3434
```
3535

3636
### Remarks
3737

38-
The type is a synonym for template class [basic_istream](../standard-library/basic-istream-class.md), specialized for elements of type `char` with default character traits.
38+
The type is a synonym for template class [basic_istream](../standard-library/basic-istream-class.md), specialized for elements of type **char** with default character traits.
3939

4040
## <a name="wiostream"></a> wiostream
4141

42-
A type `basic_iostream` specialized on `wchar_t`.
42+
A type `basic_iostream` specialized on **wchar_t**.
4343

4444
```cpp
4545
typedef basic_iostream<wchar_t, char_traits<wchar_t>> wiostream;
4646
```
4747

4848
### Remarks
4949

50-
The type is a synonym for template class [basic_iostream](../standard-library/basic-iostream-class.md), specialized for elements of type `wchar_t` with default character traits.
50+
The type is a synonym for template class [basic_iostream](../standard-library/basic-iostream-class.md), specialized for elements of type **wchar_t** with default character traits.
5151

5252
## <a name="wistream"></a> wistream
5353

54-
A type `basic_istream` specialized on `wchar_t`.
54+
A type `basic_istream` specialized on **wchar_t**.
5555

5656
```cpp
5757
typedef basic_istream<wchar_t, char_traits<wchar_t>> wistream;
5858
```
5959

6060
### Remarks
6161

62-
The type is a synonym for template class [basic_istream](../standard-library/basic-istream-class.md), specialized for elements of type `wchar_t` with default character traits.
62+
The type is a synonym for template class [basic_istream](../standard-library/basic-istream-class.md), specialized for elements of type **wchar_t** with default character traits.
6363

6464
## See also
6565

docs/standard-library/istream.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,8 @@ Defines the template class basic_istream, which mediates extractions for the ios
2727

2828
|Type name|Description|
2929
|-|-|
30-
|[iostream](../standard-library/istream-typedefs.md#iostream)|A type `basic_iostream` specialized on `char`.|
31-
|[istream](../standard-library/istream-typedefs.md#istream)|A type `basic_istream` specialized on `char`.|
30+
|[iostream](../standard-library/istream-typedefs.md#iostream)|A type `basic_iostream` specialized on **char**.|
31+
|[istream](../standard-library/istream-typedefs.md#istream)|A type `basic_istream` specialized on **char**.|
3232
|[wiostream](../standard-library/istream-typedefs.md#wiostream)|A type `basic_iostream` specialized on **wchar**.|
3333
|[wistream](../standard-library/istream-typedefs.md#wistream)|A type `basic_istream` specialized on **wchar**.|
3434

@@ -50,7 +50,7 @@ Defines the template class basic_istream, which mediates extractions for the ios
5050
|Class|Description|
5151
|-|-|
5252
|[basic_iostream](../standard-library/basic-iostream-class.md)|A stream class that can do both input and output.|
53-
|[basic_istream](../standard-library/basic-istream-class.md)|The template class describes an object that controls extraction of elements and encoded objects from a stream buffer with elements of type **Elem**, also known as [char_type](../standard-library/basic-ios-class.md#char_type), whose character traits are determined by the class **Tr**, also known as [traits_type](../standard-library/basic-ios-class.md#traits_type).|
53+
|[basic_istream](../standard-library/basic-istream-class.md)|The template class describes an object that controls extraction of elements and encoded objects from a stream buffer with elements of type `Elem`, also known as [char_type](../standard-library/basic-ios-class.md#char_type), whose character traits are determined by the class `Tr`, also known as [traits_type](../standard-library/basic-ios-class.md#traits_type).|
5454

5555
## See also
5656

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

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -26,17 +26,17 @@ class istreambuf_iterator
2626
2727
### Parameters
2828
29-
`CharType`
29+
*CharType*
3030
The type that represents the character type for the istreambuf_iterator.
3131
32-
`Traits`
32+
*Traits*
3333
The type that represents the character type for the istreambuf_iterator. This argument is optional and the default value is `char_traits`\< *CharType>.*
3434
3535
## Remarks
3636
3737
The istreambuf_iterator class must satisfy the requirements for an input iterator.
3838
39-
After constructing or incrementing an object of class istreambuf_iterator with a non-null stored pointer, the object effectively attempts to extract and store an object of type **CharType** from the associated input stream. The extraction may be delayed, however, until the object is actually dereferenced or copied. If the extraction fails, the object effectively replaces the stored pointer with a null pointer, thus making an end-of-sequence indicator.
39+
After constructing or incrementing an object of class istreambuf_iterator with a non-null stored pointer, the object effectively attempts to extract and store an object of type *CharType* from the associated input stream. The extraction may be delayed, however, until the object is actually dereferenced or copied. If the extraction fails, the object effectively replaces the stored pointer with a null pointer, thus making an end-of-sequence indicator.
4040
4141
### Constructors
4242
@@ -84,7 +84,7 @@ typedef CharType char_type;
8484

8585
### Remarks
8686

87-
The type is a synonym for the template parameter **CharType**.
87+
The type is a synonym for the template parameter *CharType*.
8888

8989
### Example
9090

@@ -129,7 +129,7 @@ bool equal(const istreambuf_iterator<CharType, Traits>& right) const;
129129

130130
### Parameters
131131

132-
`right`
132+
*right*
133133
The iterator for which to check for equality.
134134

135135
### Return Value
@@ -138,7 +138,7 @@ bool equal(const istreambuf_iterator<CharType, Traits>& right) const;
138138

139139
### Remarks
140140

141-
A range is defined by the `istreambuf_iterator` to the current position and the end-of-stream iterator, but since all non-end-of stream iterators are equivalent under the **equal** member function, it is not possible to define any subranges using `istreambuf_iterator`s. The `==` and `!=` operators have the same semantics.
141+
A range is defined by the `istreambuf_iterator` to the current position and the end-of-stream iterator, but since all non-end-of stream iterators are equivalent under the `equal` member function, it is not possible to define any subranges using `istreambuf_iterator`s. The `==` and `!=` operators have the same semantics.
142142

143143
### Example
144144

@@ -178,7 +178,7 @@ typedef typename traits_type::int_type int_type;
178178

179179
### Remarks
180180

181-
The type is a synonym for **Traits::int_type**.
181+
The type is a synonym for `Traits::int_type`.
182182

183183
### Example
184184

@@ -226,15 +226,15 @@ istreambuf_iterator(istream_type& _Istr) throw();
226226
227227
### Parameters
228228
229-
`strbuf`
229+
*strbuf*
230230
The input stream buffer to which the `istreambuf_iterator` is being attached.
231231
232-
`_Istr`
232+
*_Istr*
233233
The input stream to which the `istreambuf_iterator` is being attached.
234234
235235
### Remarks
236236
237-
The first constructor initializes the input stream-buffer pointer with `strbuf`. The second constructor initializes the input stream-buffer pointer with `_Istr`. `rdbuf`, and then eventually attempts to extract and store an object of type **CharType**.
237+
The first constructor initializes the input stream-buffer pointer with *strbuf*. The second constructor initializes the input stream-buffer pointer with *_Istr*. `rdbuf`, and then eventually attempts to extract and store an object of type `CharType`.
238238
239239
### Example
240240
@@ -323,7 +323,7 @@ An `istreambuf_iterator` or a reference to an `istreambuf_iterator`.
323323

324324
### Remarks
325325

326-
The first operator eventually attempts to extract and store an object of type **CharType** from the associated input stream. The second operator makes a copy of the object, increments the object, and then returns the copy.
326+
The first operator eventually attempts to extract and store an object of type `CharType` from the associated input stream. The second operator makes a copy of the object, increments the object, and then returns the copy.
327327

328328
### Example
329329

@@ -379,7 +379,7 @@ The type is a synonym for `basic_streambuf`\< **CharType**, **Traits**>.
379379

380380
### Example
381381

382-
See [istreambuf_iterator](#istreambuf_iterator) for an example of how to declare and use **istreambuf_type**.
382+
See [istreambuf_iterator](#istreambuf_iterator) for an example of how to declare and use `istreambuf_type`.
383383

384384
## <a name="traits_type"></a> istreambuf_iterator::traits_type
385385

@@ -391,7 +391,7 @@ typedef Traits traits_type;
391391

392392
### Remarks
393393

394-
The type is a synonym for the template parameter **Traits**.
394+
The type is a synonym for the template parameter *Traits*.
395395

396396
### Example
397397

docs/standard-library/istrstream-class.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -70,15 +70,15 @@ istrstream(
7070

7171
### Parameters
7272

73-
`count`
74-
The length of the buffer ( `ptr`).
73+
*count*
74+
The length of the buffer (*ptr*).
7575

76-
`ptr`
76+
*ptr*
7777
The contents with which the buffer is initialized.
7878

7979
### Remarks
8080

81-
All the constructors initialize the base class by calling [istream](../standard-library/istream-typedefs.md#istream)( **sb**), where **sb** is the stored object of class [strstreambuf](../standard-library/strstreambuf-class.md). The first two constructors also initialize **sb** by calling `strstreambuf`( ( **const**`char` \*) `ptr`, 0 ). The remaining two constructors instead call `strstreambuf`( ( **const**`char` *) `ptr`, `count` ).
81+
All the constructors initialize the base class by calling [istream](../standard-library/istream-typedefs.md#istream)(**sb**), where `sb` is the stored object of class [strstreambuf](../standard-library/strstreambuf-class.md). The first two constructors also initialize `sb` by calling `strstreambuf`( ( **const**`char` \*) `ptr`, 0 ). The remaining two constructors instead call `strstreambuf`( ( **const**`char` *) `ptr`, `count` ).
8282

8383
## <a name="rdbuf"></a> istrstream::rdbuf
8484

@@ -118,7 +118,7 @@ The member function returns [rdbuf](#rdbuf) -> [str](../standard-library/strstre
118118
119119
### Example
120120
121-
See [strstream::str](../standard-library/strstreambuf-class.md#str) for a sample that uses **str**.
121+
See [strstream::str](../standard-library/strstreambuf-class.md#str) for a sample that uses `str`.
122122
123123
## See also
124124

0 commit comments

Comments
 (0)