Skip to content

Commit 9d63f57

Browse files
authored
Add backticks in <ostream> functions reference
1 parent c8355ba commit 9d63f57

File tree

1 file changed

+24
-24
lines changed

1 file changed

+24
-24
lines changed

docs/standard-library/ostream-functions.md

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ helpviewer_keywords: ["std::swap [C++]", "std::endl [C++]", "std::ends [C++]", "
77
---
88
# `<ostream>` functions
99

10-
These are the global template functions defined in `<ostream>`. For member functions, see the [basic_ostream Class](basic-ostream-class.md) documentation.
10+
These are the global template functions defined in `<ostream>`. For member functions, see the [`basic_ostream` Class](basic-ostream-class.md) documentation.
1111

12-
## endl
12+
## `endl`
1313

1414
Terminates a line and flushes the buffer.
1515

@@ -21,22 +21,22 @@ basic_ostream<Elem, Tr>& endl(
2121
2222
### Parameters
2323
24-
*Elem*\
24+
*`Elem`*\
2525
The element type.
2626
27-
*Ostr*\
28-
An object of type **basic_ostream**.
27+
*`Ostr`*\
28+
An object of type **`basic_ostream`**.
2929
30-
*Tr*\
30+
*`Tr`*\
3131
Character traits.
3232
3333
### Return Value
3434
35-
An object of type **basic_ostream**.
35+
An object of type **`basic_ostream`**.
3636
3737
### Remarks
3838
39-
The manipulator calls *Ostr*.[put](../standard-library/basic-ostream-class.md#put)(*Ostr*.[widen](../standard-library/basic-ios-class.md#widen)('\n')), and then calls *Ostr*.[flush](../standard-library/basic-ostream-class.md#flush). It returns *Ostr*.
39+
The manipulator calls *`Ostr`*.[`put`](../standard-library/basic-ostream-class.md#put)(*`Ostr`*.[`widen`](../standard-library/basic-ios-class.md#widen)('\n')), and then calls *`Ostr`*.[`flush`](../standard-library/basic-ostream-class.md#flush). It returns *`Ostr`*.
4040
4141
### Example
4242
@@ -56,7 +56,7 @@ int main( )
5656
testing
5757
```
5858

59-
## ends
59+
## `ends`
6060

6161
Terminates a string.
6262

@@ -68,13 +68,13 @@ basic_ostream<Elem, Tr>& ends(
6868
6969
### Parameters
7070
71-
*Elem*\
71+
*`Elem`*\
7272
The element type.
7373
74-
*Ostr*\
74+
*`Ostr`*\
7575
An object of type `basic_ostream`.
7676
77-
*Tr*\
77+
*`Tr`*\
7878
Character traits.
7979
8080
### Return Value
@@ -83,7 +83,7 @@ An object of type `basic_ostream`.
8383
8484
### Remarks
8585
86-
The manipulator calls *Ostr*.[put](../standard-library/basic-ostream-class.md#put)(*Elem*('\0')). It returns *Ostr*.
86+
The manipulator calls *`Ostr`*.[`put`](../standard-library/basic-ostream-class.md#put)(*`Elem`*('\0')). It returns *`Ostr`*.
8787
8888
### Example
8989
@@ -105,7 +105,7 @@ int main( )
105105
ab c
106106
```
107107

108-
## flush
108+
## `flush`
109109

110110
Flushes the buffer.
111111

@@ -117,13 +117,13 @@ basic_ostream<Elem, Tr>& flush(
117117
118118
### Parameters
119119
120-
*Elem*\
120+
*`Elem`*\
121121
The element type.
122122
123-
*Ostr*\
123+
*`Ostr`*\
124124
An object of type `basic_ostream`.
125125
126-
*Tr*\
126+
*`Tr`*\
127127
Character traits.
128128
129129
### Return Value
@@ -132,7 +132,7 @@ An object of type `basic_ostream`.
132132
133133
### Remarks
134134
135-
The manipulator calls *Ostr*.[flush](../standard-library/basic-ostream-class.md#flush). It returns *Ostr*.
135+
The manipulator calls *`Ostr`*.[`flush`](../standard-library/basic-ostream-class.md#flush). It returns *`Ostr`*.
136136
137137
### Example
138138
@@ -152,7 +152,7 @@ int main( )
152152
testing
153153
```
154154

155-
## swap
155+
## `swap`
156156

157157
Exchanges the values of two `basic_ostream` objects.
158158

@@ -165,16 +165,16 @@ void swap(
165165
166166
### Parameters
167167
168-
*Elem*\
168+
*`Elem`*\
169169
The element type.
170170
171-
*Tr*\
171+
*`Tr`*\
172172
Character traits.
173173
174-
*left*\
174+
*`left`*\
175175
An lvalue reference to a `basic_ostream` object.
176176
177-
*right*\
177+
*`right`*\
178178
An lvalue reference to a `basic_ostream` object.
179179
180180
### Remarks
@@ -183,4 +183,4 @@ The template function `swap` executes `left.swap(right)`.
183183
184184
## See also
185185
186-
[\<ostream>](../standard-library/ostream.md)
186+
[`<ostream>`](../standard-library/ostream.md)

0 commit comments

Comments
 (0)