Skip to content

Port System.Diagnostics triple slash to docs #7100

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

Merged
merged 2 commits into from
Sep 8, 2021
Merged

Port System.Diagnostics triple slash to docs #7100

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fe80b10
Port System.Diagnostics triple slash to docs
carlossanlop Sep 3, 2021
16509d9
Apply suggestions from code review
carlossanlop Sep 8, 2021
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
6 changes: 3 additions & 3 deletions xml/System.Diagnostics.Metrics/Counter`1.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -149,9 +149,9 @@ This class supports only the following generic parameter types: <xref:System.Byt
</Parameter>
</Parameters>
<Docs>
<param name="delta">To be added.</param>
<param name="tagList">To be added.</param>
<summary>To be added.</summary>
<param name="delta">The measurement value.</param>
<param name="tagList">The tags associated with the measurement.</param>
<summary>Adds the increment value of the measurement.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down
6 changes: 3 additions & 3 deletions xml/System.Diagnostics.Metrics/Histogram`1.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -151,9 +151,9 @@ This class supports only the following generic parameter types: <xref:System.Byt
</Parameter>
</Parameters>
<Docs>
<param name="value">To be added.</param>
<param name="tagList">To be added.</param>
<summary>To be added.</summary>
<param name="value">The measurement value.</param>
<param name="tagList">The tags associated with the measurement.</param>
<summary>Records a measurement value.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down
6 changes: 3 additions & 3 deletions xml/System.Diagnostics.Metrics/Instrument`1.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,9 +141,9 @@ This class supports only the following generic parameter types: <xref:System.Byt
</Parameter>
</Parameters>
<Docs>
<param name="measurement">To be added.</param>
<param name="tagList">To be added.</param>
<summary>To be added.</summary>
<param name="measurement">The measurement value.</param>
<param name="tagList">The tags associated with the measurement.</param>
<summary>Records a measurement by notifying all <see cref="T:System.Diagnostics.Metrics.MeterListener" /> objects that are listening to this instrument.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down
12 changes: 6 additions & 6 deletions xml/System.Diagnostics/CounterSample.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -510,7 +510,7 @@
</Parameters>
<Docs>
<param name="sample">The <see cref="T:System.Diagnostics.CounterSample" /> structure to be compared with this instance.</param>
<param name="other">To be added.</param>
<param name="other">The <see cref="T:System.Diagnostics.CounterSample" /> structure to be compared with this instance.</param>
<summary>Indicates whether the specified <see cref="T:System.Diagnostics.CounterSample" /> structure is equal to the current <see cref="T:System.Diagnostics.CounterSample" /> structure.</summary>
<returns>
<see langword="true" /> if <paramref name="sample" /> is equal to the current instance; otherwise, <see langword="false" />.</returns>
Expand Down Expand Up @@ -559,7 +559,7 @@
</Parameters>
<Docs>
<param name="o">The <see cref="T:System.Diagnostics.CounterSample" /> structure to be compared with the current structure.</param>
<param name="obj">To be added.</param>
<param name="obj">The <see cref="T:System.Diagnostics.CounterSample" /> structure to be compared with the current structure.</param>
<summary>Indicates whether the specified structure is a <see cref="T:System.Diagnostics.CounterSample" /> structure and is identical to the current <see cref="T:System.Diagnostics.CounterSample" /> structure.</summary>
<returns>
<see langword="true" /> if <paramref name="o" /> is a <see cref="T:System.Diagnostics.CounterSample" /> structure and is identical to the current instance; otherwise, <see langword="false" />.</returns>
Expand Down Expand Up @@ -641,9 +641,9 @@
</Parameters>
<Docs>
<param name="a">A <see cref="T:System.Diagnostics.CounterSample" /> structure.</param>
<param name="obj1">To be added.</param>
<param name="obj1">A <see cref="T:System.Diagnostics.CounterSample" /> structure.</param>
<param name="b">Another <see cref="T:System.Diagnostics.CounterSample" /> structure to be compared to the structure specified by the <paramref name="a" /> parameter.</param>
<param name="obj2">To be added.</param>
<param name="obj2">Another <see cref="T:System.Diagnostics.CounterSample" /> structure to be compared to the structure specified by the <paramref name="a" /> parameter.</param>
<summary>Returns a value that indicates whether two <see cref="T:System.Diagnostics.CounterSample" /> structures are equal.</summary>
<returns>
<see langword="true" /> if <paramref name="a" /> and <paramref name="b" /> are equal; otherwise, <see langword="false" />.</returns>
Expand Down Expand Up @@ -694,9 +694,9 @@
</Parameters>
<Docs>
<param name="a">A <see cref="T:System.Diagnostics.CounterSample" /> structure.</param>
<param name="obj1">To be added.</param>
<param name="obj1">A <see cref="T:System.Diagnostics.CounterSample" /> structure.</param>
<param name="b">Another <see cref="T:System.Diagnostics.CounterSample" /> structure to be compared to the structure specified by the <paramref name="a" /> parameter.</param>
<param name="obj2">To be added.</param>
<param name="obj2">Another <see cref="T:System.Diagnostics.CounterSample" /> structure to be compared to the structure specified by the <paramref name="a" /> parameter.</param>
<summary>Returns a value that indicates whether two <see cref="T:System.Diagnostics.CounterSample" /> structures are not equal.</summary>
<returns>
<see langword="true" /> if <paramref name="a" /> and <paramref name="b" /> are not equal; otherwise, <see langword="false" />.</returns>
Expand Down
2 changes: 1 addition & 1 deletion xml/System.Diagnostics/EventLogEntryCollection.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@
</Parameters>
<Docs>
<param name="entries">The one-dimensional array of <see cref="T:System.Diagnostics.EventLogEntry" /> instances that is the destination of the elements copied from the collection. The array must have zero-based indexing.</param>
<param name="eventLogEntries">To be added.</param>
<param name="eventLogEntries">The one-dimensional array of <see cref="T:System.Diagnostics.EventLogEntry" /> instances that is the destination of the elements copied from the collection. The array must have zero-based indexing.</param>
<param name="index">The zero-based index in the array at which copying begins.</param>
<summary>Copies the elements of the <see cref="T:System.Diagnostics.EventLogEntryCollection" /> to an array of <see cref="T:System.Diagnostics.EventLogEntry" /> instances, starting at a particular array index.</summary>
<remarks>
Expand Down
94 changes: 59 additions & 35 deletions xml/System.Diagnostics/TagList.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,18 @@
</Interface>
</Interfaces>
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<summary>Represents a list of tags that can be accessed by index. Provides methods to search, sort, and manipulate lists.</summary>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks

`TagList` can be used in the scenarios that need to optimize for memory allocations. `TagList` avoids allocating any memory when using up to eight tags.
Using more than eight tags will cause allocating memory to store the tags.
Public `static` (`Shared` in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

]]></format>
</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
Expand All @@ -62,8 +72,8 @@
<Parameter Name="tagList" Type="System.ReadOnlySpan&lt;System.Collections.Generic.KeyValuePair&lt;System.String,System.Object&gt;&gt;" />
</Parameters>
<Docs>
<param name="tagList">To be added.</param>
<summary>To be added.</summary>
<param name="tagList">A span of tags to initialize the list with.</param>
<summary>Initializes a new instance of <see cref="T:System.Diagnostics.TagList" /> using the specified <paramref name="tagList" />.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -89,8 +99,8 @@
<Parameter Name="tag" Type="System.Collections.Generic.KeyValuePair&lt;System.String,System.Object&gt;" />
</Parameters>
<Docs>
<param name="tag">To be added.</param>
<summary>To be added.</summary>
<param name="tag">The key-value pair of the tag to add to the list.</param>
<summary>Adds a tag to the list.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -114,9 +124,9 @@
<Parameter Name="value" Type="System.Object" />
</Parameters>
<Docs>
<param name="key">To be added.</param>
<param name="value">To be added.</param>
<summary>To be added.</summary>
<param name="key">The tag key.</param>
<param name="value">The tag value.</param>
<summary>Adds a tag with the specified <paramref name="key" /> and <paramref name="value" /> to the list.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -140,7 +150,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<summary>Removes all elements from the <see cref="T:System.Diagnostics.TagList" />.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -172,9 +182,10 @@
<Parameter Name="item" Type="System.Collections.Generic.KeyValuePair&lt;System.String,System.Object&gt;" />
</Parameters>
<Docs>
<param name="item">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="item">The tag to locate in the <see cref="T:System.Diagnostics.TagList" />.</param>
<summary>Determines whether a tag is in the <see cref="T:System.Diagnostics.TagList" />.</summary>
<returns>
<see langword="true" /> if item is found in the <see cref="T:System.Diagnostics.TagList" />; otherwise, <see langword="false" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -203,9 +214,11 @@
<Parameter Name="tags" Type="System.Span&lt;System.Collections.Generic.KeyValuePair&lt;System.String,System.Object&gt;&gt;" />
</Parameters>
<Docs>
<param name="tags">To be added.</param>
<summary>To be added.</summary>
<param name="tags">The destination <see cref="T:System.Span`1" /> object.</param>
<summary>Copies the contents of this <see cref="T:System.Diagnostics.TagList" /> into a destination <paramref name="tags" /> span.</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentException">
The number of elements in the source <see cref="T:System.Diagnostics.TagList" /> is greater than the number of elements that the destination span.</exception>
</Docs>
</Member>
<Member MemberName="CopyTo">
Expand Down Expand Up @@ -237,10 +250,14 @@
<Parameter Name="arrayIndex" Type="System.Int32" />
</Parameters>
<Docs>
<param name="array">To be added.</param>
<param name="arrayIndex">To be added.</param>
<summary>To be added.</summary>
<param name="array">The one-dimensional Array that is the destination of the elements copied from <see cref="T:System.Diagnostics.TagList" />. The Array must have zero-based indexing.</param>
<param name="arrayIndex">The zero-based index in <paramref name="array" /> at which copying begins.</param>
<summary>Copies the entire <see cref="T:System.Diagnostics.TagList" /> to a compatible one-dimensional array, starting at the specified index of the target array.</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="array" /> is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="arrayIndex " /> is less than 0 or greater than or equal to the <paramref name="array" /> length.</exception>
</Docs>
</Member>
<Member MemberName="Count">
Expand Down Expand Up @@ -269,7 +286,7 @@
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Gets the number of tags contained in the <see cref="T:System.Diagnostics.TagList" />.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
Expand Down Expand Up @@ -300,8 +317,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<summary>Returns an enumerator that iterates through the <see cref="T:System.Diagnostics.TagList" />.</summary>
<returns>An enumerator that iterates through the <see cref="T:System.Diagnostics.TagList" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -333,8 +350,8 @@
<Parameter Name="item" Type="System.Collections.Generic.KeyValuePair&lt;System.String,System.Object&gt;" />
</Parameters>
<Docs>
<param name="item">To be added.</param>
<summary>To be added.</summary>
<param name="item">The tag to locate in the <see cref="T:System.Diagnostics.TagList" />.</param>
<summary>Searches for the specified tag and returns the zero-based index of the first occurrence within the entire <see cref="T:System.Diagnostics.TagList" />.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
Expand Down Expand Up @@ -362,10 +379,12 @@
<Parameter Name="item" Type="System.Collections.Generic.KeyValuePair&lt;System.String,System.Object&gt;" />
</Parameters>
<Docs>
<param name="index">To be added.</param>
<param name="item">To be added.</param>
<summary>To be added.</summary>
<param name="index">The zero-based index at which the item should be inserted.</param>
<param name="item">The tag to insert.</param>
<summary>Inserts an element into the <see cref="T:System.Diagnostics.TagList" /> at the specified index.</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="index" /> is less than 0 or <paramref name="index" /> is greater than <see cref="M:System.Diagnostics.TagList.Count" />.</exception>
</Docs>
</Member>
<Member MemberName="IsReadOnly">
Expand Down Expand Up @@ -393,7 +412,7 @@
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Gets a value indicating whether the <see cref="T:System.Diagnostics.TagList" /> is read-only. This property will always return <see langword="false" />.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
Expand Down Expand Up @@ -427,9 +446,11 @@
</Parameters>
<Docs>
<param name="index">To be added.</param>
<summary>To be added.</summary>
<summary>Gets or sets the tags at the specified index.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="index" /> is not a valid index in the <see cref="T:System.Diagnostics.TagList" />.</exception>
</Docs>
</Member>
<Member MemberName="Remove">
Expand All @@ -454,9 +475,10 @@
<Parameter Name="item" Type="System.Collections.Generic.KeyValuePair&lt;System.String,System.Object&gt;" />
</Parameters>
<Docs>
<param name="item">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="item">The tag to remove from the <see cref="T:System.Diagnostics.TagList" />.</param>
<summary>Removes the first occurrence of a specific object from the <see cref="T:System.Diagnostics.TagList" />.</summary>
<returns>
<see langword="true" /> if <paramref name="item" /> is successfully removed; otherwise, <see langword="false" />. This method also returns <see langword="false" /> if <paramref name="item" /> was not found in the <see cref="T:System.Diagnostics.TagList" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -482,9 +504,11 @@
<Parameter Name="index" Type="System.Int32" />
</Parameters>
<Docs>
<param name="index">To be added.</param>
<summary>To be added.</summary>
<param name="index">The zero-based index of the element to remove.</param>
<summary>Removes the element at the specified index of the <see cref="T:System.Diagnostics.TagList" />.</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="index" /> index is less than 0 or <paramref name="index" /> is greater than <see cref="M:System.Diagnostics.TagList.Count" />.</exception>
</Docs>
</Member>
<Member MemberName="System.Collections.IEnumerable.GetEnumerator">
Expand Down Expand Up @@ -513,8 +537,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<summary>Returns an enumerator that iterates through the <see cref="T:System.Diagnostics.TagList" />.</summary>
<returns>An enumerator that iterates through the <see cref="T:System.Diagnostics.TagList" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down