Skip to content

Document System.TimeSpan #3637

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 3 commits into from
Dec 7, 2019
Merged

Document System.TimeSpan #3637

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
110edc3
Document System.TimeSpan.op_Multiply
carlossanlop Dec 6, 2019
57a883e
Additional undocumented APIs
carlossanlop Dec 6, 2019
ae90416
suggestion by Thraka
carlossanlop Dec 7, 2019
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
68 changes: 50 additions & 18 deletions xml/System/TimeSpan.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2535,8 +2535,8 @@
<Docs>
<param name="factor">The value to be multiplied by.</param>
<param name="timeSpan">The value to be multiplied.</param>
<summary>Returns a new <see cref="T:System.TimeSpan" /> object which value is the result of multiplication of <paramref name="timeSpan" /> instance and the specified <paramref name="factor" />.</summary>
<returns>A new object that represents the value of <paramref name="timeSpan" /> instance multiplied by the value of <paramref name="factor" />.</returns>
<summary>Returns a new <see cref="T:System.TimeSpan" /> object whose value is the result of multiplying the specified <paramref name="factor" /> and the specified <paramref name="timeSpan" /> instance.</summary>
<returns>A new object that represents the value of the specified <paramref name="factor" /> multiplied by the value of the specified <paramref name="timeSpan" /> instance.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -2567,10 +2567,10 @@
<Parameter Name="factor" Type="System.Double" Index="1" FrameworkAlternate="netcore-2.0;netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
</Parameters>
<Docs>
<param name="timeSpan">To be added.</param>
<param name="factor">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="timeSpan">The value to be multiplied.</param>
<param name="factor">The value to be multiplied by.</param>
<summary>Returns a new <see cref="T:System.TimeSpan" /> object whose value is the result of multiplying the specified <paramref name="timeSpan" /> instance and the specified <paramref name="factor" />.</summary>
<returns>A new object that represents the value of the specified <paramref name="timeSpan" /> instance multiplied by the value of the specified <paramref name="factor" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -3590,9 +3590,41 @@ When a time interval component in the string to be parsed contains more than sev
</Parameters>
<Docs>
<param name="value">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<summary>Compares this instance to a specified object and returns an integer that indicates whether this instance is shorter than, equal to, or longer than the specified object.</summary>
<returns>
One of the following values:
<list type="table">
<listheader>
<term>Value</term>
<description>Description</description>
</listheader>
<item>
<term>-1</term>
<description>This instance is shorter than <paramref name="value" />.</description>
</item>
<item>
<term>0</term>
<description>This instance is equal to <paramref name="value" />.</description>
</item>
<item>
<term>1</term>
<description>This instance is longer than <paramref name="value" />.

-or-

<paramref name="value" /> is <see langword="null" />.</description>
</item>
</list>
</returns>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks

