Added documentation for System.Diagnostics.Tracing APIs targeted for 3.0 (dotnet#2972)

jozkee · mairaw · commit ba6d145d5007 · 2019-08-08T19:27:49.000-07:00
* Added documentation for System.Diagnostics.Tracing APIs targeted for 3.0

* Update DiagnosticCounter.xml

* Update EventCounter.xml

* Update IncrementingEventCounter.xml

* Update IncrementingPollingCounter.xml

* Update PollingCounter.xml
diff --git a/xml/System.Diagnostics.Tracing/DiagnosticCounter.xml b/xml/System.Diagnostics.Tracing/DiagnosticCounter.xml
@@ -65,7 +65,7 @@
         <ReturnType>System.String</ReturnType>
       </ReturnValue>
       <Docs>
-        <summary>Gets or sets display name of the counter.</summary>
+        <summary>Gets or sets the display name of the counter.</summary>
         <value>The display name of the counter.</value>
         <remarks>
       <format type="text/markdown"><![CDATA[
@@ -95,8 +95,8 @@ The `DisplayName` provides a more display friendly name for the consumer side of
         <ReturnType>System.String</ReturnType>
       </ReturnValue>
       <Docs>
-        <summary>To be added.</summary>
-        <value>To be added.</value>
+        <summary>Gets or sets the display units of the counter.</summary>
+        <value>The display units of the counter.</value>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>
@@ -173,4 +173,4 @@ After being disposed, this counter will do nothing, and its resources will be re
       </Docs>
     </Member>
   </Members>
-</Type>
+</Type>
diff --git a/xml/System.Diagnostics.Tracing/EventCounter.xml b/xml/System.Diagnostics.Tracing/EventCounter.xml
@@ -132,8 +132,8 @@ For an example of how to use the <xref:System.Diagnostics.Tracing.EventCounter>
       </ReturnValue>
       <Parameters />
       <Docs>
-        <summary>To be added.</summary>
-        <returns>To be added.</returns>
+        <summary>Returns a string representation of the current event counter instance.</summary>
+        <returns>The name, count and mean of the current event counter.</returns>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>
@@ -215,4 +215,4 @@ For an example of how to use the <xref:System.Diagnostics.Tracing.EventCounter>
       </Docs>
     </Member>
   </Members>
-</Type>
+</Type>
diff --git a/xml/System.Diagnostics.Tracing/IncrementingEventCounter.xml b/xml/System.Diagnostics.Tracing/IncrementingEventCounter.xml
@@ -127,10 +127,10 @@ The value of the `DisplayRateTimeScale` property is included as a string in the
       </ReturnValue>
       <Parameters />
       <Docs>
-        <summary>To be added.</summary>
-        <returns>To be added.</returns>
+        <summary>Returns a string representation of the current incrementing event counter instance.</summary>
+        <returns>The name and increment of the current incrementing event counter.</returns>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>
   </Members>
-</Type>
+</Type>
diff --git a/xml/System.Diagnostics.Tracing/IncrementingPollingCounter.xml b/xml/System.Diagnostics.Tracing/IncrementingPollingCounter.xml
@@ -101,10 +101,10 @@ The value of the `DisplayRateTimeScale` property is included as a string in the
       </ReturnValue>
       <Parameters />
       <Docs>
-        <summary>To be added.</summary>
-        <returns>To be added.</returns>
+        <summary>Returns a string representation of the current incrementing polling counter instance.</summary>
+        <returns>The name and increment of the current incrementing polling counter.</returns>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>
   </Members>
-</Type>
+</Type>
diff --git a/xml/System.Diagnostics.Tracing/PollingCounter.xml b/xml/System.Diagnostics.Tracing/PollingCounter.xml
@@ -73,8 +73,8 @@ For an example that uses <xref:System.Diagnostics.Tracing.PollingCounter> inside
       </ReturnValue>
       <Parameters />
       <Docs>
-        <summary>To be added.</summary>
-        <returns>To be added.</returns>
+        <summary>Returns a string representation of the current polling counter instance.</summary>
+        <returns>The name and mean of the current polling counter.</returns>
         <remarks>To be added.</remarks>
       </Docs>
     </Member>
