Skip to content

Commit 6596588

Browse files
author
Colin Robertson
committed
Move (optional) out of parameter name line
1 parent c5ec0fa commit 6596588

Some content is hidden

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

43 files changed

+283
-284
lines changed

docs/build/reference/ltcg-link-time-code-generation.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -26,23 +26,23 @@ These options are deprecated starting in Visual Studio 2015:
2626
2727
### Arguments
2828

29-
**INCREMENTAL** (optional)<br/>
30-
Specifies that the linker only applies whole program optimization or link-time code generation (LTCG) to the set of files affected by an edit, instead of the entire project. By default, this flag is not set when **/LTCG** is specified, and the entire project is linked by using whole program optimization.
29+
**INCREMENTAL**<br/>
30+
(Optional) Specifies that the linker only applies whole program optimization or link-time code generation (LTCG) to the set of files affected by an edit, instead of the entire project. By default, this flag is not set when **/LTCG** is specified, and the entire project is linked by using whole program optimization.
3131

32-
**NOSTATUS** &#124; **STATUS** (optional)<br/>
33-
Specifies whether the linker displays a progress indicator that shows what percentage of the link is complete. By default, this status information is not displayed.
32+
**NOSTATUS** &#124; **STATUS**<br/>
33+
(Optional) Specifies whether the linker displays a progress indicator that shows what percentage of the link is complete. By default, this status information is not displayed.
3434

35-
**OFF** (optional)<br/>
36-
Disables link-time code generation. This behavior is the same as when **/LTCG** is not specified on the command line.
35+
**OFF**<br/>
36+
(Optional) Disables link-time code generation. This behavior is the same as when **/LTCG** is not specified on the command line.
3737

38-
**PGINSTRUMENT** (optional)<br/>
39-
This option is deprecated starting in Visual Studio 2015. Instead, use **/LTCG** and [/GENPROFILE or /FASTGENPROFILE](genprofile-fastgenprofile-generate-profiling-instrumented-build.md) to generate an instrumented build for profile-guided optimization. The data that is collected from instrumented runs is used to create an optimized image. For more information, see [Profile Guided Optimization](profile-guided-optimizations.md). The short form of this option is **/LTCG:PGI**.
38+
**PGINSTRUMENT**<br/>
39+
(Optional) This option is deprecated starting in Visual Studio 2015. Instead, use **/LTCG** and [/GENPROFILE or /FASTGENPROFILE](genprofile-fastgenprofile-generate-profiling-instrumented-build.md) to generate an instrumented build for profile-guided optimization. The data that is collected from instrumented runs is used to create an optimized image. For more information, see [Profile Guided Optimization](profile-guided-optimizations.md). The short form of this option is **/LTCG:PGI**.
4040

41-
**PGOPTIMIZE** (optional)<br/>
42-
This option is deprecated starting in Visual Studio 2015. Instead, use **/LTCG** and [/USEPROFILE](useprofile.md) to build an optimized image. For more information, see [Profile Guided Optimization](../../build/reference/profile-guided-optimizations.md). The short form of this option is **/LTCG:PGO**.
41+
**PGOPTIMIZE**<br/>
42+
(Optional) This option is deprecated starting in Visual Studio 2015. Instead, use **/LTCG** and [/USEPROFILE](useprofile.md) to build an optimized image. For more information, see [Profile Guided Optimization](../../build/reference/profile-guided-optimizations.md). The short form of this option is **/LTCG:PGO**.
4343

44-
**PGUPDATE** (optional)<br/>
45-
This option is deprecated starting in Visual Studio 2015. Instead, use **/LTCG** and **/USEPROFILE** to rebuild an optimized image. For more information, see [Profile Guided Optimization](../../build/reference/profile-guided-optimizations.md). The short form of this option is **/LTCG:PGU**.
44+
**PGUPDATE**<br/>
45+
(Optional) This option is deprecated starting in Visual Studio 2015. Instead, use **/LTCG** and **/USEPROFILE** to rebuild an optimized image. For more information, see [Profile Guided Optimization](../../build/reference/profile-guided-optimizations.md). The short form of this option is **/LTCG:PGU**.
4646

4747
## Remarks
4848

docs/build/reference/pdbpath.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -17,14 +17,13 @@ ms.workload: ["cplusplus"]
1717
/PDBPATH[:VERBOSE] filename
1818
```
1919

20-
## Remarks
21-
where:
22-
23-
*filename*
24-
The name of the .dll or .exe file for which you want to find the matching .pdb file.
20+
### Parameters
21+
22+
*filename*<br/>
23+
The name of the .dll or .exe file for which you want to find the matching .pdb file.
2524

26-
VERBOSE (optional)
27-
Reports all directories where an attempt was made to locate the .pdb file.
25+
**:VERBOSE**<br/>
26+
(Optional) Reports all directories where an attempt was made to locate the .pdb file.
2827

2928
## Remarks
3029
/PDBPATH will search your computer along the same paths that the debugger would search for a .pdb file and will report which, if any, .pdb files correspond to the file specified in *filename*.

docs/build/reference/pgosweep.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,8 @@ Used in profile-guided optimization to write all profile data from a running pro
2121
2222
### Parameters
2323

24-
*options* (optional)<br/>
25-
The valid values for *options* are:
24+
*options*<br/>
25+
(Optional) The valid values for *options* are:
2626

2727
- **/?** or **/help** displays the help message.
2828

docs/build/reference/range.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -21,13 +21,14 @@ Modifies the output of dumpbin when used with other dumpbin options, such as /RA
2121
/RANGE:vaMin[,vaMax]
2222
```
2323

