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

Jump to bottom

Automatically port Reflection.PortableExecutable.PE* APIs #3193

Merged
merged 18 commits into from
Oct 11, 2019
Merged

Automatically port Reflection.PortableExecutable.PE* APIs #3193

Show file tree
Hide file tree
Changes from 8 commits
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
84b805c
Automatically port Reflection.PortableExecutable.PE* APIs
carlossanlop Sep 16, 2019
239c0d0
remove top line
carlossanlop Sep 16, 2019
bec32b5
Update PEMemoryBlock.xml
Sep 25, 2019
7fa6d07
In-place edits.
Sep 26, 2019
573ab80
Edited PEStreamOptions directly
Sep 26, 2019
7421107
Revised property descriptions.
Sep 26, 2019
8d302cb
Add summary and value.
carlossanlop Sep 26, 2019
209ad08
Merge branch 'PE' of https://github.com/carlossanlop/dotnet-api-docs …
carlossanlop Sep 26, 2019
579a6e3
suggestions by rpetrusha
carlossanlop Sep 26, 2019
8151ae4
suggestions by rpetrusha
carlossanlop Sep 26, 2019
9b1ce00
PEReader add missing elements
carlossanlop Sep 26, 2019
e8fb5b1
entry point address
carlossanlop Sep 26, 2019
5d027f0
more changes
carlossanlop Sep 26, 2019
0f07006
Merge branch 'PE' of https://github.com/carlossanlop/dotnet-api-docs …
carlossanlop Sep 26, 2019
a437b90
PEHeaderBuilder changes
carlossanlop Sep 26, 2019
94a9ea4
Fixed para tag
Oct 2, 2019
5f96cc3
Update PEReader.xml
Oct 11, 2019
456af06
Fixed bad crefs
Oct 11, 2019
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
204 changes: 158 additions & 46 deletions xml/System.Reflection.PortableExecutable/PEDirectoriesBuilder.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
</Base>
<Interfaces />
<Docs>
<summary>To be added.</summary>
<summary>Builds PE directories.</summary>
Copy link
Member Author

Choose a reason for hiding this comment

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

@tmat I added this but I don't think it's descriptive enough. Can you please provide a better summary?

<remarks>To be added.</remarks>
</Docs>
<Members>
Expand All @@ -37,7 +37,7 @@
</AssemblyInfo>
<Parameters />
<Docs>
<summary>To be added.</summary>
<summary>Initializes an instance of the <see cref="T:System.Reflection.PortableExecutable.PEDirectoriesBuilder" /> class.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -60,8 +60,8 @@
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>The entry point address.</summary>
carlossanlop marked this conversation as resolved.
Show resolved Hide resolved
<value>An integer representing the entry point address.</value>
carlossanlop marked this conversation as resolved.
Show resolved Hide resolved
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -84,9 +84,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>The base relocation table image directory entry.</summary>
<value>A directory entry instance.</value>
<remarks>
Copy link

Choose a reason for hiding this comment

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

All of the documentation appears in the Remarks section, with nothing in the Summary section. Should they be moved the the summary?

Copy link
Member Author

Choose a reason for hiding this comment

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

Done @rpetrusha. Let me know what you think.
I double checked the descriptions in these two sites:
https://docs.microsoft.com/en-us/windows/win32/api/dbghelp/nf-dbghelp-imagedirectoryentrytodata
https://docs.microsoft.com/en-us/windows/win32/api/dbghelp/nf-dbghelp-imagedirectoryentrytodataex

Copy link
Contributor

Choose a reason for hiding this comment

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

Do you want to add cross references?

<format type="text/markdown"><![CDATA[

## Remarks

Represents `IMAGE_DIRECTORY_ENTRY_BASERELOC`.

]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="BoundImportTable">
Expand All @@ -108,9 +116,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>The bound import image directory entry.</summary>
<value>A directory entry instance.</value>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks

Represents `IMAGE_DIRECTORY_ENTRY_BOUND_IMPORT`.

]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="CopyrightTable">
Expand All @@ -132,9 +148,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>The copyright/architecture image directory entry.</summary>
<value>A directory entry instance.</value>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks

Represents `IMAGE_DIRECTORY_ENTRY_COPYRIGHT` or `IMAGE_DIRECTORY_ENTRY_ARCHITECTURE`.

]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="CorHeaderTable">
Expand All @@ -156,9 +180,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>The COM descriptortable image directory entry.</summary>
<value>A directory entry instance.</value>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks

Represents `IMAGE_DIRECTORY_ENTRY_COM_DESCRIPTOR`.

]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="DebugTable">
Expand All @@ -180,9 +212,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>The debug table image directory entry.</summary>
<value>A directory entry instance.</value>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks

Represents `IMAGE_DIRECTORY_ENTRY_DEBUG`.

]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="DelayImportTable">
Expand All @@ -204,9 +244,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>The delay import table image directory entry.</summary>
<value>A directory entry instance.</value>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks

Represents `IMAGE_DIRECTORY_ENTRY_DELAY_IMPORT`.

]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="ExceptionTable">
Expand All @@ -228,9 +276,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>The exception table image directory entry.</summary>
<value>A directory entry instance.</value>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks

Represents `IMAGE_DIRECTORY_ENTRY_EXCEPTION`.

]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="ExportTable">
Expand All @@ -252,9 +308,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>The export table image directory entry.</summary>
<value>A directory entry instance.</value>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks

Represents `IMAGE_DIRECTORY_ENTRY_EXPORT`.

]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="GlobalPointerTable">
Expand All @@ -276,9 +340,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>The global pointer table image directory entry.</summary>
<value>A directory entry instance.</value>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks

Represents `IMAGE_DIRECTORY_ENTRY_GLOBALPTR`.

]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="ImportAddressTable">
Expand All @@ -300,9 +372,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>The import address table (IAT) image directory entry.</summary>
<value>A directory entry instance.</value>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks

Represents `IMAGE_DIRECTORY_ENTRY_IAT`.

]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="ImportTable">
Expand All @@ -324,9 +404,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>The import table image directory entry.</summary>
<value>A directory entry instance.</value>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks

Represents `IMAGE_DIRECTORY_ENTRY_IMPORT`.

]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="LoadConfigTable">
Expand All @@ -348,9 +436,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>The load configuration table image directory entry.</summary>
<value>A directory entry instance.</value>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks

Represents `IMAGE_DIRECTORY_ENTRY_LOAD_CONFIG`.

]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="ResourceTable">
Expand All @@ -372,9 +468,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>The resource table image directory entry.</summary>
<value>A directory entry instance.</value>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks

Represents `IMAGE_DIRECTORY_ENTRY_RESOURCE`.

]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="ThreadLocalStorageTable">
Expand All @@ -396,9 +500,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>The thread local storage (TLS) table image directory entry.</summary>
<value>A directory entry instance.</value>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks

Represents `IMAGE_DIRECTORY_ENTRY_TLS`.

]]></format>
</remarks>
</Docs>
</Member>
</Members>
Expand Down
Loading