Skip to content

Commit 1c5de7b

Browse files
authored
Merge pull request #4056 from craigcaseyMSFT/vcraigcasey0117
US1907300 - add md code escapes to code elements - PR3
2 parents dc221ab + a350c6f commit 1c5de7b

5 files changed

Lines changed: 68 additions & 73 deletions

File tree

docs/c-runtime-library/reference/sin-sinf-sinl.md

Lines changed: 17 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,8 @@ api_type: ["DLLExport"]
88
topic_type: ["apiref"]
99
f1_keywords: ["_sinl", "sinf", "sinl", "sin"]
1010
helpviewer_keywords: ["_sinl function", "sinl function", "calculating sines", "sin function", "trigonometric functions", "sinf function"]
11-
ms.assetid: 737de73e-3590-45f9-8257-dc1c0c489dfc
1211
---
13-
# sin, sinf, sinl
12+
# `sin`, `sinf`, `sinl`
1413

1514
Calculates the sine of a floating-point value.
1615

@@ -30,34 +29,34 @@ long double sin(long double x); // C++ only
3029

3130
### Parameters
3231

33-
*x*\
32+
*`x`*\
3433
Angle in radians.
3534

3635
## Return value
3736

38-
The **sin** functions return the sine of *x*. If *x* is greater than or equal to 263, or less than or equal to -263, a loss of significance in the result occurs.
37+
The **`sin`** functions return the sine of *`x`*. If *`x`* is greater than or equal to 263, or less than or equal to -263, a loss of significance in the result occurs.
3938

4039
|Input|SEH Exception|Matherr Exception|
4140
|-----------|-------------------|-----------------------|
42-
|± QNAN,IND|None|_DOMAIN|
43-
|± ∞ (sin, sinf, sinl)|INVALID|_DOMAIN|
41+
|± `QNAN`,`IND`|None|`_DOMAIN`|
42+
|± ∞ (`sin`, `sinf`, `sinl`)|`INVALID`|`_DOMAIN`|
4443

45-
For more information about return codes, see [errno, _doserrno, _sys_errlist, and _sys_nerr](../../c-runtime-library/errno-doserrno-sys-errlist-and-sys-nerr.md).
44+
For more information about return codes, see [`errno`, `_doserrno`, `_sys_errlist`, and `_sys_nerr`](../../c-runtime-library/errno-doserrno-sys-errlist-and-sys-nerr.md).
4645

4746
## Remarks
4847

49-
Because C++ allows overloading, you can call overloads of **sin** that take and return **`float`** or **`long double`** values. In a C program, unless you're using the \<tgmath.h> macro to call this function, **sin** always takes and returns **`double`**.
48+
Because C++ allows overloading, you can call overloads of **`sin`** that take and return **`float`** or **`long double`** values. In a C program, unless you're using the `<tgmath.h>` macro to call this function, **`sin`** always takes and returns **`double`**.
5049

51-
If you use the \<tgmath.h> `sin()` macro, the type of the argument determines which version of the function is selected. See [Type-generic math](../../c-runtime-library/tgmath.md) for details.
50+
If you use the `<tgmath.h> sin()` macro, the type of the argument determines which version of the function is selected. See [Type-generic math](../../c-runtime-library/tgmath.md) for details.
5251

5352
By default, this function's global state is scoped to the application. To change this, see [Global state in the CRT](../global-state.md).
5453

5554
## Requirements
5655

5756
|Routine|Required header (C)|Required header (C++)|
5857
|-|-|-|
59-
|**sin**, **sinf**, **sinl**|\<math.h>|\<cmath> or \<math.h>|
60-
|**sin()** macro | \<tgmath.h> ||
58+
|**`sin`**, **`sinf`**, **`sinl`**|`<math.h>`|`<cmath>` or `<math.h>`|
59+
|**`sin()`** macro | `<tgmath.h>` ||
6160

6261
For additional compatibility information, see [Compatibility](../../c-runtime-library/compatibility.md).
6362

@@ -91,10 +90,10 @@ cos( 1.570796 ) = 0.000000
9190

9291
## See also
9392

