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

Add missing docs for System.Reflection.PortableExecutable namespace #9390

Merged
merged 1 commit into from
Oct 23, 2023
Merged

Add missing docs for System.Reflection.PortableExecutable namespace #9390

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
75 changes: 49 additions & 26 deletions xml/System.Reflection.PortableExecutable/CorHeader.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,15 @@
</Base>
<Interfaces />
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<summary>Represents the Common Language Infrastructure (CLI) header of the .NET executable image.</summary>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks
The CLI header contains information about .NET metadata in the Portable Executable (PE) file. The CLI header format is defined by the [ECMA-335 specification](https://www.ecma-international.org/publications-and-standards/standards/ecma-335/), section II.25.3.3. You can use the <xref:System.Reflection.PortableExecutable.PEHeaders.CorHeader> property to get the CLI header.

]]></format>
</remarks>
</Docs>
<Members>
<Member MemberName="CodeManagerTableDirectory">
Expand Down Expand Up @@ -54,8 +61,8 @@
<ReturnType>System.Reflection.PortableExecutable.DirectoryEntry</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Gets the Code Manager Table entry.</summary>
<value>The Code Manager Table entry.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -85,8 +92,8 @@
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Gets the metadata token of the entry point method of this image.</summary>
<value>The metadata token of the entry point method.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -116,8 +123,8 @@
<ReturnType>System.Reflection.PortableExecutable.DirectoryEntry</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Gets the Export Address Table Jumps entry.</summary>
<value>The Export Address Table Jumps entry.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -147,8 +154,8 @@
<ReturnType>System.Reflection.PortableExecutable.CorFlags</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Gets the runtime flags for this image.</summary>
<value>A bitwise combination of runtime flags.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -178,8 +185,8 @@
<ReturnType>System.UInt16</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Gets the major part of the runtime version required to load this image.</summary>
<value>The major part of the runtime version</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -209,8 +216,8 @@
<ReturnType>System.Reflection.PortableExecutable.DirectoryEntry</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Gets the Managed Native Header entry.</summary>
<value>The Managed Native Header entry.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -240,9 +247,17 @@
<ReturnType>System.Reflection.PortableExecutable.DirectoryEntry</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<summary>Gets the Metadata entry.</summary>
<value>The Metadata entry.</value>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks

The Metadata directory entry contains CLI metadata of the .NET assembly. The metadata layout is defined by [ECMA-335 specification](https://www.ecma-international.org/publications-and-standards/standards/ecma-335/), section II.24.

]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="MinorRuntimeVersion">
Expand Down Expand Up @@ -271,8 +286,8 @@
<ReturnType>System.UInt16</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Gets the minor part of the runtime version required to load this image.</summary>
<value>The minor part of the runtime version.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -302,8 +317,8 @@
<ReturnType>System.Reflection.PortableExecutable.DirectoryEntry</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Gets the Resources entry.</summary>
<value>The Resources entry.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -333,9 +348,17 @@
<ReturnType>System.Reflection.PortableExecutable.DirectoryEntry</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<summary>Gets the Strong Name Signature entry.</summary>
<value>The Strong Name Signature entry.</value>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks

For more information about the strong name signature, see [Strong-named assemblies](/dotnet/standard/assembly/strong-named).

]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="VtableFixupsDirectory">
Expand Down Expand Up @@ -364,8 +387,8 @@
<ReturnType>System.Reflection.PortableExecutable.DirectoryEntry</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Gets the VTable Fixups entry.</summary>
<value>The VTable Fixups entry.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down
12 changes: 6 additions & 6 deletions xml/System.Reflection.PortableExecutable/DirectoryEntry.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
</Attribute>
</Attributes>
<Docs>
<summary>To be added.</summary>
<summary>Represents a directory entry in the Portable Executable (PE) image.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
Expand Down Expand Up @@ -61,9 +61,9 @@
<Parameter Name="size" Type="System.Int32" Index="1" FrameworkAlternate="netcore-1.0;netcore-1.1;netcore-2.0;netcore-2.1;netcore-2.2;netcore-3.0;netcore-3.1;net-5.0;net-6.0;net-7.0;net-8.0" />
</Parameters>
<Docs>
<param name="relativeVirtualAddress">To be added.</param>
<param name="size">To be added.</param>
<summary>To be added.</summary>
<param name="relativeVirtualAddress">The Relative Virtual Address of the entry.</param>
<param name="size">The size of the entry, in bytes.</param>
<summary>Instantiates a new instance of the <see cref="T:System.Reflection.PortableExecutable.DirectoryEntry" /> structure.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -93,7 +93,7 @@
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Specifies the address of the entry relative to the base address of the image.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -123,7 +123,7 @@
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Specifies the size of the entry, in bytes.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down
2 changes: 1 addition & 1 deletion xml/System.Reflection.PortableExecutable/PEMemoryBlock.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
</Attribute>
</Attributes>
<Docs>
<summary>To be added.</summary>
<summary>Represents a block of memory in the Portable Executable (PE) image.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
Expand Down