Skip to content

Commit f5c6a16

Browse files
megvanhuygenmegvanhuygen
authored
Merge pull request MicrosoftDocs#3049 from corob-msft/docs/corob/parameter-table-bulk-fix
Bulk fix: Canonicalize all table-form parameter lists
2 parents 79f44f5 + b56af56 commit f5c6a16

92 files changed

Lines changed: 1679 additions & 1328 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎docs/atl-mfc-shared/reference/coledatetime-class.md‎

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -953,8 +953,14 @@ int SetDate(
953953

954954
### Parameters
955955

956-
*nYear*, *nMonth*, *nDay*<br/>
957-
Indicate the date components to be copied into this `COleDateTime` object.
956+
*nYear*\
957+
Indicates the year to copy into this `COleDateTime` object.
958+
959+
*nMonth*\
960+
Indicates the month to copy into this `COleDateTime` object.
961+
962+
*nDay*\
963+
Indicates the day to copy into this `COleDateTime` object.
958964

959965
### Return Value
960966

‎docs/atl/reference/catltransactionmanager-class.md‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -407,10 +407,11 @@ inline LSTATUS RegDeleteKeyEx(HKEY hKey, LPCTSTR lpSubKey);
407407
408408
### Parameters
409409
410-
|Parameter|Description|
411-
|---------------|-----------------|
412-
|*hKey*|A handle to an open registry key.|
413-
|*lpSubKey*|The name of the key to be deleted.|
410+
*hKey*\
411+
A handle to an open registry key.
412+
413+
*lpSubKey*\
414+
The name of the key to be deleted.
414415
415416
### Return Value
416417

‎docs/build/reference/fi-preprocess-output-file-name.md‎

Lines changed: 37 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,42 +1,61 @@
11
---
22
title: "/Fi (Preprocess Output File Name)"
3-
ms.date: "11/04/2016"
3+
ms.date: 08/12/2020
44
f1_keywords: ["/Fi"]
55
helpviewer_keywords: ["Fi compiler option (C++)", "-Fi compiler option (C++)", "/Fi compiler option (C++)", "preprocessing output files, file name"]
66
ms.assetid: 6d0ba983-a8b7-41ec-84f5-b4688ef8efee
77
---
8-
# /Fi (Preprocess Output File Name)
8+
# `/Fi` (Preprocess output file name)
99

10-
Specifies the name of the output file to which the [/P (Preprocess to a File)](p-preprocess-to-a-file.md) compiler option writes preprocessed output.
10+
Specifies the name of the output file to which the [`/P` (Preprocess to a File)](p-preprocess-to-a-file.md) compiler option writes preprocessed output.
1111

1212
## Syntax
1313

14-
```
15-
/Fipathname
16-
```
14+
> **`/Fi`**_`pathname`_
1715
18-
#### Parameters
16+
### Parameters
1917

20-
|Parameter|Description|
21-
|---------------|-----------------|
22-
|`pathname`|The name and path of the output file produced by the **/P** compiler option.|
18+
*`pathname`*\
19+
The relative or absolute path and filename of the output file produced by the **`/P`** compiler option. Or, the directory path for the *`.i`* output files when more than one input file is specified. Don't put a space between the **`/Fi`** option and *`pathname`*.
2320

2421
## Remarks
2522

26-
Use the **/Fi** compiler option in combination with the **/P** compiler option.
23+
Use the **`/Fi`** compiler option in combination with the **`/P`** compiler option. If **`/P`** isn't specified, **`/Fi`** causes command line warning D9007.
2724

28-
If you specify only a path for the `pathname` parameter, the base name of the source file is used as the base name of the preprocessed output file. The `pathname` parameter does not require a particular file name extension. However, an extension of ".i" is used if you do not specify a file name extension.
25+
If you specify only a directory path (a path that ends in a backslash **`\`**) for the *`pathname`* parameter, the base name of the source file is used as the base name of the preprocessed output file. The *`pathname`* parameter doesn't require a particular file name extension. However, an extension of ".i" is used if you don't specify a file name extension.
2926

30-
## Example
27+
### Example
3128

32-
The following command line preprocesses PROGRAM.cpp, preserves comments, adds [#line](../../preprocessor/hash-line-directive-c-cpp.md) directives, and writes the result to the MYPROCESS.i file.
29+
The following command line preprocesses *`PROGRAM.cpp`*, preserves comments, adds [`#line`](../../preprocessor/hash-line-directive-c-cpp.md) directives, and writes the result to the *`MYPROCESS.i`* file:
3330

34-
```
31+
```cmd
3532
CL /P /FiMYPROCESS.I PROGRAM.CPP
3633
```
3734

35+
This command line preprocesses *`main.cpp`* and *`helper.cpp`* into *`main.i`* and *`helper.i`* in a subdirectory named *`preprocessed`*:
36+
37+
```cmd
38+
CL /P /Fi".\\preprocessed\\" main.cpp helper.cpp
39+
```
40+
41+
### To set this compiler option in the Visual Studio development environment
42+
43+
1. Open the source file or the project's **Property Pages** dialog box. For details, see [Set C++ compiler and build properties in Visual Studio](../working-with-project-properties.md).
44+
45+
1. Select the **Configuration Properties** > **C/C++** > **Preprocessor** property page.
46+
47+
1. Set the **Preprocess to a File** property to **Yes**.
48+
49+
1. Select the **Configuration Properties** > **C/C++** > **Command Line** property page.
50+
51+
1. Enter the **`/Fi`** compiler option and *`pathname`* in the **Additional Options** box. Only specify a directory path, not a filename, when setting this property for a project.
52+
53+
### To set this compiler option programmatically
54+
55+
- See <xref:Microsoft.VisualStudio.VCProjectEngine.VCCLCompilerTool.AdditionalOptions%2A>.
56+
3857
## See also
3958

40-
[MSVC Compiler Options](compiler-options.md)<br/>
41-
[/P (Preprocess to a File)](p-preprocess-to-a-file.md)<br/>
42-
[Specifying the Pathname](specifying-the-pathname.md)
59+
[MSVC compiler options](compiler-options.md)<br/>
60+
[`/P` (Preprocess to a file)](p-preprocess-to-a-file.md)<br/>
61+
[Specifying the pathname](specifying-the-pathname.md)

‎docs/c-runtime-library/reference/set-error-mode.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ Controls the error output sink by setting the value of **__error_mode**. For exa
3939

4040
The *mode_val* parameter can be set to one of the following values.
4141

42-
|Parameter|Description|
42+
|Value|Description|
4343
|---------------|-----------------|
4444
|**_OUT_TO_DEFAULT**|Error sink is determined by **__app_type**.|
4545
|**_OUT_TO_STDERR**|Error sink is a standard error.|

‎docs/c-runtime-library/reference/tzset.md‎

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -28,13 +28,20 @@ The **_tzset** function uses the current setting of the environment variable **T
2828
2929
> **set TZ=**_tzn_ \[**+**&#124;**-**]*hh*\[**:**_mm_\[**:**_ss_] ][*dzn*]
3030
31-
|Parameter|Description|
32-
|-|-|
33-
| *tzn* | Three-letter time-zone name, such as PST. You must specify the correct offset from local time to UTC. |
34-
| *hh* | Difference in hours between UTC and local time. Sign (+) optional for positive values. |
35-
| *mm* | Minutes. Separated from *hh* by a colon (**:**). |
36-
| *ss* | Seconds. Separated from *mm* by a colon (**:**). |
37-
| *dzn* | Three-letter daylight-saving-time zone such as PDT. If daylight saving time is never in effect in the locality, set **TZ** without a value for *dzn*. The C run-time library assumes the United States' rules for implementing the calculation of daylight saving time (DST). |
31+
*tzn* \
32+
Three-letter time-zone name, such as PST. You must specify the correct offset from local time to UTC.
33+
34+
*hh* \
35+
Difference in hours between UTC and local time. Sign (+) optional for positive values.
36+
37+
*mm* \
38+
Minutes. Separated from *hh* by a colon (**:**).
39+
40+
*ss* \
41+
Seconds. Separated from *mm* by a colon (**:**).
42+
43+
*dzn* \
44+
Three-letter daylight-saving-time zone such as PDT. If daylight saving time is never in effect in the locality, set **TZ** without a value for *dzn*. The C run-time library assumes the United States' rules for implementing the calculation of daylight saving time (DST).
3845
3946
> [!NOTE]
4047
> Take care in computing the sign of the time difference. Because the time difference is the offset from local time to UTC (rather than the reverse), its sign may be the opposite of what you might intuitively expect. For time zones ahead of UTC, the time difference is negative; for those behind UTC, the difference is positive.

‎docs/cpp/decltype-cpp.md‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,8 @@ The **`decltype`** type specifier yields the type of a specified expression. The
1515
1616
### Parameters
1717

18-
|Parameter|Description|
19-
|---------------|-----------------|
20-
|*expression*|An expression. For more information, see [Expressions](../cpp/expressions-cpp.md).|
18+
*expression*\
19+
An expression. For more information, see [Expressions](../cpp/expressions-cpp.md).
2120

2221
## Return Value
2322

‎docs/cpp/if-exists-statement.md‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,11 @@ statements
1919

2020
#### Parameters
2121

22-
|Parameter|Description|
23-
|---------------|-----------------|
24-
|*identifier*|The identifier whose existence you want to test.|
25-
|*statements*|One or more statements to execute if *identifier* exists.|
22+
*identifier*\
23+
The identifier whose existence you want to test.
24+
25+
*statements*\
26+
One or more statements to execute if *identifier* exists.
2627

2728
## Remarks
2829

‎docs/cpp/if-not-exists-statement.md‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,11 @@ statements
1919

2020
#### Parameters
2121

22-
|Parameter|Description|
23-
|---------------|-----------------|
24-
|*identifier*|The identifier whose existence you want to test.|
25-
|*statements*|One or more statements to execute if *identifier* does not exist.|
22+
*identifier*\
23+
The identifier whose existence you want to test.
24+
25+
*statements*\
26+
One or more statements to execute if *identifier* does not exist.
2627

2728
## Remarks
2829

‎docs/cpp/static-assert.md‎

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,12 +17,13 @@ static_assert( constant-expression, string-literal );
1717
static_assert( constant-expression ); // C++17 (Visual Studio 2017 and later)
1818
```
1919

20-
#### Parameters
20+
### Parameters
2121

22-
|Parameter|Description|
23-
|---------------|-----------------|
24-
|*constant-expression*|An integral constant expression that can be converted to a Boolean.<br /><br /> If the evaluated expression is zero (false), the *string-literal* parameter is displayed and the compilation fails with an error. If the expression is nonzero (true), the **`static_assert`** declaration has no effect.|
25-
|*string-literal*|An message that is displayed if the *constant-expression* parameter is zero. The message is a string of characters in the [base character set](../c-language/ascii-character-set.md) of the compiler; that is, not [multibyte or wide characters](../c-language/multibyte-and-wide-characters.md).|
22+
*constant-expression*\
23+
An integral constant expression that can be converted to a Boolean. If the evaluated expression is zero (false), the *string-literal* parameter is displayed and the compilation fails with an error. If the expression is nonzero (true), the **`static_assert`** declaration has no effect.
24+
25+
*string-literal*\
26+
An message that is displayed if the *constant-expression* parameter is zero. The message is a string of characters in the [base character set](../c-language/ascii-character-set.md) of the compiler; that is, not [multibyte or wide characters](../c-language/multibyte-and-wide-characters.md).
2627

2728
## Remarks
2829

‎docs/cpp/transporting-exceptions-between-threads.md‎

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -23,12 +23,17 @@ namespace std
2323

2424
### Parameters
2525

26-
|Parameter|Description|
27-
|---------------|-----------------|
28-
|*unspecified*|An unspecified internal class that is used to implement the `exception_ptr` type.|
29-
|*p*|An `exception_ptr` object that references an exception.|
30-
|*E*|A class that represents an exception.|
31-
|*e*|An instance of the parameter `E` class.|
26+
*unspecified*\
27+
An unspecified internal class that is used to implement the `exception_ptr` type.
28+
29+
*p*\
30+
An `exception_ptr` object that references an exception.
31+
32+
*E*\
33+
A class that represents an exception.
34+
35+
*e*\
36+
An instance of the parameter `E` class.
3237

3338
## Return value
3439

0 commit comments

Comments
 (0)