Skip to content

Fix inheritdoc warnings #10775

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 1 commit into from
Dec 19, 2024
Merged

Fix inheritdoc warnings #10775

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 xml/System.Collections.Generic/OrderedDictionary`2+ValueCollection.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@
<param name="arrayIndex">The zero-based index in <paramref name="array" /> at which copying begins.</param>
<summary>Copies the elements of the <see cref="T:System.Collections.Generic.ICollection`1" /> to an <see cref="T:System.Array" />, starting at a particular <see cref="T:System.Array" /> index.</summary>
<remarks>To be added.</remarks>
<inheritdoc />
<inheritdoc cref="M:System.Collections.Generic.ICollection`1.CopyTo(`0[],System.Int32)" />
</Docs>
</Member>
<Member MemberName="Count">
Expand Down
2 changes: 1 addition & 1 deletion xml/System.CommandLine.Help/TwoColumnHelpRow.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@
<returns>
<see langword="true" /> if the current object is equal to the <paramref name="other" /> parameter; otherwise, <see langword="false" />.</returns>
<remarks>To be added.</remarks>
<inheritdoc />
<inheritdoc cref="M:System.IEquatable`1.Equals(`0)" />
</Docs>
</Member>
<Member MemberName="Equals">
Expand Down
2 changes: 1 addition & 1 deletion xml/System.CommandLine.Parsing/Token.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@
<returns>
<see langword="true" /> if the current object is equal to the <paramref name="other" /> parameter; otherwise, <see langword="false" />.</returns>
<remarks>To be added.</remarks>
<inheritdoc />
<inheritdoc cref="M:System.IEquatable`1.Equals(`0)" />
</Docs>
</Member>
<Member MemberName="Equals">
Expand Down
2 changes: 1 addition & 1 deletion xml/System.CommandLine/ArgumentArity.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@
<returns>
<see langword="true" /> if the current object is equal to the <paramref name="other" /> parameter; otherwise, <see langword="false" />.</returns>
<remarks>To be added.</remarks>
<inheritdoc />
<inheritdoc cref="M:System.IEquatable`1.Equals(`0)" />
</Docs>
</Member>
<Member MemberName="Equals">
Expand Down
4 changes: 1 addition & 3 deletions xml/System.CommandLine/Option.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,7 @@
</Interface>
</Interfaces>
<Docs>
<summary>
A symbol defining a named parameter and a value for that parameter.
</summary>
<summary>Defines a named parameter and a value for that parameter.</summary>
<remarks>To be added.</remarks>
<altmember cref="T:System.CommandLine.IdentifierSymbol" />
</Docs>
Expand Down
18 changes: 8 additions & 10 deletions xml/System.CommandLine/Option`1.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,9 +71,9 @@
<Docs>
<param name="aliases">To be added.</param>
<param name="description">To be added.</param>
<summary>To be added.</summary>
<summary>Initializes a new instance of the <see cref="T:System.CommandLine.Option`1" /> class.</summary>
<remarks>To be added.</remarks>
<inheritdoc />
<inheritdoc cref="M:System.CommandLine.Option.#ctor(System.String[],System.String,System.Type,System.Func{System.Object},System.CommandLine.ArgumentArity)" />
</Docs>
</Member>
<Member MemberName=".ctor">
Expand All @@ -96,9 +96,9 @@
<param name="name">To be added.</param>
<param name="getDefaultValue">To be added.</param>
<param name="description">To be added.</param>
<summary>To be added.</summary>
<summary>Initializes a new instance of the <see cref="T:System.CommandLine.Option`1" /> class.</summary>
<remarks>To be added.</remarks>
<inheritdoc />
<inheritdoc cref="M:System.CommandLine.Option.#ctor(System.String,System.String,System.Type,System.Func{System.Object},System.CommandLine.ArgumentArity)" />
</Docs>
</Member>
<Member MemberName=".ctor">
Expand All @@ -121,9 +121,9 @@
<param name="aliases">To be added.</param>
<param name="getDefaultValue">To be added.</param>
<param name="description">To be added.</param>
<summary>To be added.</summary>
<summary>Initializes a new instance of the <see cref="T:System.CommandLine.Option`1" /> class.</summary>
<remarks>To be added.</remarks>
<inheritdoc />
<inheritdoc cref="M:System.CommandLine.Option.#ctor(System.String[],System.String,System.Type,System.Func{System.Object},System.CommandLine.ArgumentArity)" />
</Docs>
</Member>
<Member MemberName=".ctor">
Expand All @@ -148,9 +148,8 @@
<param name="parseArgument">To be added.</param>
<param name="isDefault">To be added.</param>
<param name="description">To be added.</param>
<summary>To be added.</summary>
<summary>Initializes a new instance of the <see cref="T:System.CommandLine.Option`1" /> class.</summary>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
</Member>
<Member MemberName=".ctor">
Expand All @@ -175,9 +174,8 @@
<param name="parseArgument">To be added.</param>
<param name="isDefault">To be added.</param>
<param name="description">To be added.</param>
<summary>To be added.</summary>
<summary>Initializes a new instance of the <see cref="T:System.CommandLine.Option`1" /> class.</summary>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
</Member>
<Member MemberName="Arity">
Expand Down
4 changes: 2 additions & 2 deletions xml/System.Net.Http.Headers/HttpHeadersNonValidated.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -244,7 +244,7 @@ Multiple header values associated with the same header name are considered to be
<returns>
<see langword="true" /> if the read-only dictionary contains an element that has the specified key; otherwise, <see langword="false" />.</returns>
<remarks>To be added.</remarks>
<inheritdoc />
<inheritdoc cref="M:System.Collections.Generic.IReadOnlyDictionary`2.ContainsKey(`0)" />
</Docs>
</Member>
<Member MemberName="System.Collections.Generic.IReadOnlyDictionary&lt;System.String,System.Net.Http.Headers.HeaderStringValues&gt;.Keys">
Expand Down Expand Up @@ -304,7 +304,7 @@ Multiple header values associated with the same header name are considered to be
<returns>
<see langword="true" /> if the collection contains the specified header; otherwise, <see langword="false" />.</returns>
<remarks>To be added.</remarks>
<inheritdoc />
<inheritdoc cref="M:System.Collections.Generic.IReadOnlyDictionary`2.TryGetValue(`0,`1@)" />
</Docs>
</Member>
<Member MemberName="System.Collections.Generic.IReadOnlyDictionary&lt;System.String,System.Net.Http.Headers.HeaderStringValues&gt;.Values">
Expand Down
8 changes: 4 additions & 4 deletions xml/System.Security.Cryptography.Cose/CoseHeaderMap.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -295,7 +295,7 @@
<returns>
<see langword="true" /> if <paramref name="item" /> is found in the <see cref="T:System.Collections.Generic.ICollection`1" />; otherwise, <see langword="false" />.</returns>
<remarks>To be added.</remarks>
<inheritdoc />
<inheritdoc cref="M:System.Collections.Generic.ICollection`1.Contains(`0)" />
</Docs>
</Member>
<Member MemberName="ContainsKey">
Expand Down Expand Up @@ -326,7 +326,7 @@
<returns>
<see langword="true" /> if the <see cref="T:System.Collections.Generic.IDictionary`2" /> contains an element with the key; otherwise, <see langword="false" />.</returns>
<remarks>To be added.</remarks>
<inheritdoc />
<inheritdoc cref="M:System.Collections.Generic.IDictionary`2.ContainsKey(`0)" />
</Docs>
</Member>
<Member MemberName="CopyTo">
Expand Down Expand Up @@ -363,7 +363,7 @@
<param name="arrayIndex">The zero-based index in <paramref name="array" /> at which copying begins.</param>
<summary>Copies the elements of the <see cref="T:System.Collections.Generic.ICollection`1" /> to an <see cref="T:System.Array" />, starting at a particular <see cref="T:System.Array" /> index.</summary>
<remarks>To be added.</remarks>
<inheritdoc />
<inheritdoc cref="M:System.Collections.Generic.ICollection`1.CopyTo(`0[],System.Int32)" />
</Docs>
</Member>
<Member MemberName="Count">
Expand Down Expand Up @@ -801,7 +801,7 @@ This member is an explicit interface member implementation. It can be used only
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<inheritdoc />
<inheritdoc cref="M:System.Collections.Generic.IDictionary`2.TryGetValue(`0,`1@)" />
</Docs>
</Member>
<Member MemberName="Values">
Expand Down
Loading
Loading