Skip to content

Commit 6c1d2ad

Browse files
buyaa-ngewarren
buyaa-n
and
gewarren
authored
Add missing docs for System.Reflection.Metadata (#9223)
* Add missing docs for System.Reflection.Metadata * Apply suggestions from code review Co-authored-by: Genevieve Warren <[email protected]> * Update xml/System.Reflection.Metadata.Ecma335/InstructionEncoder.xml --------- Co-authored-by: Genevieve Warren <[email protected]>
1 parent ed9c008 commit 6c1d2ad

File tree

3 files changed

+33
-29
lines changed

3 files changed

+33
-29
lines changed

‎xml/System.Reflection.Metadata.Ecma335/InstructionEncoder.xml‎

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -895,10 +895,14 @@ A single label may be marked multiple times, the last offset wins.
895895
<Parameter Name="branchCount" Type="System.Int32" Index="0" FrameworkAlternate="net-8.0" />
896896
</Parameters>
897897
<Docs>
898-
<param name="branchCount">To be added.</param>
899-
<summary>To be added.</summary>
900-
<returns>To be added.</returns>
901-
<remarks>To be added.</remarks>
898+
<param name="branchCount">The number of branches the instruction will have.</param>
899+
<summary>Starts encoding a switch instruction.</summary>
900+
<returns>A <see cref="T:System.Reflection.Metadata.Ecma335.SwitchInstructionEncoder" /> that will be used to emit the labels for the branches.</returns>
901+
<remarks>Before using this <see cref="T:System.Reflection.Metadata.Ecma335.InstructionEncoder" /> in any other way, the method <see cref="M:System.Reflection.Metadata.Ecma335.SwitchInstructionEncoder.Branch(System.Reflection.Metadata.Ecma335.LabelHandle)" /> must be called on the returned value exactly <paramref name="branchCount" /> times. Failure to do so will throw <see cref="T:System.InvalidOperationException" />.</remarks>
902+
<exception cref="T:System.ArgumentOutOfRangeException">
903+
<paramref name="branchCount" /> is less than or equal to zero.</exception>
904+
<exception cref="T:System.InvalidOperationException">
905+
<see cref="M:System.Reflection.Metadata.Ecma335.SwitchInstructionEncoder.Branch(System.Reflection.Metadata.Ecma335.LabelHandle)" /> was not called on the returned value exactly <paramref name="branchCount" /> times.</exception>
902906
</Docs>
903907
</Member>
904908
<Member MemberName="Token">

‎xml/System.Reflection.Metadata.Ecma335/SignatureTypeEncoder.xml‎

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@
3737
</Attribute>
3838
</Attributes>
3939
<Docs>
40-
<summary>To be added.</summary>
40+
<summary>Encodes a type in a signature.</summary>
4141
<remarks>To be added.</remarks>
4242
</Docs>
4343
<Members>
@@ -65,8 +65,8 @@
6565
<Parameter Name="builder" Type="System.Reflection.Metadata.BlobBuilder" />
6666
</Parameters>
6767
<Docs>
68-
<param name="builder">To be added.</param>
69-
<summary>To be added.</summary>
68+
<param name="builder">The <see cref="T:System.Reflection.Metadata.BlobBuilder" /> where the signature will be written.</param>
69+
<summary>Creates a <see cref="T:System.Reflection.Metadata.Ecma335.SignatureTypeEncoder" />.</summary>
7070
<remarks>To be added.</remarks>
7171
</Docs>
7272
</Member>
@@ -165,7 +165,7 @@
165165
</ReturnValue>
166166
<Parameters />
167167
<Docs>
168-
<summary>To be added.</summary>
168+
<summary>Encodes <see cref="T:System.Boolean" />.</summary>
169169
<remarks>To be added.</remarks>
170170
</Docs>
171171
</Member>
@@ -193,7 +193,7 @@
193193
<ReturnType>System.Reflection.Metadata.BlobBuilder</ReturnType>
194194
</ReturnValue>
195195
<Docs>
196-
<summary>To be added.</summary>
196+
<summary>The <see cref="T:System.Reflection.Metadata.BlobBuilder" /> where the signature is written to.</summary>
197197
<value>To be added.</value>
198198
<remarks>To be added.</remarks>
199199
</Docs>
@@ -223,7 +223,7 @@
223223
</ReturnValue>
224224
<Parameters />
225225
<Docs>
226-
<summary>To be added.</summary>
226+
<summary>Encodes <see cref="T:System.Byte" />.</summary>
227227
<remarks>To be added.</remarks>
228228
</Docs>
229229
</Member>
@@ -252,7 +252,7 @@
252252
</ReturnValue>
253253
<Parameters />
254254
<Docs>
255-
<summary>To be added.</summary>
255+
<summary>Encodes <see cref="T:System.Char" />.</summary>
256256
<remarks>To be added.</remarks>
257257
</Docs>
258258
</Member>
@@ -311,7 +311,7 @@
311311
</ReturnValue>
312312
<Parameters />
313313
<Docs>
314-
<summary>To be added.</summary>
314+
<summary>Encodes <see cref="T:System.Double" />.</summary>
315315
<remarks>To be added.</remarks>
316316
</Docs>
317317
</Member>
@@ -491,7 +491,7 @@
491491
</ReturnValue>
492492
<Parameters />
493493
<Docs>
494-
<summary>To be added.</summary>
494+
<summary>Encodes <see cref="T:System.Int16" />.</summary>
495495
<remarks>To be added.</remarks>
496496
</Docs>
497497
</Member>
@@ -520,7 +520,7 @@
520520
</ReturnValue>
521521
<Parameters />
522522
<Docs>
523-
<summary>To be added.</summary>
523+
<summary>Encodes <see cref="T:System.Int32" />.</summary>
524524
<remarks>To be added.</remarks>
525525
</Docs>
526526
</Member>
@@ -549,7 +549,7 @@
549549
</ReturnValue>
550550
<Parameters />
551551
<Docs>
552-
<summary>To be added.</summary>
552+
<summary>Encodes <see cref="T:System.Int64" />.</summary>
553553
<remarks>To be added.</remarks>
554554
</Docs>
555555
</Member>
@@ -578,7 +578,7 @@
578578
</ReturnValue>
579579
<Parameters />
580580
<Docs>
581-
<summary>To be added.</summary>
581+
<summary>Encodes <see cref="T:System.IntPtr" />.</summary>
582582
<remarks>To be added.</remarks>
583583
</Docs>
584584
</Member>
@@ -607,7 +607,7 @@
607607
</ReturnValue>
608608
<Parameters />
609609
<Docs>
610-
<summary>To be added.</summary>
610+
<summary>Encodes <see cref="T:System.Object" />.</summary>
611611
<remarks>To be added.</remarks>
612612
</Docs>
613613
</Member>
@@ -700,7 +700,7 @@
700700
</ReturnValue>
701701
<Parameters />
702702
<Docs>
703-
<summary>To be added.</summary>
703+
<summary>Encodes <see cref="T:System.SByte" />.</summary>
704704
<remarks>To be added.</remarks>
705705
</Docs>
706706
</Member>
@@ -729,7 +729,7 @@
729729
</ReturnValue>
730730
<Parameters />
731731
<Docs>
732-
<summary>To be added.</summary>
732+
<summary>Encodes <see cref="T:System.Single" />.</summary>
733733
<remarks>To be added.</remarks>
734734
</Docs>
735735
</Member>
@@ -758,7 +758,7 @@
758758
</ReturnValue>
759759
<Parameters />
760760
<Docs>
761-
<summary>To be added.</summary>
761+
<summary>Encodes <see cref="T:System.String" />.</summary>
762762
<remarks>To be added.</remarks>
763763
</Docs>
764764
</Member>
@@ -847,7 +847,7 @@
847847
</ReturnValue>
848848
<Parameters />
849849
<Docs>
850-
<summary>To be added.</summary>
850+
<summary>Encodes <see cref="T:System.TypedReference" />.</summary>
851851
<remarks>To be added.</remarks>
852852
</Docs>
853853
</Member>
@@ -876,7 +876,7 @@
876876
</ReturnValue>
877877
<Parameters />
878878
<Docs>
879-
<summary>To be added.</summary>
879+
<summary>Encodes <see cref="T:System.UInt16" />.</summary>
880880
<remarks>To be added.</remarks>
881881
</Docs>
882882
</Member>
@@ -905,7 +905,7 @@
905905
</ReturnValue>
906906
<Parameters />
907907
<Docs>
908-
<summary>To be added.</summary>
908+
<summary>Encodes <see cref="T:System.UInt32" />.</summary>
909909
<remarks>To be added.</remarks>
910910
</Docs>
911911
</Member>
@@ -934,7 +934,7 @@
934934
</ReturnValue>
935935
<Parameters />
936936
<Docs>
937-
<summary>To be added.</summary>
937+
<summary>Encodes <see cref="T:System.UInt64" />.</summary>
938938
<remarks>To be added.</remarks>
939939
</Docs>
940940
</Member>
@@ -963,7 +963,7 @@
963963
</ReturnValue>
964964
<Parameters />
965965
<Docs>
966-
<summary>To be added.</summary>
966+
<summary>Encodes <see cref="T:System.UIntPtr" />.</summary>
967967
<remarks>To be added.</remarks>
968968
</Docs>
969969
</Member>

‎xml/System.Reflection.Metadata.Ecma335/SwitchInstructionEncoder.xml‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,8 @@
2020
</Attribute>
2121
</Attributes>
2222
<Docs>
23-
<summary>To be added.</summary>
24-
<remarks>To be added.</remarks>
23+
<summary>Encodes the branches of an IL <c>switch</c> instruction.</summary>
24+
<remarks>See <see cref="M:System.Reflection.Metadata.Ecma335.InstructionEncoder.Switch(System.Int32)" /> for usage guidelines.</remarks>
2525
</Docs>
2626
<Members>
2727
<Member MemberName="Branch">
@@ -44,8 +44,8 @@
4444
</Parameters>
4545
<Docs>
4646
<param name="label">To be added.</param>
47-
<summary>To be added.</summary>
48-
<remarks>To be added.</remarks>
47+
<summary>Encodes a branch that is part of a switch instruction.</summary>
48+
<remarks>See <see cref="M:System.Reflection.Metadata.Ecma335.InstructionEncoder.Switch(System.Int32)" /> for usage guidelines.</remarks>
4949
</Docs>
5050
</Member>
5151
</Members>

0 commit comments

Comments
 (0)