Skip to content

Add link from each attribute class to conceptual article #6626

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

Merged
merged 3 commits into from
Apr 12, 2021
Merged

Add link from each attribute class to conceptual article #6626

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
43787ea
Add link from each attribute class to conceptual article
BillWagner Apr 9, 2021
cc68f00
Apply suggestions from code review
BillWagner Apr 12, 2021
9f935d1
Respond to code review
BillWagner Apr 12, 2021
File filter

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion xml/System.Diagnostics.CodeAnalysis/AllowNullAttribute.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,8 @@
</Attributes>
<Docs>
<summary>Specifies that <see langword="null" /> is allowed as an input even if the corresponding type disallows it.</summary>
<remarks>To override a method that has a parameter annotated with this attribute, use the <code>?</code> operator. For example: <code>override ISet&lt;Enum&gt; ReadJson(JsonReader reader, Type objectType, ISet&lt;Enum&gt;? existingValue, bool hasExistingValue, JsonSerializer serializer)</code>.</remarks>
<remarks>To override a method that has a parameter annotated with this attribute, use the <code>?</code> operator. For example: <code>override ISet&lt;Enum&gt; ReadJson(JsonReader reader, Type objectType, ISet&lt;Enum&gt;? existingValue, bool hasExistingValue, JsonSerializer serializer)</code>. For more information, see <see href="/dotnet/csharp/language-reference/attributes/nullable-analysis">Nullable static analysis</see> in the C# guide.</remarks>
<related type="Article" href="/dotnet/csharp/language-reference/attributes/nullable-analysis">Nullable static analysis</related>
Copy link
Member Author

@BillWagner BillWagner Apr 12, 2021

Choose a reason for hiding this comment

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

@gewarren Does this tag need to be under a different parent element? It's not showing up on the review site.
Copy link
Contributor

@gewarren gewarren Apr 12, 2021

Choose a reason for hiding this comment

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