94-
[Floating-Point Support](../../c-runtime-library/floating-point-support.md)<br/>
95-
[acos, acosf, acosl](acos-acosf-acosl.md)<br/>
96-
[asin, asinf, asinl](asin-asinf-asinl.md)<br/>
97-
[atan, atanf, atanl, atan2, atan2f, atan2l](atan-atanf-atanl-atan2-atan2f-atan2l.md)<br/>
98-
[cos, cosf, cosl](cos-cosf-cosl.md)<br/>
99-
[tan, tanf, tanl](tan-tanf-tanl.md)<br/>
100-
[_CIsin](../../c-runtime-library/cisin.md)<br/>
93+
[Floating-Point Support](../../c-runtime-library/floating-point-support.md)\
94+
[`acos`, `acosf`, `acosl`](acos-acosf-acosl.md)\
95+
[`asin`, `asinf`, `asinl`](asin-asinf-asinl.md)\
96+
[`atan`, `atanf`, `atanl`, `atan2`, `atan2f`, `atan2l`](atan-atanf-atanl-atan2-atan2f-atan2l.md)\
97+
[`cos`, `cosf`, `cosl`](cos-cosf-cosl.md)\
98+
[`tan`, `tanf`, `tanl`](tan-tanf-tanl.md)\
99+
[`_CIsin`](../../c-runtime-library/cisin.md)\

docs/c-runtime-library/reference/sqrt-sqrtf-sqrtl.md

Lines changed: 16 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,8 @@ api_type: ["DLLExport"]
88
topic_type: ["apiref"]
99
f1_keywords: ["sqrt", "sqrtf", "_sqrtl"]
1010
helpviewer_keywords: ["sqrtf function", "sqrt function", "sqrtl function", "_sqrtl function", "calculating square roots", "square roots, calculating"]
11-
ms.assetid: 2ba9467b-f172-41dc-8f10-b86f68fa813c
1211
---
13-
# sqrt, sqrtf, sqrtl
12+
# `sqrt`, `sqrtf`, `sqrtl`
1413

1514
Calculates the square root.
1615

