Skip to content

Add missing docs in reflection metadata #8302

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
buyaa-n merged 5 commits into from
Aug 12, 2022
Merged

Add missing docs in reflection metadata #8302

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
7c8323b
Add missing docs
buyaa-n Aug 12, 2022
7c68a63
Update xml/System.Reflection/TypeDelegator.xml
buyaa-n Aug 12, 2022
a76f8ba
Fix invalid references
buyaa-n Aug 12, 2022
8398b5c
Merge conflicts
buyaa-n Aug 12, 2022
8c83c58
Apply suggestions from code review
buyaa-n Aug 12, 2022
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
18 changes: 9 additions & 9 deletions xml/System.Reflection.Metadata.Ecma335/FieldTypeEncoder.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
</Attribute>
</Attributes>
<Docs>
<summary>To be added.</summary>
<summary>Provides encoder for field signature blob, with additional support for encoding ref fields, custom modifiers and typed references.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
Expand All @@ -40,8 +40,8 @@
<Parameter Name="builder" Type="System.Reflection.Metadata.BlobBuilder" />
</Parameters>
<Docs>
<param name="builder">To be added.</param>
<summary>To be added.</summary>
<param name="builder">Builder to write encoded field signature to.</param>
<summary>Initializes a new instance of the <see cref="T:System.Reflection.Metadata.Ecma335.FieldTypeEncoder" /> struct.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -61,7 +61,7 @@
<ReturnType>System.Reflection.Metadata.BlobBuilder</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Underlying builder where encoded field signature is written to.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
Expand All @@ -83,7 +83,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<summary>Get <see cref="M:System.Reflection.Metadata.Ecma335.FieldTypeEncoder.CustomModifiers" /> to specify custom modifiers to the field signature.</summary>
<returns>To be added.</returns>
Copy link
Member

@ericstj ericstj Sep 23, 2022

Choose a reason for hiding this comment

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

Looks like this is being flagged as needed by dotnet/runtime#76049.

Copy link
Contributor Author

@buyaa-n buyaa-n Sep 23, 2022

Choose a reason for hiding this comment

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

Right, return value missing

<remarks>To be added.</remarks>
</Docs>
Expand All @@ -106,9 +106,9 @@
<Parameter Name="isByRef" Type="System.Boolean" />
</Parameters>
<Docs>
<param name="isByRef">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="isByRef">Determines if the field is ByRef</param>
<summary>Encodes the field type signature.</summary>
<returns>Encoder of the field type.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -129,7 +129,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<summary>Write <see cref="F:System.Reflection.Metadata.SignatureTypeCode.TypedReference"/>.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down
20 changes: 16 additions & 4 deletions xml/System.Reflection/TypeDelegator.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1260,10 +1260,22 @@
<Parameter Name="member" Type="System.Reflection.MemberInfo" Index="0" FrameworkAlternate="net-7.0" />
</Parameters>
<Docs>
<param name="member">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="member">The <see cref="T:System.Reflection.MemberInfo" /> to find on the current <see cref="T:System.Type" />.</param>
<summary>Searches for the <see cref="T:System.Reflection.MemberInfo" /> on the current <see cref="T:System.Type" /> that matches the specified <see cref="T:System.Reflection.MemberInfo" />.</summary>
<returns>An object representing the member on the current <see cref="T:System.Type" /> that matches the specified member.</returns>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks

This method can be used to find a constructed generic member given a member from a generic type definition.

]]></format>
</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="member" /> is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentException">
<paramref name="member" /> does not match a member on the current <see cref="T:System.Type" />.</exception>
</Docs>
</Member>
<Member MemberName="GetMethodImpl">
Expand Down