Skip to content

Commit ef0bfad

Browse files
author
Colin Robertson
committed
Restyle keywords, starting with "a"
1 parent 3d94f3a commit ef0bfad

50 files changed

Lines changed: 564 additions & 486 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/build-insights/reference/sdk/functions/make-dynamic-analyzer-group.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,12 +32,12 @@ A vector of [IAnalyzer](../other-types/ianalyzer-class.md) pointers included in
3232
3333
### Return Value
3434
35-
A dynamic analyzer group. Use the **auto** keyword to capture the return value.
35+
A dynamic analyzer group. Use the **`auto`** keyword to capture the return value.
3636
3737
## Remarks
3838
39-
Unlike static analyzer groups, the members of a dynamic analyzer group don't need to be known at compile time. You can choose analyzer group members at runtime based on program input, or based on other values that are unknown at compile time. Unlike static analyzer groups, [IAnalyzer](../other-types/ianalyzer-class.md) pointers within a dynamic analyzer group have polymorphic behavior, and virtual function calls are dispatched correctly. This flexibility comes at the cost of a possibly slower event processing time. When all analyzer group members are known at compile time, and if you don't need polymorphic behavior, consider using a static analyzer group. To use a static analyzer group, call [MakeStaticAnalyzerGroup](make-static-analyzer-group.md) instead.
39+
Unlike static analyzer groups, the members of a dynamic analyzer group don't need to be known at compile time. You can choose analyzer group members at runtime based on program input, or based on other values that are unknown at compile time. Unlike static analyzer groups, [`IAnalyzer`](../other-types/ianalyzer-class.md) pointers within a dynamic analyzer group have polymorphic behavior, and virtual function calls are dispatched correctly. This flexibility comes at the cost of a possibly slower event processing time. When all analyzer group members are known at compile time, and if you don't need polymorphic behavior, consider using a static analyzer group. To use a static analyzer group, call [`MakeStaticAnalyzerGroup`](make-static-analyzer-group.md) instead.
4040
41-
A dynamic analyzer group can be encapsulated inside a static analyzer group. It's done by passing its address to [MakeStaticAnalyzerGroup](make-static-analyzer-group.md). Use this technique for passing dynamic analyzer groups to functions such as [Analyze](analyze.md), which only accept static analyzer groups.
41+
A dynamic analyzer group can be encapsulated inside a static analyzer group. It's done by passing its address to [`MakeStaticAnalyzerGroup`](make-static-analyzer-group.md). Use this technique for passing dynamic analyzer groups to functions such as [`Analyze`](analyze.md), which only accept static analyzer groups.
4242
4343
::: moniker-end

‎docs/build-insights/reference/sdk/functions/make-dynamic-relogger-group.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,12 +32,12 @@ A vector of [IRelogger](../other-types/irelogger-class.md) pointers included in
3232
3333
### Return Value
3434
35-
A dynamic relogger group. Use the **auto** keyword to capture the return value.
35+
A dynamic relogger group. Use the **`auto`** keyword to capture the return value.
3636
3737
## Remarks
3838
39-
Unlike static relogger groups, the members of a dynamic relogger group don't need to be known at compile time. You can choose relogger group members at runtime based on program input, or based on other values that are unknown at compile time. Unlike static relogger groups, [IRelogger](../other-types/irelogger-class.md) pointers within a dynamic relogger group have polymorphic behavior, and virtual function calls are dispatched correctly. This flexibility comes at the cost of a possibly slower event processing time. When all relogger group members are known at compile time, and if you don't need polymorphic behavior, consider using a static relogger group. To use a static relogger group, call [MakeStaticReloggerGroup](make-static-relogger-group.md) instead.
39+
Unlike static relogger groups, the members of a dynamic relogger group don't need to be known at compile time. You can choose relogger group members at runtime based on program input, or based on other values that are unknown at compile time. Unlike static relogger groups, [`IRelogger`](../other-types/irelogger-class.md) pointers within a dynamic relogger group have polymorphic behavior, and virtual function calls are dispatched correctly. This flexibility comes at the cost of a possibly slower event processing time. When all relogger group members are known at compile time, and if you don't need polymorphic behavior, consider using a static relogger group. To use a static relogger group, call [`MakeStaticReloggerGroup`](make-static-relogger-group.md) instead.
4040
41-
A dynamic relogger group can be encapsulated inside a static relogger group. You pass its address to [MakeStaticReloggerGroup](make-static-relogger-group.md). Use this technique for passing dynamic relogger groups to functions such as [Relog](relog.md), which only accept static relogger groups.
41+
A dynamic relogger group can be encapsulated inside a static relogger group. You pass its address to [`MakeStaticReloggerGroup`](make-static-relogger-group.md). Use this technique for passing dynamic relogger groups to functions such as [`Relog`](relog.md), which only accept static relogger groups.
4242
4343
::: moniker-end