This member is an explicit interface member implementation. It can be used only when the <xref:System.TimeSpan> instance is cast to an <xref:System.IComparable> interface.

]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="Ticks">
Expand Down Expand Up @@ -4845,7 +4877,7 @@ In some cases, when a time interval component in the string to be parsed contain
<param name="format">A span containing the characters that represent a standard or custom format string that defines the acceptable format of <paramref name="input" />.</param>
<param name="formatProvider">An object that supplies culture-specific formatting information.</param>
<param name="result">When this method returns, contains an object that represents the time interval specified by <paramref name="input" />, or <see cref="F:System.TimeSpan.Zero" /> if the conversion failed. This parameter is passed uninitialized.</param>
<summary>Converts the specified span representation of a time interval to its <see cref="T:System.TimeSpan" /> equivalent by using the specified format and culture-specific format information, and returns a value that indicates whether the conversion succeeded. The format of the string representation must match the specified format exactly.</summary>
<summary>Converts the specified span representation of a time interval to its <see cref="T:System.TimeSpan" /> equivalent by using the specified format and culture-specific format information. The format of the string representation must match the specified format exactly.</summary>
<returns><see langword="true" /> if <paramref name="input" /> was converted successfully; otherwise, <see langword="false" />.</returns>
<remarks>To be added.</remarks>
</Docs>
Expand Down Expand Up @@ -4883,7 +4915,7 @@ In some cases, when a time interval component in the string to be parsed contain
<param name="formats">An array of standard or custom format strings that define the acceptable formats of <paramref name="input" />.</param>
<param name="formatProvider">An object that supplies culture-specific formatting information.</param>
<param name="result">When this method returns, contains an object that represents the time interval specified by <paramref name="input" />, or <see cref="F:System.TimeSpan.Zero" /> if the conversion failed. This parameter is passed uninitialized.</param>
<summary>Converts the specified span representation of a time interval to its <see cref="T:System.TimeSpan" /> equivalent by using the specified formats and culture-specific format information, and returns a value that indicates whether the conversion succeeded. The format of the string representation must match one of the specified formats exactly.</summary>
<summary>Converts the specified span representation of a time interval to its <see cref="T:System.TimeSpan" /> equivalent by using the specified formats and culture-specific format information. The format of the string representation must match one of the specified formats exactly.</summary>
<returns><see langword="true" /> if <paramref name="input" /> was converted successfully; otherwise, <see langword="false" />.</returns>
<remarks>To be added.</remarks>
</Docs>
Expand Down Expand Up @@ -4929,7 +4961,7 @@ In some cases, when a time interval component in the string to be parsed contain
<param name="format">A standard or custom format string that defines the required format of <paramref name="input" />.</param>
<param name="formatProvider">An object that supplies culture-specific formatting information.</param>
<param name="result">When this method returns, contains an object that represents the time interval specified by <paramref name="input" />, or <see cref="F:System.TimeSpan.Zero" /> if the conversion failed. This parameter is passed uninitialized.</param>
<summary>Converts the string representation of a time interval to its <see cref="T:System.TimeSpan" /> equivalent by using the specified format and culture-specific format information, and returns a value that indicates whether the conversion succeeded. The format of the string representation must match the specified format exactly.</summary>
<summary>Converts the string representation of a time interval to its <see cref="T:System.TimeSpan" /> equivalent by using the specified format and culture-specific format information. The format of the string representation must match the specified format exactly.</summary>
<returns><see langword="true" /> if <paramref name="input" /> was converted successfully; otherwise, <see langword="false" />.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
Expand Down Expand Up @@ -5007,7 +5039,7 @@ In some cases, when a time interval component in the string to be parsed contain
<param name="formats">An array of standard or custom format strings that define the acceptable formats of <paramref name="input" />.</param>
<param name="formatProvider">An object that provides culture-specific formatting information.</param>
<param name="result">When this method returns, contains an object that represents the time interval specified by <paramref name="input" />, or <see cref="F:System.TimeSpan.Zero" /> if the conversion failed. This parameter is passed uninitialized.</param>
<summary>Converts the specified string representation of a time interval to its <see cref="T:System.TimeSpan" /> equivalent by using the specified formats and culture-specific format information, and returns a value that indicates whether the conversion succeeded. The format of the string representation must match one of the specified formats exactly.</summary>
<summary>Converts the specified string representation of a time interval to its <see cref="T:System.TimeSpan" /> equivalent by using the specified formats and culture-specific format information. The format of the string representation must match one of the specified formats exactly.</summary>
<returns><see langword="true" /> if <paramref name="input" /> was converted successfully; otherwise, <see langword="false" />.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
Expand Down Expand Up @@ -5083,8 +5115,8 @@ In some cases, when a time interval component in the string to be parsed contain
<param name="result">When this method returns, contains an object that represents the time interval specified by <paramref name="input" />, or <see cref="F:System.TimeSpan.Zero" /> if the conversion failed. This parameter is passed uninitialized.</param>
<summary>Converts the specified span representation of a time interval to its <see cref="T:System.TimeSpan" /> equivalent by using the specified format, culture-specific format information, and styles, and returns a value that indicates whether the conversion succeeded. The format of the string representation must match the specified format exactly.</summary>
<returns><see langword="true" /> if <paramref name="input" /> was converted successfully; otherwise, <see langword="false" />.</returns>
<summary>To be added.</summary>
<returns>To be added.</returns>
<summary>Converts the specified span representation of a time interval to its <see cref="T:System.TimeSpan" /> equivalent by using the specified formats, culture-specific format information and styles. The format of the string representation must match one of the specified formats exactly.</summary>
<returns><see langword="true" /> if <paramref name="input" /> was converted successfully; otherwise, <see langword="false" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -5123,7 +5155,7 @@ In some cases, when a time interval component in the string to be parsed contain
<param name="formatProvider">An object that supplies culture-specific formatting information.</param>
<param name="styles">One or more enumeration values that indicate the style of <paramref name="input" />.</param>
<param name="result">When this method returns, contains an object that represents the time interval specified by <paramref name="input" />, or <see cref="F:System.TimeSpan.Zero" /> if the conversion failed. This parameter is passed uninitialized.</param>
<summary>Converts the specified span representation of a time interval to its <see cref="T:System.TimeSpan" /> equivalent by using the specified formats, culture-specific format information, and styles, and returns a value that indicates whether the conversion succeeded. The format of the string representation must match one of the specified formats exactly.</summary>
<summary>Converts the specified span representation of a time interval to its <see cref="T:System.TimeSpan" /> equivalent by using the specified formats, culture-specific format information and styles. The format of the string representation must match one of the specified formats exactly.</summary>
<returns><see langword="true" /> if <paramref name="input" /> was converted successfully; otherwise, <see langword="false" />.</returns>
<remarks>To be added.</remarks>
</Docs>
Expand Down Expand Up @@ -5171,7 +5203,7 @@ In some cases, when a time interval component in the string to be parsed contain
<param name="formatProvider">An object that provides culture-specific formatting information.</param>
<param name="styles">One or more enumeration values that indicate the style of <paramref name="input" />.</param>
<param name="result">When this method returns, contains an object that represents the time interval specified by <paramref name="input" />, or <see cref="F:System.TimeSpan.Zero" /> if the conversion failed. This parameter is passed uninitialized.</param>
<summary>Converts the string representation of a time interval to its <see cref="T:System.TimeSpan" /> equivalent by using the specified format, culture-specific format information, and styles, and returns a value that indicates whether the conversion succeeded. The format of the string representation must match the specified format exactly.</summary>
<summary>Converts the string representation of a time interval to its <see cref="T:System.TimeSpan" /> equivalent by using the specified format, culture-specific format information and styles. The format of the string representation must match the specified format exactly.</summary>
<returns><see langword="true" /> if <paramref name="input" /> was converted successfully; otherwise, <see langword="false" />.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
Expand Down Expand Up @@ -5250,7 +5282,7 @@ In some cases, when a time interval component in the string to be parsed contain
<param name="formatProvider">An object that supplies culture-specific formatting information.</param>
<param name="styles">One or more enumeration values that indicate the style of <paramref name="input" />.</param>
<param name="result">When this method returns, contains an object that represents the time interval specified by <paramref name="input" />, or <see cref="F:System.TimeSpan.Zero" /> if the conversion failed. This parameter is passed uninitialized.</param>
<summary>Converts the specified string representation of a time interval to its <see cref="T:System.TimeSpan" /> equivalent by using the specified formats, culture-specific format information, and styles, and returns a value that indicates whether the conversion succeeded. The format of the string representation must match one of the specified formats exactly.</summary>
<summary>Converts the specified string representation of a time interval to its <see cref="T:System.TimeSpan" /> equivalent by using the specified formats, culture-specific format information and styles. The format of the string representation must match one of the specified formats exactly.</summary>
<returns><see langword="true" /> if <paramref name="input" /> was converted successfully; otherwise, <see langword="false" />.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
Expand Down