Skip to content

Commit 86ba8bc

Browse files
committed
Update reflection metadata doc
1 parent a4d95ef commit 86ba8bc

File tree

4 files changed

+44
-10
lines changed

4 files changed

+44
-10
lines changed

xml/System.Reflection.Metadata.Ecma335/MetadataBuilder.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
</Base>
2222
<Interfaces />
2323
<Docs>
24-
<summary>The MetadataBuilder class reads and writes metadata for an assembly in a highly performant manner. It is designed for use by compilers and other assembly generation tools.</summary>
24+
<summary>The MetadataBuilder class writes metadata for an assembly in a highly performant manner. It is designed for use by compilers and other assembly generation tools.</summary>
2525
<remarks>
2626
<format type="text/markdown"><![CDATA[
2727
Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,17 @@
11
<Namespace Name="System.Reflection.Metadata.Ecma335">
22
<Docs>
3-
<summary>To be added.</summary>
4-
<remarks>To be added.</remarks>
5-
</Docs>
3+
<summary>Provides low-level functionality for writing assembly metadata according to ECMA-335.</summary>
4+
<remarks>
5+
<format type="text/markdown"><![CDATA[
6+
7+
## Remarks
8+
This namespace contains the following core classes:
9+
10+
- The <xref:System.Reflection.Metadata.Ecma335.MetadataBuilder> class, which is used to define an assembly.
11+
12+
]]></format>
13+
</remarks>
14+
<altmember cref="N:System.Reflection.Metadata" />
15+
<altmember cref="N:System.Reflection.PortableExecutable" />
16+
</Docs>
617
</Namespace>
Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,17 @@
11
<Namespace Name="System.Reflection.Metadata">
22
<Docs>
3-
<summary>Contains types that represent metadata information about assemblies, modules, members, parameters, and other entities in managed code.</summary>
4-
<remarks></remarks>
5-
</Docs>
3+
<summary>Provides low-level functionality for reading assembly metadata according to ECMA-335. It is designed for use by compilers and other tools that need to read assembly metadata.</summary>
4+
<remarks>
5+
<format type="text/markdown"><![CDATA[
6+
7+
## Remarks
8+
This namespace contains the following core classes:
9+
10+
- The <xref:System.Reflection.Metadata.MetadataReader> class, which is used to read an assembly.
11+
12+
]]></format>
13+
</remarks>
14+
<altmember cref="N:System.Reflection.Metadata.Ecma335" />
15+
<altmember cref="N:System.Reflection.PortableExecutable" />
16+
</Docs>
617
</Namespace>
Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,18 @@
11
<Namespace Name="System.Reflection.PortableExecutable">
22
<Docs>
3-
<summary>To be added.</summary>
4-
<remarks>To be added.</remarks>
5-
</Docs>
3+
<summary>Provides classes related to reading or writing Portable Executable (PE) files.</summary>
4+
<remarks>
5+
<format type="text/markdown"><![CDATA[
6+
7+
## Remarks
8+
This namespace contains the following core classes:
9+
10+
- The <xref:System.Reflection.PortableExecutable.ManagedPEBuilder> class, which is used to write an assembly as a PE file.
11+
- The <xref:System.Reflection.PortableExecutable.PEReader> class, which is used to read a PE file and to obtain a <xref:System.Reflection.Metadata.MetadataReader> to read associated assembly metadata.
12+
13+
]]></format>
14+
</remarks>
15+
<altmember cref="N:System.Reflection.Metadata" />
16+
<altmember cref="N:System.Reflection.Metadata.Ecma335" />
17+
</Docs>
618
</Namespace>

0 commit comments

Comments
 (0)