Skip to content

Commit c9a87d4

Browse files
authored
Document System.TimeSpan (#3637)
* Document System.TimeSpan.op_Multiply * Additional undocumented APIs * suggestion by Thraka
1 parent b825542 commit c9a87d4

File tree

1 file changed

+50
-18
lines changed

1 file changed

+50
-18
lines changed

xml/System/TimeSpan.xml

Lines changed: 50 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -2535,8 +2535,8 @@
25352535
<Docs>
25362536
<param name="factor">The value to be multiplied by.</param>
25372537
<param name="timeSpan">The value to be multiplied.</param>
2538-
<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>
2539-
<returns>A new object that represents the value of <paramref name="timeSpan" /> instance multiplied by the value of <paramref name="factor" />.</returns>
2538+
<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>
2539+
<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>
25402540
<remarks>To be added.</remarks>
25412541
</Docs>
25422542
</Member>
@@ -2567,10 +2567,10 @@
25672567
<Parameter Name="factor" Type="System.Double" Index="1" FrameworkAlternate="netcore-2.0;netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
25682568
</Parameters>
25692569
<Docs>
2570-
<param name="timeSpan">To be added.</param>
2571-
<param name="factor">To be added.</param>
2572-
<summary>To be added.</summary>
2573-
<returns>To be added.</returns>
2570+
<param name="timeSpan">The value to be multiplied.</param>
2571+
<param name="factor">The value to be multiplied by.</param>
2572+
<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>
2573+
<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>
25742574
<remarks>To be added.</remarks>
25752575
</Docs>
25762576
</Member>
@@ -3590,9 +3590,41 @@ When a time interval component in the string to be parsed contains more than sev
35903590
</Parameters>
35913591
<Docs>
35923592
<param name="value">To be added.</param>
3593-
<summary>To be added.</summary>
3594-
<returns>To be added.</returns>
3595-
<remarks>To be added.</remarks>
3593+
<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>
3594+
<returns>
3595+
One of the following values:
3596+
<list type="table">
3597+
<listheader>
3598+
<term>Value</term>
3599+
<description>Description</description>
3600+
</listheader>
3601+
<item>
3602+
<term>-1</term>
3603+
<description>This instance is shorter than <paramref name="value" />.</description>
3604+
</item>
3605+
<item>
3606+
<term>0</term>
3607+
<description>This instance is equal to <paramref name="value" />.</description>
3608+
</item>
3609+
<item>
3610+
<term>1</term>
3611+
<description>This instance is longer than <paramref name="value" />.
3612+
3613+
-or-
3614+
3615+
<paramref name="value" /> is <see langword="null" />.</description>
3616+
</item>
3617+
</list>
3618+
</returns>
3619+
<remarks>
3620+
<format type="text/markdown"><![CDATA[
3621+
3622+
## Remarks
3623+
3624+
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.
3625+
3626+
]]></format>
3627+
</remarks>
35963628
</Docs>
35973629
</Member>
35983630
<Member MemberName="Ticks">
@@ -4845,7 +4877,7 @@ In some cases, when a time interval component in the string to be parsed contain
48454877
<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>
48464878
<param name="formatProvider">An object that supplies culture-specific formatting information.</param>
48474879
<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>
4848-
<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>
4880+
<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>
48494881
<returns><see langword="true" /> if <paramref name="input" /> was converted successfully; otherwise, <see langword="false" />.</returns>
48504882
<remarks>To be added.</remarks>
48514883
</Docs>
@@ -4883,7 +4915,7 @@ In some cases, when a time interval component in the string to be parsed contain
48834915
<param name="formats">An array of standard or custom format strings that define the acceptable formats of <paramref name="input" />.</param>
48844916
<param name="formatProvider">An object that supplies culture-specific formatting information.</param>
48854917
<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>
4886-
<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>
4918+
<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>
48874919
<returns><see langword="true" /> if <paramref name="input" /> was converted successfully; otherwise, <see langword="false" />.</returns>
48884920
<remarks>To be added.</remarks>
48894921
</Docs>
@@ -4929,7 +4961,7 @@ In some cases, when a time interval component in the string to be parsed contain
49294961
<param name="format">A standard or custom format string that defines the required format of <paramref name="input" />.</param>
49304962
<param name="formatProvider">An object that supplies culture-specific formatting information.</param>
49314963
<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>
4932-
<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>
4964+
<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>
49334965
<returns><see langword="true" /> if <paramref name="input" /> was converted successfully; otherwise, <see langword="false" />.</returns>
49344966
<remarks>
49354967
<format type="text/markdown"><![CDATA[
@@ -5007,7 +5039,7 @@ In some cases, when a time interval component in the string to be parsed contain
50075039
<param name="formats">An array of standard or custom format strings that define the acceptable formats of <paramref name="input" />.</param>
50085040
<param name="formatProvider">An object that provides culture-specific formatting information.</param>
50095041
<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>
5010-
<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>
5042+
<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>
50115043
<returns><see langword="true" /> if <paramref name="input" /> was converted successfully; otherwise, <see langword="false" />.</returns>
50125044
<remarks>
50135045
<format type="text/markdown"><![CDATA[
@@ -5083,8 +5115,8 @@ In some cases, when a time interval component in the string to be parsed contain
50835115
<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>
50845116
<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>
50855117
<returns><see langword="true" /> if <paramref name="input" /> was converted successfully; otherwise, <see langword="false" />.</returns>
5086-
<summary>To be added.</summary>
5087-
<returns>To be added.</returns>
5118+
<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>
5119+
<returns><see langword="true" /> if <paramref name="input" /> was converted successfully; otherwise, <see langword="false" />.</returns>
50885120
<remarks>To be added.</remarks>
50895121
</Docs>
50905122
</Member>
@@ -5123,7 +5155,7 @@ In some cases, when a time interval component in the string to be parsed contain
51235155
<param name="formatProvider">An object that supplies culture-specific formatting information.</param>
51245156
<param name="styles">One or more enumeration values that indicate the style of <paramref name="input" />.</param>
51255157
<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>
5126-
<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>
5158+
<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>
51275159
<returns><see langword="true" /> if <paramref name="input" /> was converted successfully; otherwise, <see langword="false" />.</returns>
51285160
<remarks>To be added.</remarks>
51295161
</Docs>
@@ -5171,7 +5203,7 @@ In some cases, when a time interval component in the string to be parsed contain
51715203
<param name="formatProvider">An object that provides culture-specific formatting information.</param>
51725204
<param name="styles">One or more enumeration values that indicate the style of <paramref name="input" />.</param>
51735205
<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>
5174-
<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>
5206+
<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>
51755207
<returns><see langword="true" /> if <paramref name="input" /> was converted successfully; otherwise, <see langword="false" />.</returns>
51765208
<remarks>
51775209
<format type="text/markdown"><![CDATA[
@@ -5250,7 +5282,7 @@ In some cases, when a time interval component in the string to be parsed contain
52505282
<param name="formatProvider">An object that supplies culture-specific formatting information.</param>
52515283
<param name="styles">One or more enumeration values that indicate the style of <paramref name="input" />.</param>
52525284
<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>
5253-
<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>
5285+
<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>
52545286
<returns><see langword="true" /> if <paramref name="input" /> was converted successfully; otherwise, <see langword="false" />.</returns>
52555287
<remarks>
52565288
<format type="text/markdown"><![CDATA[

0 commit comments

Comments
 (0)