@@ -37,33 +36,33 @@ long double sqrtl(
3736
3837
### Parameters
3938
40-
*x*\
39+
*`x`*\
4140
Non-negative floating-point value
4241
4342
## Remarks
4443
45-
Because C++ allows overloading, you can call overloads of **sqrt** that take **`float`** or **`long double`** types. In a C program, unless you're using the \<tgmath.h> macro to call this function, **sqrt** always takes and returns **`double`**.
44+
Because C++ allows overloading, you can call overloads of **`sqrt`** that take **`float`** or **`long double`** types. In a C program, unless you're using the `<tgmath.h>` macro to call this function, **`sqrt`** always takes and returns **`double`**.
4645
47-
If you use the \<tgmath.h> `sqrt()` macro, the type of the argument determines which version of the function is selected. See [Type-generic math](../../c-runtime-library/tgmath.md) for details.
46+
If you use the `<tgmath.h> sqrt()` macro, the type of the argument determines which version of the function is selected. See [Type-generic math](../../c-runtime-library/tgmath.md) for details.
4847
4948
By default, this function's global state is scoped to the application. To change this, see [Global state in the CRT](../global-state.md).
5049
5150
## Return Value
5251
53-
The **sqrt** functions return the square-root of *x*. By default, if *x* is negative, **sqrt** returns an indefinite NaN.
52+
The **`sqrt`** functions return the square-root of *`x`*. By default, if *`x`* is negative, **`sqrt`** returns an indefinite `NaN`.
5453
55-
|Input|SEH Exception|**_matherr** Exception|
54+
|Input|SEH Exception|**`_matherr`** Exception|
5655
|-----------|-------------------|--------------------------|
57-
|± QNAN,IND|none|_DOMAIN|
58-
|- ∞|none|_DOMAIN|
59-
|x<0|none|_DOMAIN|
56+
`QNAN`,`IND`|none|`_DOMAIN`|
57+
|- ∞|none|`_DOMAIN`|
58+
|`x<0`|none|`_DOMAIN`|
6059
6160
## Requirements
6261
6362
|Function|C header|C++ header|
6463
|--------------|--------------|------------------|
65-
|**sqrt**, **sqrtf**, **sqrtl**|\<math.h>|\<cmath>|
66-
|**sqrt()** macro | \<tgmath.h> ||
64+
|**`sqrt`**, **`sqrtf`**, **`sqrtl`**|`<math.h>`|`<cmath>`|
65+
|**`sqrt()`** macro | `<tgmath.h>` ||
6766
6867
For compatibility information, see [Compatibility](../../c-runtime-library/compatibility.md).
6968
@@ -94,8 +93,8 @@ The square root of 45.35 is 6.73
9493

9594
## See also
9695

97-
[Floating-Point Support](../../c-runtime-library/floating-point-support.md)<br/>
98-
[exp, expf, expl](exp-expf.md)<br/>
99-
[log, logf, log10, log10f](log-logf-log10-log10f.md)<br/>
100-
[pow, powf, powl](pow-powf-powl.md)<br/>
101-
[_CIsqrt](../../c-runtime-library/cisqrt.md)<br/>
96+
[Floating-Point Support](../../c-runtime-library/floating-point-support.md)\
97+
[`exp`, `expf`, `expl`](exp-expf.md)\
98+
[`log`, `logf`, `log10`, `log10f`](log-logf-log10-log10f.md)\
99+
[`pow`, `powf`, `powl`](pow-powf-powl.md)\
100+
[`_CIsqrt`](../../c-runtime-library/cisqrt.md)\

docs/standard-library/cmath.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,10 @@ title: "<cmath>"
44
ms.date: "11/04/2016"
55
f1_keywords: ["<cmath>"]
66
helpviewer_keywords: ["cmath header"]
7-
ms.assetid: 80df1dba-60ca-4918-9c2e-fbf446eaa7d6
87
---
98
# `<cmath>`
109

11-
Includes the Standard C library header \<math.h> and adds the associated names to the `std` namespace.
10+
Includes the Standard C library header `<math.h>` and adds the associated names to the `std` namespace.
1211

1312
## Syntax
1413

docs/standard-library/ios-base-class.md

Lines changed: 18 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,12 @@ description: "API reference for the Microsoft Visual C++ standard library `ios_b
44
ms.date: "10/23/2020"
55
f1_keywords: ["xiosbase/std::ios_base", "ios/std::ios_base::event_callback", "xiosbase/std::ios_base::fmtflags", "xiosbase/std::ios_base::iostate", "xiosbase/std::ios_base::openmode", "xiosbase/std::ios_base::seekdir", "xiosbase/std::ios_base::event", "xiosbase/std::ios_base::adjustfield", "xiosbase/std::ios_base::app", "xiosbase/std::ios_base::ate", "xiosbase/std::ios_base::badbit", "xiosbase/std::ios_base::basefield", "xiosbase/std::ios_base::beg", "xiosbase/std::ios_base::binary", "xiosbase/std::ios_base::boolalpha", "xiosbase/std::ios_base::cur", "xiosbase/std::ios_base::dec", "xiosbase/std::ios_base::end", "xiosbase/std::ios_base::eofbit", "xiosbase/std::ios_base::failbit", "xiosbase/std::ios_base::fixed", "xiosbase/std::ios_base::floatfield", "xiosbase/std::ios_base::goodbit", "xiosbase/std::ios_base::hex", "xiosbase/std::ios_base::in", "xiosbase/std::ios_base::internal", "xiosbase/std::ios_base::left", "xiosbase/std::ios_base::oct", "xiosbase/std::ios_base::out", "xiosbase/std::ios_base::right", "xiosbase/std::ios_base::scientific", "xiosbase/std::ios_base::showbase", "xiosbase/std::ios_base::showpoint", "xiosbase/std::ios_base::showpos", "xiosbase/std::ios_base::skipws", "xiosbase/std::ios_base::trunc", "xiosbase/std::ios_base::unitbuf", "xiosbase/std::ios_base::uppercase", "xiosbase/std::ios_base::failure", "xiosbase/std::ios_base::flags", "xiosbase/std::ios_base::getloc", "xiosbase/std::ios_base::imbue", "xiosbase/std::ios_base::Init", "xiosbase/std::ios_base::iword", "xiosbase/std::ios_base::precision", "xiosbase/std::ios_base::pword", "ios/std::ios_base::register_callback", "xiosbase/std::ios_base::setf", "xiosbase/std::ios_base::sync_with_stdio", "xiosbase/std::ios_base::unsetf", "xiosbase/std::ios_base::width", "xiosbase/std::ios_base::xalloc"]
66
helpviewer_keywords: ["std::ios_base [C++]", "std::ios_base [C++], event_callback", "std::ios_base [C++], fmtflags", "std::ios_base [C++], iostate", "std::ios_base [C++], openmode", "std::ios_base [C++], seekdir", "std::ios_base [C++], event", "std::ios_base [C++], adjustfield", "std::ios_base [C++], app", "std::ios_base [C++], ate", "std::ios_base [C++], badbit", "std::ios_base [C++], basefield", "std::ios_base [C++], beg", "std::ios_base [C++], binary", "std::ios_base [C++], boolalpha", "std::ios_base [C++], cur", "std::ios_base [C++], dec", "std::ios_base [C++], end", "std::ios_base [C++], eofbit", "std::ios_base [C++], failbit", "std::ios_base [C++], fixed", "std::ios_base [C++], floatfield", "std::ios_base [C++], goodbit", "std::ios_base [C++], hex", "std::ios_base [C++], in", "std::ios_base [C++], internal", "std::ios_base [C++], left", "std::ios_base [C++], oct", "std::ios_base [C++], out", "std::ios_base [C++], right", "std::ios_base [C++], scientific", "std::ios_base [C++], showbase", "std::ios_base [C++], showpoint", "std::ios_base [C++], showpos", "std::ios_base [C++], skipws", "std::ios_base [C++], trunc", "std::ios_base [C++], unitbuf", "std::ios_base [C++], uppercase", "std::ios_base [C++], failure", "std::ios_base [C++], flags", "std::ios_base [C++], getloc", "std::ios_base [C++], imbue", "std::ios_base [C++], Init", "std::ios_base [C++], iword", "std::ios_base [C++], precision", "std::ios_base [C++], pword", "std::ios_base [C++], register_callback", "std::ios_base [C++], setf", "std::ios_base [C++], sync_with_stdio", "std::ios_base [C++], unsetf", "std::ios_base [C++], width", "std::ios_base [C++], xalloc"]
7-
ms.assetid: 0f9e0abc-f70f-49bc-aa1f-003859f56cfe
87
---
9-
# ios_base Class
8+
# `ios_base` Class
109

1110
The class describes the storage and member functions common to both input and output streams that do not depend on the template parameters. (The class template [`basic_ios`](../standard-library/basic-ios-class.md) describes what is common and is dependent on template parameters.)
1211

13-
An object of class ios_base stores formatting information, which consists of:
12+
An object of class `ios_base` stores formatting information, which consists of:
1413

1514
- Format flags in an object of type [`fmtflags`](#fmtflags).
1615

@@ -20,11 +19,11 @@ An object of class ios_base stores formatting information, which consists of:
2019

2120
- A display precision in an object of type `int`.
2221

23-
- A locale object in an object of type `locale`.
22+
- A `locale` object in an object of type `locale`.
2423

2524
- Two extensible arrays, with elements of type `long` and `void` pointer.
2625

27-
An object of class ios_base also stores stream state information, in an object of type [`iostate`](#iostate), and a callback stack.
26+
An object of class `ios_base` also stores stream state information, in an object of type [`iostate`](#iostate), and a callback stack.
2827

2928
## Members
3029

@@ -90,9 +89,9 @@ An object of class ios_base also stores stream state information, in an object o
9089

9190
|Name|Description|
9291
|-|-|
93-
|[`failure`](#failure)|The member class serves as the base class for all exceptions thrown by the member function [clear](../standard-library/basic-ios-class.md#clear) in class template [basic_ios](../standard-library/basic-ios-class.md).|
92+
|[`failure`](#failure)|The member class serves as the base class for all exceptions thrown by the member function [clear](../standard-library/basic-ios-class.md#clear) in class template [`basic_ios`](../standard-library/basic-ios-class.md).|
9493
|[`flags`](#flags)|Sets or returns the current flag settings.|
95-
|[`getloc`](#getloc)|Returns the stored locale object.|
94+
|[`getloc`](#getloc)|Returns the stored `locale` object.|
9695
|[`imbue`](#imbue)|Changes the locale.|
9796
|[`Init`](#init)|Creates the standard `iostream` objects when constructed.|
9897
|[`iword`](#iword)|Assigns a value to be stored as an `iword`.|
@@ -113,9 +112,9 @@ An object of class ios_base also stores stream state information, in an object o
113112

114113
## Requirements
115114

116-
**Header:** \<ios>
115+
**Header:** `<ios>`
117116

118-
**Namespace:** std
117+
**Namespace:** `std`
119118

120119
## <a name="event"></a> `event`
121120

@@ -348,15 +347,15 @@ For examples of functions that modify these format flags, see [`<iomanip>`](../s
348347
349348
## <a name="getloc"></a> `getloc`
350349
351-
Returns the stored locale object.
350+
Returns the stored `locale` object.
352351
353352
```cpp
354353
locale getloc() const;
355354
```
356355

357356
### Return Value
358357

359-
The stored locale object.
358+
The stored `locale` object.
360359

361360
### Example
362361

@@ -395,7 +394,7 @@ The previous locale.
395394
396395
### Remarks
397396
398-
The member function stores *`_Loc`* in the locale object and then reports the callback event and `imbue_event`. It returns the previous stored value.
397+
The member function stores *`_Loc`* in the `locale` object and then reports the callback event and `imbue_event`. It returns the previous stored value.
399398
400399
### Example
401400
@@ -415,15 +414,15 @@ The nested class describes an object whose construction ensures that the standar
415414

416415
## <a name="ios_base"></a> `ios_base`
417416

418-
Constructs ios_base objects.
417+
Constructs `ios_base` objects.
419418

420419
```cpp
421420
ios_base();
422421
```
423422

424423
### Remarks
425424

426-
The (protected) constructor does nothing. A later call to `basic_ios::`[init](../standard-library/basic-ios-class.md#init) must initialize the object before it can be safely destroyed. Thus, the only safe use for class ios_base is as a base class for class template [basic_ios](../standard-library/basic-ios-class.md).
425+
The (protected) constructor does nothing. A later call to `basic_ios::`[init](../standard-library/basic-ios-class.md#init) must initialize the object before it can be safely destroyed. Thus, the only safe use for class `ios_base` is as a base class for class template [`basic_ios`](../standard-library/basic-ios-class.md).
427426

428427
## <a name="iostate"></a> `iostate`
429428

@@ -505,7 +504,7 @@ The opening mode for several `iostream` objects. The flag values are:
505504
| `binary`| Open in binary mode. (See [`fopen`](../c-runtime-library/reference/fopen-wfopen.md) for a description of binary mode.)|
506505
| `in` | Open for reading |
507506
| `out` | Open for writing |
508-
| `trunc` | delete the contents of the file after open |
507+
| `trunc` | Delete the contents of the file after open |
509508
510509
### Example
511510
@@ -527,7 +526,7 @@ int main ( )
527526

528527
## <a name="op_eq"></a> `operator=`
529528

530-
The assignment operator for ios_base objects.
529+
The assignment operator for `ios_base` objects.
531530

532531
```cpp
533532
ios_base& operator=(const ios_base& right);
@@ -564,11 +563,11 @@ The number of significant digits to display, or the number of digits after the d
564563
565564
### Return Value
566565
567-
The first member function returns the stored [display precision](../standard-library/ios-base-class.md). The second member function stores *_Prec* in the display precision and returns its previous stored value.
566+
The first member function returns the stored [display precision](../standard-library/ios-base-class.md). The second member function stores *`_Prec`* in the display precision and returns its previous stored value.
568567
569568
### Remarks
570569
571-
Floating-point numbers are displayed in fixed notation with [fixed](../standard-library/ios-functions.md#fixed).
570+
Floating-point numbers are displayed in fixed notation with [`fixed`](../standard-library/ios-functions.md#fixed).
572571
573572
### Example
574573
@@ -854,7 +853,7 @@ Previous setting for this function.
854853

855854
### Remarks
856855

857-
The static member function stores a `stdio` sync flag, which is initially `true`. When `true`, this flag ensures that operations on the same file are properly synchronized between the [`iostreams`](../standard-library/iostreams-conventions.md) functions and those defined in the C++ Standard Library. Otherwise, synchronization may or may not be guaranteed, but performance may be improved. The function stores *_Sync* in the `stdio` sync flag and returns its previous stored value. You can call it reliably only before performing any operations on the standard streams.
856+
The static member function stores a `stdio` sync flag, which is initially `true`. When `true`, this flag ensures that operations on the same file are properly synchronized between the [`iostreams`](../standard-library/iostreams-conventions.md) functions and those defined in the C++ Standard Library. Otherwise, synchronization may or may not be guaranteed, but performance may be improved. The function stores *`_Sync`* in the `stdio` sync flag and returns its previous stored value. You can call it reliably only before performing any operations on the standard streams.
858857

859858
## <a name="unsetf"></a> `unsetf`
860859

0 commit comments

Comments
 (0)