Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Revise usage of <code> tag in IOperation docs #74719

Merged
merged 1 commit into from
Aug 12, 2024
Merged

Revise usage of <code> tag in IOperation docs #74719

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/Compilers/Core/Portable/Generated/FlowAnalysis.Generated.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ public interface IFlowCaptureReferenceOperation : IOperation
/// </summary>
CaptureId Id { get; }
/// <summary>
/// True if this reference to the capture initializes the capture. Used when the capture is being initialized by being passed as an <code>out</code> parameter.
/// True if this reference to the capture initializes the capture. Used when the capture is being initialized by being passed as an <see langword="out" /> parameter.
/// </summary>
bool IsInitialization { get; }
}
Expand Down
22 changes: 11 additions & 11 deletions src/Compilers/Core/Portable/Generated/Operations.Generated.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -257,7 +257,7 @@ public interface IForToLoopOperation : ILoopOperation
/// </summary>
IOperation StepValue { get; }
/// <summary>
/// <code>true</code> if arithmetic operations behind this loop are 'checked'.
/// <see langword="true" /> if arithmetic operations behind this loop are 'checked'.
/// </summary>
bool IsChecked { get; }
/// <summary>
Expand Down Expand Up @@ -695,12 +695,12 @@ public interface IConversionOperation : IOperation
/// Current usage:
/// (1) C# method invocation expression.
/// (2) C# collection element initializer.
/// For example, in the following collection initializer: <code>new C() { 1, 2, 3 }</code>, we will have
/// For example, in the following collection initializer: <c>new C() { 1, 2, 3 }</c>, we will have
/// 3 <see cref="IInvocationOperation" /> nodes, each of which will be a call to the corresponding Add method
/// with either 1, 2, 3 as the argument.
/// (3) VB method invocation expression.
/// (4) VB collection element initializer.
/// Similar to the C# example, <code>New C() From {1, 2, 3}</code> will have 3 <see cref="IInvocationOperation" />
/// Similar to the C# example, <c>New C() From {1, 2, 3}</c> will have 3 <see cref="IInvocationOperation" />
/// nodes with 1, 2, and 3 as their arguments, respectively.
/// </para>
/// </summary>
Expand Down Expand Up @@ -1771,12 +1771,12 @@ public interface IDynamicMemberReferenceOperation : IOperation
/// Current usage:
/// (1) C# dynamic invocation expression.
/// (2) C# dynamic collection element initializer.
/// For example, in the following collection initializer: <code>new C() { do1, do2, do3 }</code> where
/// For example, in the following collection initializer: <c>new C() { do1, do2, do3 }</c> where
/// the doX objects are of type dynamic, we'll have 3 <see cref="IDynamicInvocationOperation" /> with do1, do2, and
/// do3 as their arguments.
/// (3) VB late bound invocation expression.
/// (4) VB dynamic collection element initializer.
/// Similar to the C# example, <code>New C() From {do1, do2, do3}</code> will generate 3 <see cref="IDynamicInvocationOperation" />
/// Similar to the C# example, <c>New C() From {do1, do2, do3}</c> will generate 3 <see cref="IDynamicInvocationOperation" />
/// nodes with do1, do2, and do3 as their arguments, respectively.
/// </para>
/// </summary>
Expand Down Expand Up @@ -2712,7 +2712,7 @@ public interface IConstantPatternOperation : IPatternOperation
public interface IDeclarationPatternOperation : IPatternOperation
{
/// <summary>
/// The type explicitly specified, or null if it was inferred (e.g. using <code>var</code> in C#).
/// The type explicitly specified, or null if it was inferred (e.g. using <see langword="var" /> in C#).
/// </summary>
ITypeSymbol? MatchedType { get; }
/// <summary>
Expand Down Expand Up @@ -2853,7 +2853,7 @@ public interface IDiscardOperation : IOperation
/// The result of the entire expression is<see cref="IAssignmentOperation.Target" />, which is only evaluated once.
/// <para>
/// Current usage:
/// (1) C# null-coalescing assignment operation <code>Target ??= Value</code>.
/// (1) C# null-coalescing assignment operation <c>Target ??= Value</c>.
/// </para>
/// </summary>
/// <remarks>
Expand Down Expand Up @@ -2893,7 +2893,7 @@ public interface IRangeOperation : IOperation
/// </summary>
IOperation? RightOperand { get; }
/// <summary>
/// <code>true</code> if this is a 'lifted' range operation. When there is an
/// <see langword="true" /> if this is a 'lifted' range operation. When there is an
/// operator that is defined to work on a value type, 'lifted' operators are
/// created to work on the <see cref="System.Nullable{T}" /> versions of those
/// value types.
Expand Down Expand Up @@ -2975,8 +2975,8 @@ public interface IRecursivePatternOperation : IPatternOperation
/// </summary>
ITypeSymbol MatchedType { get; }
/// <summary>
/// The symbol, if any, used for the fetching values for subpatterns. This is either a <code>Deconstruct</code>
/// method, the type <code>System.Runtime.CompilerServices.ITuple</code>, or null (for example, in
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should this just be a cref?

should the null be a langword?

/// The symbol, if any, used for the fetching values for subpatterns. This is either a <c>Deconstruct</c>
/// method, the type <c>System.Runtime.CompilerServices.ITuple</c>, or null (for example, in
/// error cases or when matching a tuple type).
/// </summary>
ISymbol? DeconstructSymbol { get; }
Expand Down Expand Up @@ -3296,7 +3296,7 @@ public interface IBinaryPatternOperation : IPatternOperation
public interface ITypePatternOperation : IPatternOperation
{
/// <summary>
/// The type explicitly specified, or null if it was inferred (e.g. using <code>var</code> in C#).
/// The type explicitly specified, or null if it was inferred (e.g. using <see langword="var" /> in C#).
/// </summary>
ITypeSymbol MatchedType { get; }
}
Expand Down
24 changes: 12 additions & 12 deletions src/Compilers/Core/Portable/Operations/OperationInterfaces.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -266,7 +266,7 @@
<Property Name="IsChecked" Type="bool">
<Comments>
<summary>
<code>true</code> if arithmetic operations behind this loop are 'checked'.</summary>
<see langword="true" /> if arithmetic operations behind this loop are 'checked'.</summary>
</Comments>
</Property>
<Property Name="NextVariables" Type="ImmutableArray&lt;IOperation&gt;">
Expand Down Expand Up @@ -656,12 +656,12 @@
Current usage:
(1) C# method invocation expression.
(2) C# collection element initializer.
For example, in the following collection initializer: <code>new C() { 1, 2, 3 }</code>, we will have
For example, in the following collection initializer: <c>new C() { 1, 2, 3 }</c>, we will have
3 <see cref="IInvocationOperation" /> nodes, each of which will be a call to the corresponding Add method
with either 1, 2, 3 as the argument.
(3) VB method invocation expression.
(4) VB collection element initializer.
Similar to the C# example, <code>New C() From {1, 2, 3}</code> will have 3 <see cref="IInvocationOperation" />
Similar to the C# example, <c>New C() From {1, 2, 3}</c> will have 3 <see cref="IInvocationOperation" />
nodes with 1, 2, and 3 as their arguments, respectively.
</para>
</summary>
Expand Down Expand Up @@ -1646,12 +1646,12 @@
Current usage:
(1) C# dynamic invocation expression.
(2) C# dynamic collection element initializer.
For example, in the following collection initializer: <code>new C() { do1, do2, do3 }</code> where
For example, in the following collection initializer: <c>new C() { do1, do2, do3 }</c> where
the doX objects are of type dynamic, we'll have 3 <see cref="IDynamicInvocationOperation" /> with do1, do2, and
do3 as their arguments.
(3) VB late bound invocation expression.
(4) VB dynamic collection element initializer.
Similar to the C# example, <code>New C() From {do1, do2, do3}</code> will generate 3 <see cref="IDynamicInvocationOperation" />
Similar to the C# example, <c>New C() From {do1, do2, do3}</c> will generate 3 <see cref="IDynamicInvocationOperation" />
nodes with do1, do2, and do3 as their arguments, respectively.
</para>
</summary>
Expand Down Expand Up @@ -2466,7 +2466,7 @@
<Property Name="MatchedType" Type="ITypeSymbol?">
<Comments>
<summary>
The type explicitly specified, or null if it was inferred (e.g. using <code>var</code> in C#).
The type explicitly specified, or null if it was inferred (e.g. using <see langword="var" /> in C#).
</summary>
</Comments>
</Property>
Expand Down Expand Up @@ -2624,7 +2624,7 @@
</Property>
<Property Name="IsInitialization" Type="bool">
<Comments>
<summary>True if this reference to the capture initializes the capture. Used when the capture is being initialized by being passed as an <code>out</code> parameter.</summary>
<summary>True if this reference to the capture initializes the capture. Used when the capture is being initialized by being passed as an <see langword="out" /> parameter.</summary>
</Comments>
</Property>
</Node>
Expand Down Expand Up @@ -2695,7 +2695,7 @@
The result of the entire expression is<see cref="IAssignmentOperation.Target" />, which is only evaluated once.
<para>
Current usage:
(1) C# null-coalescing assignment operation <code>Target ??= Value</code>.
(1) C# null-coalescing assignment operation <c>Target ??= Value</c>.
</para>
</summary>
</Comments>
Expand Down Expand Up @@ -2723,7 +2723,7 @@
<Property Name="IsLifted" Type="bool">
<Comments>
<summary>
<code>true</code> if this is a 'lifted' range operation. When there is an
<see langword="true" /> if this is a 'lifted' range operation. When there is an
operator that is defined to work on a value type, 'lifted' operators are
created to work on the <see cref="System.Nullable{T}" /> versions of those
value types.
Expand Down Expand Up @@ -2793,8 +2793,8 @@
<Property Name="DeconstructSymbol" Type="ISymbol?">
<Comments>
<summary>
The symbol, if any, used for the fetching values for subpatterns. This is either a <code>Deconstruct</code>
method, the type <code>System.Runtime.CompilerServices.ITuple</code>, or null (for example, in
The symbol, if any, used for the fetching values for subpatterns. This is either a <c>Deconstruct</c>
method, the type <c>System.Runtime.CompilerServices.ITuple</c>, or null (for example, in
error cases or when matching a tuple type).
</summary>
</Comments>
Expand Down Expand Up @@ -3070,7 +3070,7 @@
<Property Name="MatchedType" Type="ITypeSymbol">
<Comments>
<summary>
The type explicitly specified, or null if it was inferred (e.g. using <code>var</code> in C#).
The type explicitly specified, or null if it was inferred (e.g. using <see langword="var" /> in C#).
</summary>
</Comments>
</Property>
Expand Down
Loading