From fe80b10d354e7eeb5ff149cb20a7e7eb05b25fbe Mon Sep 17 00:00:00 2001 From: carlossanlop Date: Fri, 3 Sep 2021 01:18:27 -0700 Subject: [PATCH 1/2] Port System.Diagnostics triple slash to docs --- xml/System.Diagnostics.Metrics/Counter`1.xml | 6 +- .../Histogram`1.xml | 6 +- .../Instrument`1.xml | 6 +- xml/System.Diagnostics/CounterSample.xml | 12 +-- .../EventLogEntryCollection.xml | 2 +- xml/System.Diagnostics/TagList.xml | 95 ++++++++++++------- 6 files changed, 76 insertions(+), 51 deletions(-) diff --git a/xml/System.Diagnostics.Metrics/Counter`1.xml b/xml/System.Diagnostics.Metrics/Counter`1.xml index 371462997b7..308117a7be2 100644 --- a/xml/System.Diagnostics.Metrics/Counter`1.xml +++ b/xml/System.Diagnostics.Metrics/Counter`1.xml @@ -149,9 +149,9 @@ This class supports only the following generic parameter types: - To be added. - To be added. - To be added. + The measurement value. + A of tags associated with the measurement. + Record the increment value of the measurement. To be added. diff --git a/xml/System.Diagnostics.Metrics/Histogram`1.xml b/xml/System.Diagnostics.Metrics/Histogram`1.xml index ca80d8a0f1a..6797727bdf6 100644 --- a/xml/System.Diagnostics.Metrics/Histogram`1.xml +++ b/xml/System.Diagnostics.Metrics/Histogram`1.xml @@ -151,9 +151,9 @@ This class supports only the following generic parameter types: - To be added. - To be added. - To be added. + The measurement value. + A of tags associated with the measurement. + Record a measurement value. To be added. diff --git a/xml/System.Diagnostics.Metrics/Instrument`1.xml b/xml/System.Diagnostics.Metrics/Instrument`1.xml index 29e306af158..7eeaf4a9180 100644 --- a/xml/System.Diagnostics.Metrics/Instrument`1.xml +++ b/xml/System.Diagnostics.Metrics/Instrument`1.xml @@ -141,9 +141,9 @@ This class supports only the following generic parameter types: - To be added. - To be added. - To be added. + The measurement value. + A of tags associated with the measurement. + Record the measurement by notifying all objects which listening to this instrument. To be added. diff --git a/xml/System.Diagnostics/CounterSample.xml b/xml/System.Diagnostics/CounterSample.xml index 1ad0aae3bae..2f5d2203a33 100644 --- a/xml/System.Diagnostics/CounterSample.xml +++ b/xml/System.Diagnostics/CounterSample.xml @@ -510,7 +510,7 @@ The structure to be compared with this instance. - To be added. + The structure to be compared with this instance. Indicates whether the specified structure is equal to the current structure. if is equal to the current instance; otherwise, . @@ -559,7 +559,7 @@ The structure to be compared with the current structure. - To be added. + The structure to be compared with the current structure. Indicates whether the specified structure is a structure and is identical to the current structure. if is a structure and is identical to the current instance; otherwise, . @@ -641,9 +641,9 @@ A structure. - To be added. + A structure. Another structure to be compared to the structure specified by the parameter. - To be added. + Another structure to be compared to the structure specified by the parameter. Returns a value that indicates whether two structures are equal. if and are equal; otherwise, . @@ -694,9 +694,9 @@ A structure. - To be added. + A structure. Another structure to be compared to the structure specified by the parameter. - To be added. + Another structure to be compared to the structure specified by the parameter. Returns a value that indicates whether two structures are not equal. if and are not equal; otherwise, . diff --git a/xml/System.Diagnostics/EventLogEntryCollection.xml b/xml/System.Diagnostics/EventLogEntryCollection.xml index 05a38b21bc0..3ffe2ad0754 100644 --- a/xml/System.Diagnostics/EventLogEntryCollection.xml +++ b/xml/System.Diagnostics/EventLogEntryCollection.xml @@ -92,7 +92,7 @@ The one-dimensional array of instances that is the destination of the elements copied from the collection. The array must have zero-based indexing. - To be added. + The one-dimensional array of instances that is the destination of the elements copied from the collection. The array must have zero-based indexing. The zero-based index in the array at which copying begins. Copies the elements of the to an array of instances, starting at a particular array index. diff --git a/xml/System.Diagnostics/TagList.xml b/xml/System.Diagnostics/TagList.xml index a745b5729bd..84933f64063 100644 --- a/xml/System.Diagnostics/TagList.xml +++ b/xml/System.Diagnostics/TagList.xml @@ -42,8 +42,18 @@ - To be added. - To be added. + Represents a list of tags that can be accessed by index. Provides methods to search, sort, and manipulate lists. + + + @@ -62,8 +72,8 @@ - To be added. - To be added. + A span of tags to initialize the list with. + Initializes a new instance of the TagList structure using the specified . To be added. @@ -89,8 +99,8 @@ - To be added. - To be added. + Key and value pair of the tag to add to the list. + Adds a tag to the list. To be added. @@ -114,9 +124,9 @@ - To be added. - To be added. - To be added. + The tag key. + The tag value. + Adds a tag with the provided and to the list. To be added. @@ -140,7 +150,7 @@ - To be added. + Removes all elements from the . To be added. @@ -172,9 +182,10 @@ - To be added. - To be added. - To be added. + The tag to locate in the . + Determines whether an tag is in the . + + if item is found in the ; otherwise, . To be added. @@ -203,9 +214,12 @@ - To be added. - To be added. + The destination object. + Copies the contents of this into a destination span. + Inserts an element into this at the specified index. To be added. + + The number of elements in the source is greater than the number of elements that the destination span. @@ -237,10 +251,14 @@ - To be added. - To be added. - To be added. + The one-dimensional Array that is the destination of the elements copied from . The Array must have zero-based indexing. + The zero-based index in at which copying begins. + Copies the entire to a compatible one-dimensional array, starting at the specified index of the target array. To be added. + + is . + + is less than 0 or greater that or equal the length. @@ -269,7 +287,7 @@ System.Int32 - To be added. + Gets the number of tags contained in the . To be added. To be added. @@ -300,8 +318,8 @@ - To be added. - To be added. + Returns an enumerator that iterates through the . + Returns an enumerator that iterates through the . To be added. @@ -333,8 +351,8 @@ - To be added. - To be added. + The tag to locate in the . + Searches for the specified tag and returns the zero-based index of the first occurrence within the entire . To be added. To be added. @@ -362,10 +380,12 @@ - To be added. - To be added. - To be added. + The zero-based index at which item should be inserted. + The tag to insert. + Inserts an element into the at the specified index. To be added. + + index is less than 0 or is greater than . @@ -393,7 +413,7 @@ System.Boolean - To be added. + Gets a value indicating whether the is read-only. This property will always return . To be added. To be added. @@ -427,9 +447,11 @@ To be added. - To be added. + Gets or sets the tags at the specified index. To be added. To be added. + + is not a valid index in the . @@ -454,9 +476,10 @@ - To be added. - To be added. - To be added. + The tag to remove from the . + Removes the first occurrence of a specific object from the . + + if item is successfully removed; otherwise, . This method also returns if item was not found in the . To be added. @@ -482,9 +505,11 @@ - To be added. - To be added. + The zero-based index of the element to remove. + Removes the element at the specified index of the . To be added. + + index is less than 0 or is greater than . @@ -513,8 +538,8 @@ - To be added. - To be added. + Returns an enumerator that iterates through the . + Returns an enumerator that iterates through the . To be added. From 16509d91cb6f447a003d90f7308cf41a6ba3d0ef Mon Sep 17 00:00:00 2001 From: Carlos Sanchez <1175054+carlossanlop@users.noreply.github.com> Date: Wed, 8 Sep 2021 12:44:03 -0700 Subject: [PATCH 2/2] Apply suggestions from code review Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com> --- xml/System.Diagnostics.Metrics/Counter`1.xml | 4 +-- .../Histogram`1.xml | 4 +-- .../Instrument`1.xml | 4 +-- xml/System.Diagnostics/TagList.xml | 29 +++++++++---------- 4 files changed, 20 insertions(+), 21 deletions(-) diff --git a/xml/System.Diagnostics.Metrics/Counter`1.xml b/xml/System.Diagnostics.Metrics/Counter`1.xml index 308117a7be2..4e1c809d91f 100644 --- a/xml/System.Diagnostics.Metrics/Counter`1.xml +++ b/xml/System.Diagnostics.Metrics/Counter`1.xml @@ -150,8 +150,8 @@ This class supports only the following generic parameter types: The measurement value. - A of tags associated with the measurement. - Record the increment value of the measurement. + The tags associated with the measurement. + Adds the increment value of the measurement. To be added. diff --git a/xml/System.Diagnostics.Metrics/Histogram`1.xml b/xml/System.Diagnostics.Metrics/Histogram`1.xml index 6797727bdf6..76a3f579713 100644 --- a/xml/System.Diagnostics.Metrics/Histogram`1.xml +++ b/xml/System.Diagnostics.Metrics/Histogram`1.xml @@ -152,8 +152,8 @@ This class supports only the following generic parameter types: The measurement value. - A of tags associated with the measurement. - Record a measurement value. + The tags associated with the measurement. + Records a measurement value. To be added. diff --git a/xml/System.Diagnostics.Metrics/Instrument`1.xml b/xml/System.Diagnostics.Metrics/Instrument`1.xml index 7eeaf4a9180..16a06e8a4b0 100644 --- a/xml/System.Diagnostics.Metrics/Instrument`1.xml +++ b/xml/System.Diagnostics.Metrics/Instrument`1.xml @@ -142,8 +142,8 @@ This class supports only the following generic parameter types: The measurement value. - A of tags associated with the measurement. - Record the measurement by notifying all objects which listening to this instrument. + The tags associated with the measurement. + Records a measurement by notifying all objects that are listening to this instrument. To be added. diff --git a/xml/System.Diagnostics/TagList.xml b/xml/System.Diagnostics/TagList.xml index 84933f64063..db1df0c94c4 100644 --- a/xml/System.Diagnostics/TagList.xml +++ b/xml/System.Diagnostics/TagList.xml @@ -48,9 +48,9 @@ ## Remarks -TagList can be used in the scenarios which need to optimize for memory allocations. TagList will avoid allocating any memory when using up to eight tags. +`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. + Public `static` (`Shared` in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe. ]]> @@ -73,7 +73,7 @@ TagList can be used in the scenarios which need to optimize for memory allocatio A span of tags to initialize the list with. - Initializes a new instance of the TagList structure using the specified . + Initializes a new instance of using the specified . To be added. @@ -99,7 +99,7 @@ TagList can be used in the scenarios which need to optimize for memory allocatio - Key and value pair of the tag to add to the list. + The key-value pair of the tag to add to the list. Adds a tag to the list. To be added. @@ -126,7 +126,7 @@ TagList can be used in the scenarios which need to optimize for memory allocatio The tag key. The tag value. - Adds a tag with the provided and to the list. + Adds a tag with the specified and to the list. To be added. @@ -183,7 +183,7 @@ TagList can be used in the scenarios which need to optimize for memory allocatio The tag to locate in the . - Determines whether an tag is in the . + Determines whether a tag is in the . if item is found in the ; otherwise, . To be added. @@ -215,11 +215,10 @@ TagList can be used in the scenarios which need to optimize for memory allocatio The destination object. - Copies the contents of this into a destination span. - Inserts an element into this at the specified index. + Copies the contents of this into a destination span. To be added. - The number of elements in the source is greater than the number of elements that the destination span. + The number of elements in the source is greater than the number of elements that the destination span. @@ -258,7 +257,7 @@ TagList can be used in the scenarios which need to optimize for memory allocatio is . - is less than 0 or greater that or equal the length. + is less than 0 or greater than or equal to the length. @@ -319,7 +318,7 @@ TagList can be used in the scenarios which need to optimize for memory allocatio Returns an enumerator that iterates through the . - Returns an enumerator that iterates through the . + An enumerator that iterates through the . To be added. @@ -380,12 +379,12 @@ TagList can be used in the scenarios which need to optimize for memory allocatio - The zero-based index at which item should be inserted. + The zero-based index at which the item should be inserted. The tag to insert. Inserts an element into the at the specified index. To be added. - index is less than 0 or is greater than . + is less than 0 or is greater than . @@ -479,7 +478,7 @@ TagList can be used in the scenarios which need to optimize for memory allocatio The tag to remove from the . Removes the first occurrence of a specific object from the . - if item is successfully removed; otherwise, . This method also returns if item was not found in the . + if is successfully removed; otherwise, . This method also returns if was not found in the . To be added. @@ -539,7 +538,7 @@ TagList can be used in the scenarios which need to optimize for memory allocatio Returns an enumerator that iterates through the . - Returns an enumerator that iterates through the . + An enumerator that iterates through the . To be added.