This looks like the correct place. It seems to me you've uncovered a bug: I don't see any See Also sections being rendered for types, e.g. InvalidToolsetDefinitionException. However, I do see one being added for a method overload, and here's the source for that, so it's in the same place. Do you want to log a bug and assign to @mimisasouvanh ?
</Docs>
<Members>
<Member MemberName=".ctor">
Expand Down
3 changes: 2 additions & 1 deletion xml/System.Diagnostics.CodeAnalysis/DisallowNullAttribute.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,8 @@
</Attributes>
<Docs>
<summary>Specifies that <see langword="null" /> is disallowed as an input even if the corresponding type allows it.</summary>
<remarks>To be added.</remarks>
<remarks>For more information, see <see href="/dotnet/csharp/language-reference/attributes/nullable-analysis">Nullable static analysis</see> in the C# guide.</remarks>
<related type="Article" href="/dotnet/csharp/language-reference/attributes/nullable-analysis">Nullable static analysis</related>
</Docs>
<Members>
<Member MemberName=".ctor">
Expand Down
3 changes: 2 additions & 1 deletion xml/System.Diagnostics.CodeAnalysis/DoesNotReturnAttribute.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,8 @@
</Attributes>
<Docs>
<summary>Specifies that a method that will never return under any circumstance.</summary>
<remarks>To be added.</remarks>
<remarks>For more information, see <see href="/dotnet/csharp/language-reference/attributes/nullable-analysis">Nullable static analysis</see> in the C# guide.</remarks>
<related type="Article" href="/dotnet/csharp/language-reference/attributes/nullable-analysis">Nullable static analysis</related>
</Docs>
<Members>
<Member MemberName=".ctor">
Expand Down
3 changes: 2 additions & 1 deletion xml/System.Diagnostics.CodeAnalysis/DoesNotReturnIfAttribute.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,8 @@
</Attributes>
<Docs>
<summary>Specifies that the method will not return if the associated <see cref="T:System.Boolean" /> parameter is passed the specified value.</summary>
<remarks>To be added.</remarks>
<remarks>For more information, see <see href="/dotnet/csharp/language-reference/attributes/nullable-analysis">Nullable static analysis</see> in the C# guide.</remarks>
<related type="Article" href="/dotnet/csharp/language-reference/attributes/nullable-analysis">Nullable static analysis</related>
</Docs>
<Members>
<Member MemberName=".ctor">
Expand Down
3 changes: 2 additions & 1 deletion xml/System.Diagnostics.CodeAnalysis/MaybeNullAttribute.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,8 @@
</Attributes>
<Docs>
<summary>Specifies that an output may be <see langword="null" /> even if the corresponding type disallows it.</summary>
<remarks>To be added.</remarks>
<remarks>For more information, see <see href="/dotnet/csharp/language-reference/attributes/nullable-analysis">Nullable static analysis</see> in the C# guide.</remarks>
<related type="Article" href="/dotnet/csharp/language-reference/attributes/nullable-analysis">Nullable static analysis</related>
</Docs>
<Members>
<Member MemberName=".ctor">
Expand Down
3 changes: 2 additions & 1 deletion xml/System.Diagnostics.CodeAnalysis/MaybeNullWhenAttribute.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,8 @@
</Attributes>
<Docs>
<summary>Specifies that when a method returns <see cref="P:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute.ReturnValue" />, the parameter may be <see langword="null" /> even if the corresponding type disallows it.</summary>
<remarks>To be added.</remarks>
<remarks>For more information, see <see href="/dotnet/csharp/language-reference/attributes/nullable-analysis">Nullable static analysis</see> in the C# guide.</remarks>
<related type="Article" href="/dotnet/csharp/language-reference/attributes/nullable-analysis">Nullable static analysis</related>
</Docs>
<Members>
<Member MemberName=".ctor">
Expand Down
3 changes: 2 additions & 1 deletion xml/System.Diagnostics.CodeAnalysis/MemberNotNullAttribute.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,8 @@
</Attributes>
<Docs>
<summary>Specifies that the method or property will ensure that the listed field and property members have values that aren't <see langword="null" />.</summary>
<remarks>To be added.</remarks>
<remarks>For more information, see <see href="/dotnet/csharp/language-reference/attributes/nullable-analysis">Nullable static analysis</see> in the C# guide.</remarks>
<related type="Article" href="/dotnet/csharp/language-reference/attributes/nullable-analysis">Nullable static analysis</related>
</Docs>
<Members>
<Member MemberName=".ctor">
Expand Down
3 changes: 2 additions & 1 deletion xml/System.Diagnostics.CodeAnalysis/MemberNotNullWhenAttribute.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,8 @@
</Attributes>
<Docs>
<summary>Specifies that the method or property will ensure that the listed field and property members have non-null values when returning with the specified return value condition.</summary>
<remarks>To be added.</remarks>
<remarks>For more information, see <see href="/dotnet/csharp/language-reference/attributes/nullable-analysis">Nullable static analysis</see> in the C# guide.</remarks>
<related type="Article" href="/dotnet/csharp/language-reference/attributes/nullable-analysis">Nullable static analysis</related>
</Docs>
<Members>
<Member MemberName=".ctor">
Expand Down
3 changes: 2 additions & 1 deletion xml/System.Diagnostics.CodeAnalysis/NotNullAttribute.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,8 @@
</Attributes>
<Docs>
<summary>Specifies that an output is not <see langword="null" /> even if the corresponding type allows it. Specifies that an input argument was not <see langword="null" /> when the call returns.</summary>
<remarks>To be added.</remarks>
<remarks>For more information, see <see href="/dotnet/csharp/language-reference/attributes/nullable-analysis">Nullable static analysis</see> in the C# guide.</remarks>
<related type="Article" href="/dotnet/csharp/language-reference/attributes/nullable-analysis">Nullable static analysis</related>
</Docs>
<Members>
<Member MemberName=".ctor">
Expand Down
3 changes: 2 additions & 1 deletion xml/System.Diagnostics.CodeAnalysis/NotNullIfNotNullAttribute.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,8 @@
</Attributes>
<Docs>
<summary>Specifies that the output will be non-null if the named parameter is non-null.</summary>
<remarks>To be added.</remarks>
<remarks>For more information, see <see href="/dotnet/csharp/language-reference/attributes/nullable-analysis">Nullable static analysis</see> in the C# guide.</remarks>
<related type="Article" href="/dotnet/csharp/language-reference/attributes/nullable-analysis">Nullable static analysis</related>
</Docs>
<Members>
<Member MemberName=".ctor">
Expand Down
3 changes: 2 additions & 1 deletion xml/System.Diagnostics.CodeAnalysis/NotNullWhenAttribute.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,8 @@
</Attributes>
<Docs>
<summary>Specifies that when a method returns <see cref="P:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.ReturnValue" />, the parameter will not be <see langword="null" /> even if the corresponding type allows it.</summary>
<remarks>To be added.</remarks>
<remarks>For more information, see <see href="/dotnet/csharp/language-reference/attributes/nullable-analysis">Nullable static analysis</see> in the C# guide.</remarks>
<related type="Article" href="/dotnet/csharp/language-reference/attributes/nullable-analysis">Nullable static analysis</related>
</Docs>
<Members>
<Member MemberName=".ctor">
Expand Down