‎docs/build-insights/reference/sdk/functions/make-static-analyzer-group.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ The C++ Build Insights SDK is compatible with Visual Studio 2017 and above. To s
1313
::: moniker-end
1414
::: moniker range=">=vs-2017"
1515

16-
The `MakeStaticAnalyzerGroup` function is used to create a static analyzer group that can be passed to functions such as [Analyze](analyze.md) or [Relog](relog.md). Members of an analyzer group receive events one by one from left to right, until all events in a trace get analyzed.
16+
The `MakeStaticAnalyzerGroup` function is used to create a static analyzer group that can be passed to functions such as [`Analyze`](analyze.md) or [`Relog`](relog.md). Members of an analyzer group receive events one by one from left to right, until all events in a trace get analyzed.
1717

1818
## Syntax
1919

@@ -28,14 +28,14 @@ auto MakeStaticAnalyzerGroup(TAnalyzerPtrs... analyzers);
2828
This parameter is always deduced.
2929
3030
*analyzers*\
31-
A parameter pack of [IAnalyzer](../other-types/ianalyzer-class.md) pointers included in the static analyzer group. These pointers can be raw, `std::unique_ptr`, or `std::shared_ptr`.
31+
A parameter pack of [`IAnalyzer`](../other-types/ianalyzer-class.md) pointers included in the static analyzer group. These pointers can be raw, `std::unique_ptr`, or `std::shared_ptr`.
3232
3333
### Return Value
3434
35-
A static analyzer group. Use the **auto** keyword to capture the return value.
35+
A static analyzer group. Use the **`auto`** keyword to capture the return value.
3636
3737
## Remarks
3838
39-
Unlike dynamic analyzer groups, the members of a static analyzer group must be known at compile time. Additionally, a static analyzer group contains [IAnalyzer](../other-types/ianalyzer-class.md) pointers that don't have polymorphic behavior. When using a static analyzer group to analyze an Event Tracing for Windows (ETW) trace, calls to the `IAnalyzer` interface always resolve to the object directly pointed to by the analyzer group member. This loss of flexibility comes with a possibility of faster event processing times. If the members of an analyzer group can't be known at compile time, or if you require polymorphic behavior on your `IAnalyzer` pointers, consider using a dynamic analyzer group. To use a dynamic analyzer group, call [MakeDynamicAnalyzerGroup](make-static-analyzer-group.md) instead.
39+
Unlike dynamic analyzer groups, the members of a static analyzer group must be known at compile time. Additionally, a static analyzer group contains [`IAnalyzer`](../other-types/ianalyzer-class.md) pointers that don't have polymorphic behavior. When using a static analyzer group to analyze an Event Tracing for Windows (ETW) trace, calls to the `IAnalyzer` interface always resolve to the object directly pointed to by the analyzer group member. This loss of flexibility comes with a possibility of faster event processing times. If the members of an analyzer group can't be known at compile time, or if you require polymorphic behavior on your `IAnalyzer` pointers, consider using a dynamic analyzer group. To use a dynamic analyzer group, call [`MakeDynamicAnalyzerGroup`](make-static-analyzer-group.md) instead.
4040
4141
::: moniker-end

