Skip to content
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

Add missing doc to the Metrics APIs and TimeOnly type. #8229

Merged
merged 6 commits into from
Jul 19, 2022
Merged

Add missing doc to the Metrics APIs and TimeOnly type. #8229

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
1d9a410
Add 7.0 Metrics Docs
tarekgh Jul 18, 2022
3d17dcf
Add TimeOnly missing docs
tarekgh Jul 18, 2022
1b49c3d
Update xml/System.Diagnostics.Metrics/Meter.xml
tarekgh Jul 18, 2022
ffec1aa
Address the feedback
tarekgh Jul 18, 2022
3d7372e
Update xml/System/TimeOnly.xml
tarekgh Jul 18, 2022
0d9f9c0
Update xml/System/TimeOnly.xml
tarekgh Jul 18, 2022
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
16 changes: 8 additions & 8 deletions xml/System.Diagnostics.Metrics/Meter.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -465,13 +465,13 @@ Example uses for ObservableCounter: The number of page faults for each process.
<Parameter Name="description" Type="System.String" Index="3" FrameworkAlternate="net-7.0" />
</Parameters>
<Docs>
<typeparam name="T">To be added.</typeparam>
<typeparam name="T">The numerical type of the measurement.</typeparam>
<param name="name">The instrument name. Cannot be <see langword="null" />.</param>
<param name="observeValues">The callback to call to get the measurements when the <see cref="M:System.Diagnostics.Metrics.ObservableInstrument`1.Observe" /> is called by <see cref="M:System.Diagnostics.Metrics.MeterListener.RecordObservableInstruments" />.</param>
<param name="unit">Optional instrument unit of measurements.</param>
<param name="description">Optional instrument description.</param>
<summary>Creates an ObservableUpDownCounter object. ObservableUpDownCounter is an Instrument that reports increasing or decreasing values when the instrument is being observed.</summary>
<returns>To be added.</returns>
<returns>A new observable up down counter.</returns>
<remarks>
<format type="text/markdown"><![CDATA[

Expand Down Expand Up @@ -513,13 +513,13 @@ Example uses for ObservableUpDownCounter: the process heap size or the approxima
<Parameter Name="description" Type="System.String" Index="3" FrameworkAlternate="net-7.0" />
</Parameters>
<Docs>
<typeparam name="T">To be added.</typeparam>
<typeparam name="T">The numerical type of the measurement.</typeparam>
<param name="name">The instrument name. Cannot be <see langword="null" />.</param>
<param name="observeValue">The callback to call to get the measurements when the <see cref="M:System.Diagnostics.Metrics.ObservableInstrument`1.Observe" /> is called by <see cref="M:System.Diagnostics.Metrics.MeterListener.RecordObservableInstruments" /></param>
<param name="unit">Optional instrument unit of measurements.</param>
<param name="description">Optional instrument description.</param>
<summary>Creates an ObservableUpDownCounter object. ObservableUpDownCounter is an Instrument that reports increasing or decreasing values when the instrument is being observed.</summary>
<returns>To be added.</returns>
<returns>A new observable up down counter.</returns>
<remarks>
<format type="text/markdown"><![CDATA[

Expand Down Expand Up @@ -561,13 +561,13 @@ Example uses for ObservableUpDownCounter: the process heap size or the approxima
<Parameter Name="description" Type="System.String" Index="3" FrameworkAlternate="net-7.0" />
</Parameters>
<Docs>
<typeparam name="T">To be added.</typeparam>
<typeparam name="T">The numerical type of the measurement.</typeparam>
<param name="name">The instrument name. Cannot be <see langword="null" />.</param>
<param name="observeValue">The callback to call to get the measurements when the <see cref="M:System.Diagnostics.Metrics.ObservableInstrument`1.Observe" /> is called by <see cref="M:System.Diagnostics.Metrics.MeterListener.RecordObservableInstruments" />.</param>
<param name="unit">Optional instrument unit of measurements.</param>
<param name="description">Optional instrument description.</param>
<summary>Creates an ObservableUpDownCounter object. ObservableUpDownCounter is an Instrument that reports increasing or decreasing values when the instrument is being observed.</summary>
<returns>To be added.</returns>
<returns>A new observable up down counter.</returns>
<remarks>
<format type="text/markdown"><![CDATA[

Expand Down Expand Up @@ -608,12 +608,12 @@ Example uses for ObservableUpDownCounter: the process heap size or the approxima
<Parameter Name="description" Type="System.String" Index="2" FrameworkAlternate="net-7.0" />
</Parameters>
<Docs>
<typeparam name="T">To be added.</typeparam>
<typeparam name="T">The numerical type of the measurement.</typeparam>
<param name="name">The instrument name. Cannot be <see langword="null" />.</param>
<param name="unit">Optional instrument unit of measurements.</param>
<param name="description">Optional instrument description.</param>
<summary>Create a metrics UpDownCounter object.</summary>
<returns>To be added.</returns>
<returns>A new observable up down counter.</returns>
tarekgh marked this conversation as resolved.
Show resolved Hide resolved
<remarks>
<format type="text/markdown"><![CDATA[

Expand Down
2 changes: 1 addition & 1 deletion xml/System.Diagnostics.Metrics/ObservableUpDownCounter`1.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
</Base>
<Interfaces />
<Docs>
<typeparam name="T">To be added.</typeparam>
<typeparam name="T">The type that the counter represents.</typeparam>
<summary>A metrics-observable instrument that reports increasing or decreasing values when the instrument is being observed.
Use this instrument to monitor the process heap size or the approximate number of items in a lock-free circular buffer, for example.
To create an ObservableUpDownCounter object, use the <see cref="Overload:System.Diagnostics.Metrics.Meter.CreateObservableUpDownCounter" /> methods.</summary>
Expand Down
11 changes: 6 additions & 5 deletions xml/System/TimeOnly.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1001,7 +1001,7 @@ If `start` and `end` are equal, this method returns `false`, meaning there is ze
<Parameter Name="provider" Type="System.IFormatProvider" Index="1" FrameworkAlternate="net-7.0" />
</Parameters>
<Docs>
<param name="s">To be added.</param>
<param name="s">A span of characters to parse.</param>
<param name="provider">To be added.</param>
tarekgh marked this conversation as resolved.
Show resolved Hide resolved
<summary>Parses a span of characters into a value.</summary>
<returns>The result of parsing <paramref name="s" />.</returns>
Expand Down Expand Up @@ -1773,7 +1773,7 @@ The accepted standard formats are 'r', 'R', 'o', 'O', 't', and 'T'.
<Parameter Name="result" Type="System.TimeOnly" RefType="out" Index="2" FrameworkAlternate="net-7.0" />
</Parameters>
<Docs>
<param name="s">To be added.</param>
<param name="s">A span of characters to parse.</param>
<param name="provider">To be added.</param>
<param name="result">To be added.</param>
tarekgh marked this conversation as resolved.
Show resolved Hide resolved
<summary>Tries to parses a span of characters into a value.</summary>
Expand Down Expand Up @@ -1810,11 +1810,12 @@ The accepted standard formats are 'r', 'R', 'o', 'O', 't', and 'T'.
<Parameter Name="result" Type="System.TimeOnly" RefType="out" Index="2" FrameworkAlternate="net-7.0" />
</Parameters>
<Docs>
<param name="s">To be added.</param>
<param name="s">A string to parse.</param>
<param name="provider">To be added.</param>
<param name="result">To be added.</param>
tarekgh marked this conversation as resolved.
Show resolved Hide resolved
<summary>To be added.</summary>
<returns>To be added.</returns>
<summary>Tries to parses a string into a value.</summary>
<returns>
<see langword="true" /> if <paramref name="s" /> was parsed successfully; otherwise, <see langword="false" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down