Skip to content

Updating the documentation for System.Runtime #10361

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 5, 2024
Merged

Updating the documentation for System.Runtime #10361

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
6dc8349
Updating the documentation for System.Runtime
tannergooding Sep 4, 2024
cfc4d2e
Apply suggestions from code review
tannergooding Sep 4, 2024
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
12 changes: 7 additions & 5 deletions xml/System/Environment+ProcessCpuUsage.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,10 @@
</Attribute>
</Attributes>
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<summary>Represents the CPU usage statistics of a process.</summary>
<remarks>
<para>The CPU usage statistics include information about the time spent by the process in the application code (user mode) and the operating system code (kernel mode), as well as the total time spent by the process in both user mode and kernel mode.</para>
</remarks>
</Docs>
<Members>
<Member MemberName="PrivilegedTime">
Expand All @@ -48,7 +50,7 @@
<ReturnType>System.TimeSpan</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Gets the amount of time the process has spent running code inside the operating system code.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
Expand All @@ -69,7 +71,7 @@
<ReturnType>System.TimeSpan</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Gets the amount of time the process has spent utilizing the CPU, including the process time spent in the application code and in the operating system code.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
Expand All @@ -90,7 +92,7 @@
<ReturnType>System.TimeSpan</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Gets the amount of time the associated process has spent running code inside the application portion of the process (not the operating system code).</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
Expand Down
4 changes: 3 additions & 1 deletion xml/System/Environment.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -202,7 +202,9 @@
<ReturnType>System.Environment+ProcessCpuUsage</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>
<para>Get the CPU usage, including the process time spent running the application code, the process time spent running the operating system code, and the total time spent running both the application and operating system code.</para>
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
Expand Down
39 changes: 26 additions & 13 deletions xml/System/Guid.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -603,8 +603,8 @@
<ReturnType>System.Guid</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Gets a <see cref="T:System.Guid" /> where all bits are set.</summary>
<value>A GUID with a value of FFFFFFFF-FFFF-FFFF-FFFF-FFFFFFFFFFFF.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -846,9 +846,12 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<summary>Creates a new <see cref="T:System.Guid" /> according to RFC 9562, following the Version 7 format.</summary>
<returns>A new <see cref="T:System.Guid" /> according to RFC 9562, following the Version 7 format.</returns>
<remarks>
<para>This method uses <see cref="P:System.DateTimeOffset.UtcNow" /> to determine the Unix Epoch timestamp source.</para>
<para>This method seeds the rand_a and rand_b sub-fields with random data.</para>
</remarks>
</Docs>
</Member>
<Member MemberName="CreateVersion7">
Expand Down Expand Up @@ -876,10 +879,14 @@
<Parameter Name="timestamp" Type="System.DateTimeOffset" Index="0" FrameworkAlternate="net-9.0" />
</Parameters>
<Docs>
<param name="timestamp">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="timestamp">The date-time offset used to determine the Unix Epoch timestamp.</param>
<summary>Creates a new <see cref="T:System.Guid" /> according to RFC 9562, following the Version 7 format.</summary>
<returns>A new <see cref="T:System.Guid" /> according to RFC 9562, following the Version 7 format.</returns>
<remarks>
<para>This method seeds the rand_a and rand_b sub-fields with random data.</para>
</remarks>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="timestamp" /> represents an offset prior to <see cref="F:System.DateTimeOffset.UnixEpoch" />.</exception>
</Docs>
</Member>
<Member MemberName="Empty">
Expand Down Expand Up @@ -3011,9 +3018,12 @@ Because the `provider` parameter is ignored, you cannot use it to provide a cust
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Gets the value of the variant field for the <see cref="T:System.Guid" />.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<remarks>
<para>This property corresponds to the most significant 4 bits of the 8th byte: 00000000-0000-0000-F000-000000000000. The "don't-care" bits are not masked out.</para>
<para>For more information on how to interpret this value, see <see href="https://www.rfc-editor.org/rfc/rfc9562.html">RFC 9562</see>.</para>
</remarks>
</Docs>
</Member>
<Member MemberName="Version">
Expand All @@ -3038,9 +3048,12 @@ Because the `provider` parameter is ignored, you cannot use it to provide a cust
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Gets the value of the version field for the <see cref="T:System.Guid" />.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<remarks>
<para>This property corresponds to the most significant 4 bits of the 6th byte: 00000000-0000-F000-0000-000000000000.</para>
<para>For more information on how to interpret this value, see <see href="https://www.rfc-editor.org/rfc/rfc9562.html">RFC 9562</see>.</para>
</remarks>
</Docs>
</Member>
</Members>
Expand Down
15 changes: 8 additions & 7 deletions xml/System/MemoryExtensions+SpanSplitEnumerator`1.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@
</Attributes>
<Docs>
<typeparam name="T">To be added.</typeparam>
<summary>To be added.</summary>
<summary>Enables enumerating each split within a <see cref="T:System.ReadOnlySpan`1" /> that has been divided using one or more separators.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
Expand All @@ -61,8 +61,8 @@
<ReturnType>System.Range</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Gets the current element of the enumeration.</summary>
<value>A <see cref="T:System.Range" /> instance that indicates the bounds of the current element withing the source span.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -89,8 +89,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<summary>Gets an enumerator that allows for iteration over the split span.</summary>
<returns>A <see cref="T:System.MemoryExtensions.SpanSplitEnumerator`1" /> that can be used to iterate over the split span.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -111,8 +111,9 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<summary>Advances the enumerator to the next element of the enumeration.</summary>
<returns>
<see langword="true" /> if the enumerator was successfully advanced to the next element; <see langword="false" /> if the enumerator has passed the end of the enumeration.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down
57 changes: 35 additions & 22 deletions xml/System/MemoryExtensions.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9333,11 +9333,13 @@ Invalid sequences will be represented in the enumeration by <xref:System.Text.Ru
</Parameter>
</Parameters>
<Docs>
<typeparam name="T">To be added.</typeparam>
<param name="source">To be added.</param>
<param name="separator">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<typeparam name="T">The type of the elements.</typeparam>
<param name="source">The source span to be enumerated.</param>
<param name="separator">The separator span to be used to split the provided span.</param>
<summary>
<para>Returns a type that allows for enumeration of each element within a split span using the provided separator span.</para>
</summary>
<returns>An enumerator that can be used to enumerate each element in a split span using the provided separator span.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -9396,11 +9398,13 @@ Invalid sequences will be represented in the enumeration by <xref:System.Text.Ru
<Parameter Name="separator" Type="T" Index="1" FrameworkAlternate="net-9.0" />
</Parameters>
<Docs>
<typeparam name="T">To be added.</typeparam>
<param name="source">To be added.</param>
<param name="separator">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<typeparam name="T">The type of the elements.</typeparam>
<param name="source">The source span to be enumerated.</param>
<param name="separator">The separator character to be used to split the provided span.</param>
<summary>
<para>Returns a type that allows for enumeration of each element within a split span using the provided separator character.</para>
</summary>
<returns>An enumerator that can be used to enumerate each element in a split span using the provided separator character.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -9552,12 +9556,17 @@ Invalid sequences will be represented in the enumeration by <xref:System.Text.Ru
<Parameter Name="separators" Type="System.Buffers.SearchValues&lt;T&gt;" Index="1" FrameworkAlternate="net-9.0" />
</Parameters>
<Docs>
<typeparam name="T">To be added.</typeparam>
<param name="source">To be added.</param>
<param name="separators">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<typeparam name="T">The type of the elements.</typeparam>
<param name="source">The source span to be enumerated.</param>
<param name="separators">The <see cref="T:System.Buffers.SearchValues`1" /> to be used to split the provided span.</param>
<summary>
<para>Returns a type that allows for enumeration of each element within a split span using the provided separator characters.</para>
</summary>
<returns>An enumerator that can be used to enumerate each element in a split span using the provided separator characters.</returns>
<remarks>
<para>Unlike <see cref="M:System.MemoryExtensions.SplitAny``1(System.ReadOnlySpan{``0},System.ReadOnlySpan{``0})" />, <paramref name="separators" /> is not checked for being empty.</para>
<para>An empty <paramref name="separators" /> argument will result in no separators being found, regardless of the type of <typeparamref name="T" />, whereas <see cref="M:System.MemoryExtensions.SplitAny``1(System.ReadOnlySpan{``0},System.ReadOnlySpan{``0})" /> uses all Unicode whitespace characters as separators if <paramref name="separators" /> is empty and <typeparamref name="T" /> is <see cref="T:System.Char" />.</para>
</remarks>
</Docs>
</Member>
<Member MemberName="SplitAny&lt;T&gt;">
Expand Down Expand Up @@ -9618,12 +9627,16 @@ Invalid sequences will be represented in the enumeration by <xref:System.Text.Ru
</Parameter>
</Parameters>
<Docs>
<typeparam name="T">To be added.</typeparam>
<param name="source">To be added.</param>
<param name="separators">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<typeparam name="T">The type of the elements.</typeparam>
<param name="source">The source span to be enumerated.</param>
<param name="separators">The separators to be used to split the provided span.</param>
<summary>
<para>Returns a type that allows for enumeration of each element within a split span using any of the provided elements.</para>
</summary>
<returns>An enumerator that can be used to enumerate each element in a split span using the provided separator characters.</returns>
<remarks>
<para>If <typeparamref name="T" /> is <see cref="T:System.Char" /> and if <paramref name="separators" /> is empty, all Unicode whitespace characters are used as the separators. This matches the behavior of when <see cref="M:System.String.Split(System.Char[])" /> and related overloads are used with an empty separator array, or when <see cref="M:System.MemoryExtensions.SplitAny(System.ReadOnlySpan{System.Char},System.Span{System.Range},System.ReadOnlySpan{System.Char},System.StringSplitOptions)" /> is used with an empty separator span.</para>
</remarks>
</Docs>
</Member>
<Member MemberName="StartsWith">
Expand Down
Loading