‎docs/build-insights/reference/sdk/functions/make-static-relogger-group.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,14 +28,14 @@ auto MakeStaticReloggerGroup(TReloggerPtrs... reloggers);
2828
This parameter is always deduced.
2929
3030
*reloggers*\
31-
A parameter pack of [IRelogger](../other-types/irelogger-class.md) pointers that's included in the static relogger group. These pointers can be raw, `std::unique_ptr`, or `std::shared_ptr`. [IAnalyzer](../other-types/ianalyzer-class.md) pointers are also considered `IRelogger` pointers because of an inheritance relationship.
31+
A parameter pack of [`IRelogger`](../other-types/irelogger-class.md) pointers that's included in the static relogger group. These pointers can be raw, `std::unique_ptr`, or `std::shared_ptr`. [`IAnalyzer`](../other-types/ianalyzer-class.md) pointers are also considered `IRelogger` pointers because of an inheritance relationship.
3232
3333
### Return Value
3434
35-
A static relogger group. Use the **auto** keyword to capture the return value.
35+
A static relogger group. Use the **`auto`** keyword to capture the return value.
3636
3737
## Remarks
3838
39-
Unlike dynamic relogger groups, the members of a static relogger group must be known at compile time. Additionally, a static relogger group contains [IRelogger](../other-types/irelogger-class.md) pointers that don't have polymorphic behavior. When using a static relogger group to analyze an Event Tracing for Windows (ETW) trace, calls to the `IRelogger` interface always resolve to the object directly pointed to by the relogger group member. This loss of flexibility comes with a possibility of faster event processing times. If the members of a relogger group can't be known at compile time, or if you require polymorphic behavior on your `IRelogger` pointers, consider using a dynamic relogger group. You can use a dynamic relogger group by calling [MakeDynamicReloggerGroup](make-dynamic-relogger-group.md) instead.
39+
Unlike dynamic relogger groups, the members of a static relogger group must be known at compile time. Additionally, a static relogger group contains [`IRelogger`](../other-types/irelogger-class.md) pointers that don't have polymorphic behavior. When using a static relogger group to analyze an Event Tracing for Windows (ETW) trace, calls to the `IRelogger` interface always resolve to the object directly pointed to by the relogger group member. This loss of flexibility comes with a possibility of faster event processing times. If the members of a relogger group can't be known at compile time, or if you require polymorphic behavior on your `IRelogger` pointers, consider using a dynamic relogger group. You can use a dynamic relogger group by calling [`MakeDynamicReloggerGroup`](make-dynamic-relogger-group.md) instead.
4040
4141
::: moniker-end

‎docs/build-insights/reference/sdk/functions/match-event-in-member-function.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ The arguments that get perfect-forwarded to *memberFunc* along with the event ty
6262
6363
### Return Value
6464
65-
A **bool** value that is **true** if matching was successful, or **false** otherwise.
65+
A **`bool`** value that is **`true`** if matching was successful, or **`false`** otherwise.
6666
6767
## Remarks
6868

‎docs/build-insights/reference/sdk/functions/match-event.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ The arguments that get perfect-forwarded to *callable* along with the matched ev
5454
5555
### Return Value
5656
57-
A **bool** value that's **true** if matching was successful, or **false** otherwise.
57+
A **`bool`** value that's **`true`** if matching was successful, or **`false`** otherwise.
5858
5959
## Remarks
6060

‎docs/build/reference/std-specify-language-standard-version.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ ms.date: "06/04/2020"
44
f1_keywords: ["/std", "-std", "VC.Project.VCCLCompilerTool.CppLanguageStandard"]
55
ms.assetid: 0acb74ba-1aa8-4c05-b96c-682988dc19bd
66
---
7-
# /std (Specify Language Standard Version)
7+
# `/std` (Specify Language Standard Version)
88

99
Enable supported C++ language features from the specified version of the C++ language standard.
1010

@@ -20,9 +20,9 @@ The **`/std`** option is available in Visual Studio 2017 and later. It's used to
2020

2121
The default **`/std:c++14`** option enables the set of C++14 features implemented by the MSVC compiler. This option disables compiler and standard library support for features that are changed or new in more recent versions of the language standard. It doesn't disable some C++17 features already implemented in previous releases of the MSVC compiler. To avoid breaking changes for users who have already taken dependencies on the features available in or before Visual Studio 2015 Update 2, these features remain enabled when the **`/std:c++14`** option is specified:
2222

