You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Add docs for EventCounter.Dispose() and DiagnosticsListener.IsEnabled (#3235)
* Add docs for EventCounter.Dispose() and DiagnosticsListener.IsEnabled
* Update xml/System.Diagnostics/DiagnosticListener.xml
Co-Authored-By: Carlos Sanchez Lopez <[email protected]>
* spacing + cref to EventSource
* Update xml/System.Diagnostics/DiagnosticListener.xml
Co-Authored-By: Noah Falk <[email protected]>
* Update xml/System.Diagnostics.Tracing/EventCounter.xml
Co-Authored-By: Noah Falk <[email protected]>
* Update xml/System.Diagnostics/DiagnosticListener.xml
Co-Authored-By: Noah Falk <[email protected]>
* address suggestions by carlossanlop
* Point the see cref to the member group without %2A
* suggestion by gewarren (Overload)
Copy file name to clipboardExpand all lines: xml/System.Diagnostics.Tracing/EventCounter.xml
+10-2Lines changed: 10 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -109,8 +109,16 @@ For an example of how to use the <xref:System.Diagnostics.Tracing.EventCounter>
109
109
</ReturnValue>
110
110
<Parameters />
111
111
<Docs>
112
-
<summary>Releases the resources used by the current instance of the <seecref="T:System.Diagnostics.Tracing.EventCounter" /> class.</summary>
113
-
<remarks>To be added.</remarks>
112
+
<summary>Removes the counter from the set that the <seecref="T:System.Diagnostics.Tracing.EventSource" /> will report on.</summary>
113
+
<remarks>
114
+
<formattype="text/markdown"><![CDATA[
115
+
116
+
## Remarks
117
+
118
+
After being disposed, this counter will stop reporting values. If an <xref:System.Diagnostics.Tracing.EventCounter> is not explicitly disposed it will stop reporting automatically when the <xref:System.Diagnostics.Tracing.EventSource> it is attached to is disposed.
<summary>Checks if the DiagnosticListener is enabled.</summary>
216
+
<paramname="name">The name of the event to check.</param>
217
+
<paramname="arg1">The object that represents a context.</param>
218
+
<paramname="arg2">The object that represents a context.</param>
219
+
<summary>Checks if any subscriber to the diagnostic events is interested in receiving events with this name. Subscribers indicate their interest using a delegate provided in <seecref="Overload:System.Diagnostics.DiagnosticListener.Subscribe" />.</summary>
220
220
<returns>
221
221
<seelangword="true" /> if it is enabled, <seelangword="false" /> otherwise.</returns>
222
222
<remarks>To be added.</remarks>
@@ -298,6 +298,18 @@ If setup for the notification is expensive, you can call `IsEnabled()` before pe
0 commit comments