24-
## Flags
25-
**vaMin**
26-
The virtual address at which you want the dumpbin operation to begin.
27-
28-
**vaMax** (optional)
29-
The virtual address at which you want the dumpbin operation to end. If not specified, dumpbin will go to the end of the file.
30-
24+
## Parameters
25+
26+
*vaMin*<br/>
27+
The virtual address at which you want the dumpbin operation to begin.
28+
29+
*vaMax*<br/>
30+
(Optional) The virtual address at which you want the dumpbin operation to end. If not specified, dumpbin will go to the end of the file.
31+
3132
## Remarks
3233
To see the virtual addresses for an image, use the map file for the image (RVA + Base), the **/DISASM** or **/HEADERS** option of dumpbin, or the disassembly window in the Visual Studio debugger.
3334

docs/build/reference/subsystem-specify-subsystem.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,8 +38,8 @@ ms.workload: ["cplusplus"]
3838
WINDOWS
3939
Application does not require a console, probably because it creates its own windows for interaction with the user. If `WinMain` or `wWinMain` is defined for native code, or `WinMain(HISTANCE *, HINSTANCE *, char *, int)` or `wWinMain(HINSTANCE *, HINSTANCE *, wchar_t *, int)` is defined for managed code, WINDOWS is the default.
4040

41-
`Major` and `minor` (optional)
42-
Specify the minimum required version of the subsystem. The arguments are decimal numbers in the range 0 through 65,535. See the Remarks for more information. There are no upper bounds for version numbers.
41+
*major* and *minor*<br/>
42+
(Optional) Specify the minimum required version of the subsystem. The arguments are decimal numbers in the range 0 through 65,535. See the Remarks for more information. There are no upper bounds for version numbers.
4343

4444
## Remarks
4545
The /SUBSYSTEM option specifies the environment for the executable.

docs/cpp/hook.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -63,8 +63,8 @@ A pointer to the event handler method to be hooked to an event. The handler is s
6363

6464
- Managed events: *ReceiverClass* is the event receiver class and `HandlerMethod` is the handler.
6565

66-
*receiver* (optional)<br/>
67-
A pointer to an instance of the event receiver class. If you do not specify a receiver, the default is the receiver class or structure in which **__hook** is called.
66+
*receiver*<br/>
67+
(Optional) A pointer to an instance of the event receiver class. If you do not specify a receiver, the default is the receiver class or structure in which **__hook** is called.
6868

6969
## Usage
7070

docs/cpp/structured-exception-handling-c-cpp.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,10 @@ Structured exception handling (SEH) is a Microsoft extension to C to handle cert
1919

2020
## Grammar
2121

22-
*try-except-statement* :
22+
*try-except-statement* :<br/>
2323
&nbsp;&nbsp;&nbsp;&nbsp;**__try** *compound-statement* **__except** **(** *expression* **)** *compound-statement*
2424

25-
*try-finally-statement* :
25+
*try-finally-statement* :<br/>
2626
&nbsp;&nbsp;&nbsp;&nbsp;**__try** *compound-statement* **__finally** *compound-statement*
2727

2828
## Remarks

docs/parallel/openmp/reference/critical.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,8 @@ Specifies that code is only be executed on one thread at a time.
2626

2727
## Arguments
2828

29-
*name* (optional)<br/>
30-
A name to identify the critical code. Note that name must be enclosed in parentheses.
29+
*name*<br/>
30+
(Optional) A name to identify the critical code. Note that name must be enclosed in parentheses.
3131

3232
## Remarks
3333
The **critical** directive supports no OpenMP clauses.

docs/parallel/openmp/reference/flush-openmp.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,8 @@ Specifies that all threads have the same view of memory for all shared objects.
2323

2424
## Arguments
2525

26-
*var* (optional)<br/>
27-
A comma-separated list of variables that represent objects you want to synchronize. If `var` is not specified, all memory is flushed.
26+
*var*<br/>
27+
(Optional) A comma-separated list of variables that represent objects you want to synchronize. If `var` is not specified, all memory is flushed.
2828

2929
## Remarks
3030
The **flush** directive supports no OpenMP clauses.

docs/parallel/openmp/reference/for-openmp.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,8 @@ Causes the work done in a for loop inside a parallel region to be divided among
2424

2525
## Arguments
2626

27-
*clause* (optional)<br/>
28-
Zero or more clauses. See the Remarks section for a list of the clauses supported by **for**.
27+
*clause*<br/>
28+
(Optional) Zero or more clauses. See the Remarks section for a list of the clauses supported by **for**.
2929

3030
*for_statement*<br/>
3131
A for loop. Undefined behavior will result if user code in the for loop changes the index variable.

0 commit comments

Comments
 (0)