23-
- [Rules for auto with braced-init-lists](https://wg21.link/n3922)
23+
- [Rules for `auto` with braced-init-lists](https://wg21.link/n3922)
2424

25-
- [typename in template template-parameters](https://wg21.link/n4051)
25+
- [`typename` in template template-parameters](https://wg21.link/n4051)
2626

2727
- [Removing trigraphs](https://wg21.link/n4086)
2828

‎docs/build/reference/zc-auto-deduce-variable-type.md‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,29 +5,29 @@ f1_keywords: ["/Zc:auto"]
55
helpviewer_keywords: ["-Zc compiler options (C++)", "Deduce variable type (C++)", "/Zc compiler options (C++)", "Zc compiler options (C++)"]
66
ms.assetid: 5f5bc102-44c3-4688-bbe1-080594dcee5c
77
---
8-
# /Zc:auto (Deduce Variable Type)
8+
# `/Zc:auto` (Deduce Variable Type)
99

10-
The **/Zc:auto[-]** compiler option tells the compiler how to use the [auto keyword](../../cpp/auto-keyword.md) to declare variables. If you specify the default option, **/Zc:auto**, the compiler deduces the type of the declared variable from its initialization expression. If you specify **/Zc:auto-**, the compiler allocates the variable to the automatic storage class.
10+
The **`/Zc:auto`** compiler option tells the compiler how to use the [`auto` keyword](../../cpp/auto-keyword.md) to declare variables. If you specify the default option, **`/Zc:auto`**, the compiler deduces the type of the declared variable from its initialization expression. If you specify **`/Zc:auto-`**, the compiler allocates the variable to the automatic storage class.
1111

1212
## Syntax
1313

14-
> **/Zc:auto**[**-**]
14+
> **`/Zc:auto`**[**`-`**]
1515
1616
## Remarks
1717

18-
The C++ standard defines an original and a revised meaning for the `auto` keyword. Before Visual Studio 2010, the keyword declares a variable in the automatic storage class; that is, a variable that has a local lifetime. Starting with Visual Studio 2010, the keyword deduces the type of a variable from the declaration's initialization expression. Use the **/Zc:auto[-]** compiler option to tell the compiler to use the original or revised meaning of the `auto` keyword. The **/Zc:auto** option is on by default. The [/permissive-](permissive-standards-conformance.md) option does not change the default setting of **/Zc:auto**.
18+
The C++ standard defines an original and a revised meaning for the **`auto`** keyword. Before Visual Studio 2010, the keyword declares a variable in the automatic storage class; that is, a variable that has a local lifetime. Starting with Visual Studio 2010, the keyword deduces the type of a variable from the declaration's initialization expression. Use the **`/Zc:auto`** compiler option to tell the compiler to use the revised meaning of the **`auto`** keyword. The **`/Zc:auto`** option is on by default. The [/permissive-](permissive-standards-conformance.md) option does not change the default setting of **`/Zc:auto`**.
1919

20-
The compiler issues an appropriate diagnostic message if your use of the `auto` keyword contradicts the current **/Zc:auto** compiler option. For more information, see [auto Keyword](../../cpp/auto-keyword.md). For more information about conformance issues with Visual C++, see [Nonstandard Behavior](../../cpp/nonstandard-behavior.md).
20+
The compiler issues an appropriate diagnostic message if your use of the **`auto`** keyword contradicts the current **`/Zc:auto`** compiler option. For more information, see [`auto` Keyword](../../cpp/auto-keyword.md). For more information about conformance issues with Visual C++, see [Nonstandard Behavior](../../cpp/nonstandard-behavior.md).
2121

2222
### To set this compiler option in Visual Studio
2323

2424
1. Open the project's **Property Pages** dialog box. For details, see [Set C++ compiler and build properties in Visual Studio](../working-with-project-properties.md).
2525

2626
1. Select the **Configuration Properties** > **C/C++** > **Command Line** property page.
2727

28-
1. Add **/Zc:auto** or **/Zc:auto-** to the **Additional options:** pane.
28+
1. Add **`/Zc:auto`** or **`/Zc:auto-`** to the **Additional options:** pane.
2929

3030
## See also
3131

32-
[/Zc (Conformance)](zc-conformance.md)<br/>
33-
[auto Keyword](../../cpp/auto-keyword.md)
32+
[`/Zc` (Conformance)](zc-conformance.md)<br/>
33+
[`auto` Keyword](../../cpp/auto-keyword.md)

0 commit comments

Comments
 (0)