Skip to content

Commit 498be16

Browse files
authored
Improve CallerArgumentExpressionAttribute (#7338)
1 parent f4a12b4 commit 498be16

File tree

1 file changed

+13
-5
lines changed

1 file changed

+13
-5
lines changed

xml/System.Runtime.CompilerServices/CallerArgumentExpressionAttribute.xml

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,15 @@
2323
</Attribute>
2424
</Attributes>
2525
<Docs>
26-
<summary>Allows capturing of the expressions passed to a method. NOTE: Is not yet implemented in C# compiler and does nothing.</summary>
27-
<remarks>To be added.</remarks>
26+
<summary>Indicates that a parameter captures the expression passed for another parameter as a string.</summary>
27+
<remarks>
28+
<format type="text/markdown"><![CDATA[
29+
30+
> [!NOTE]
31+
> This attribute is not yet implemented in the C# compiler and does nothing.
32+
33+
]]></format>
34+
</remarks>
2835
</Docs>
2936
<Members>
3037
<Member MemberName=".ctor">
@@ -46,7 +53,7 @@
4653
<Parameter Name="parameterName" Type="System.String" />
4754
</Parameters>
4855
<Docs>
49-
<param name="parameterName">The name of the targeted parameter.</param>
56+
<param name="parameterName">The name of the parameter whose expression should be captured as a string.</param>
5057
<summary>Initializes a new instance of the <see cref="T:System.Runtime.CompilerServices.CallerArgumentExpressionAttribute" /> class.</summary>
5158
<remarks>To be added.</remarks>
5259
</Docs>
@@ -70,9 +77,10 @@
7077
<ReturnType>System.String</ReturnType>
7178
</ReturnValue>
7279
<Docs>
73-
<summary>Gets the target parameter name of the CallerArgumentExpression.</summary>
74-
<value>The name of the targeted parameter of the CallerArgumentExpression.</value>
80+
<summary>Gets the name of the parameter whose expression should be captured as a string.</summary>
81+
<value>The name of the parameter whose expression should be captured.</value>
7582
<remarks>To be added.</remarks>
83+
<related type="Article" href="/dotnet/csharp/language-reference/proposals/csharp-10.0/caller-argument-expression">C# CallerArgumentExpression proposal</related>
7684
</Docs>
7785
</Member>
7886
</Members>

0 commit comments

Comments
 (0)