Skip to content

Commit 31f3286

Browse files
carlossanlopRon Petrusha
authored andcommitted
Document explicitly implemented members (System.Printing, Microsoft.VisualBasic.FileIO) (#2809)
* Document explicitly implemented members * suggestion by rpetrusha * Examples removed
1 parent 48e6fe1 commit 31f3286

File tree

3 files changed

+34
-10
lines changed

3 files changed

+34
-10
lines changed

xml/Microsoft.VisualBasic.FileIO/TextFieldParser.xml

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1455,8 +1455,16 @@
14551455
</ReturnValue>
14561456
<Parameters />
14571457
<Docs>
1458-
<summary>To be added.</summary>
1459-
<remarks>To be added.</remarks>
1458+
<summary>Releases resources used by the <see cref="T:Microsoft.VisualBasic.FileIO.TextFieldParser" /> object.</summary>
1459+
<remarks>
1460+
<format type="text/markdown"><![CDATA[
1461+
1462+
## Remarks
1463+
1464+
This member is an explicit interface member implementation. It can be used only when the `TextFieldParser` instance is cast to an <xref:System.IDisposable> interface. The recommended alternative is to call the <xref:Microsoft.VisualBasic.FileIO.TextFieldParser.Dispose%2A> method.
1465+
1466+
]]></format>
1467+
</remarks>
14601468
</Docs>
14611469
</Member>
14621470
<Member MemberName="TextFieldType">
@@ -1580,4 +1588,4 @@
15801588
</Docs>
15811589
</Member>
15821590
</Members>
1583-
</Type>
1591+
</Type>

xml/System.Printing/PrintJobInfoCollection.xml

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -234,9 +234,17 @@
234234
</ReturnValue>
235235
<Parameters />
236236
<Docs>
237-
<summary>To be added.</summary>
238-
<returns>To be added.</returns>
239-
<remarks>To be added.</remarks>
237+
<summary>Gets an object that implements the generic <see cref="T:System.Collections.IEnumerator" /> interface that is closed with <see cref="T:System.Printing.PrintSystemJobInfo" />.</summary>
238+
<returns>An object that implements the generic <see cref="T:System.Collections.IEnumerator" /> interface and that can iterate through the <see cref="T:System.Printing.PrintSystemJobInfo" /> objects that the <see cref="T:System.Printing.PrintJobInfoCollection" /> contains.</returns>
239+
<remarks>
240+
<format type="text/markdown"><![CDATA[
241+
242+
## Remarks
243+
244+
We recommend that you use the `foreach` statement to iterate through all members of the collection. Use <xref:System.Printing.PrintJobInfoCollection.GetEnumerator%2A> only when you need to customize iteration, such as by skipping every other member.
245+
246+
]]></format>
247+
</remarks>
240248
</Docs>
241249
</Member>
242250
</Members>

xml/System.Printing/PrintQueueCollection.xml

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -338,10 +338,18 @@
338338
</ReturnValue>
339339
<Parameters />
340340
<Docs>
341-
<summary>To be added.</summary>
342-
<returns>To be added.</returns>
343-
<remarks>To be added.</remarks>
341+
<summary>Returns an object that implements the generic <see cref="T:System.Collections.IEnumerator" /> interface that has been closed with <see cref="T:System.Printing.PrintQueue" />.</summary>
342+
<returns>An object that implements the generic <see cref="T:System.Collections.IEnumerator" /> and that can iterate through the <see cref="T:System.Printing.PrintQueue" /> objects that the <see cref="T:System.Printing.PrintQueueCollection" /> contains.</returns>
343+
<remarks>
344+
<format type="text/markdown"><![CDATA[
345+
346+
## Remarks
347+
348+
We recommend that you use the `foreach` statement to iterate through all members of the collection. Use <xref:System.Printing.PrintQueueCollection.GetEnumerator%2A> only when you need to customize iteration, such as by skipping every other member.
349+
350+
]]></format>
351+
</remarks>
344352
</Docs>
345353
</Member>
346354
</Members>
347-
</Type>
355+
</Type>

0 commit comments

Comments
 (0)