Skip to content

Commit babd58a

Browse files
krwqcarlossanlop
authored andcommitted
Add missing DateTime/DateTimeOffset/TimeSpan docs (#3500)
* Add missing DateTime/DateTimeOffset/TimeSpan docs * Update xml/System/DateTime.xml Co-Authored-By: Carlos Sanchez Lopez <[email protected]> * Update xml/System/DateTimeOffset.xml Co-Authored-By: Carlos Sanchez Lopez <[email protected]> * fix build * string representation -> char span
1 parent a6acfff commit babd58a

File tree

3 files changed

+43
-43
lines changed

3 files changed

+43
-43
lines changed

xml/System/DateTime.xml

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -8102,7 +8102,7 @@ The value of the current <xref:System.DateTime> object is formatted using the pa
81028102
<Docs>
81038103
<param name="s">A string containing a date and time to convert.</param>
81048104
<param name="result">When this method returns, contains the <see cref="T:System.DateTime" /> value equivalent to the date and time contained in <paramref name="s" />, if the conversion succeeded, or <see cref="F:System.DateTime.MinValue" /> if the conversion failed. The conversion fails if the <paramref name="s" /> parameter is <see langword="null" />, is an empty string (""), or does not contain a valid string representation of a date and time. This parameter is passed uninitialized.</param>
8105-
<summary>To be added.</summary>
8105+
<summary>Converts the specified char span of a date and time to its <see cref="T:System.DateTime" /> equivalent and returns a value that indicates whether the conversion succeeded.</summary>
81068106
<returns><see langword="true" /> if the <paramref name="s" /> parameter was converted successfully; otherwise, <see langword="false" />.</returns>
81078107
<remarks>To be added.</remarks>
81088108
</Docs>
@@ -8446,13 +8446,13 @@ The value of the current <xref:System.DateTime> object is formatted using the pa
84468446
<Parameter Name="result" Type="System.DateTime" RefType="out" Index="4" FrameworkAlternate="netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
84478447
</Parameters>
84488448
<Docs>
8449-
<param name="s">To be added.</param>
8450-
<param name="formats">To be added.</param>
8451-
<param name="provider">To be added.</param>
8452-
<param name="style">To be added.</param>
8453-
<param name="result">To be added.</param>
8454-
<summary>To be added.</summary>
8455-
<returns>To be added.</returns>
8449+
<param name="s">The span containing the string to parse.</param>
8450+
<param name="formats">An array of allowable formats of <paramref name="s" />.</param>
8451+
<param name="provider">An object that supplies culture-specific formatting information about <paramref name="s" />.</param>
8452+
<param name="style">A bitwise combination of enumeration values that defines how to interpret the parsed date in relation to the current time zone or the current date. A typical value to specify is <see cref="F:System.Globalization.DateTimeStyles.None" />.</param>
8453+
<param name="result">When this method returns, contains the <see cref="T:System.DateTime" /> value equivalent to the date and time contained in <paramref name="s" />, if the conversion succeeded, or <see cref="F:System.DateTime.MinValue" /> if the conversion failed. The conversion fails if the <paramref name="s" /> parameter is <see langword="null" />, is <see cref="F:System.String.Empty" />, or does not contain a valid string representation of a date and time. This parameter is passed uninitialized.</param>
8454+
<summary>Converts the specified char span of a date and time to its <see cref="T:System.DateTime" /> equivalent and returns a value that indicates whether the conversion succeeded.</summary>
8455+
<returns><see langword="true" /> if the <paramref name="s" /> parameter was converted successfully; otherwise, <see langword="false" />.</returns>
84568456
<remarks>To be added.</remarks>
84578457
</Docs>
84588458
</Member>
@@ -8706,7 +8706,7 @@ The value of the current <xref:System.DateTime> object is formatted using the pa
87068706
<ReturnType>System.DateTime</ReturnType>
87078707
</ReturnValue>
87088708
<Docs>
8709-
<summary>To be added.</summary>
8709+
<summary>The value of this constant is equivalent to 00:00:00.0000000 UTC, January 1, 1970, in the Gregorian calendar. <see cref="F:System.DateTime.UnixEpoch" /> defines the point in time when Unix time is equal to 0.</summary>
87108710
<remarks>To be added.</remarks>
87118711
</Docs>
87128712
</Member>

xml/System/DateTimeOffset.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6064,7 +6064,7 @@ Strings that do not specify a UTC offset are assumed to have the offset of the l
60646064
<ReturnType>System.DateTimeOffset</ReturnType>
60656065
</ReturnValue>
60666066
<Docs>
6067-
<summary>To be added.</summary>
6067+
<summary>The value of this constant is equivalent to 00:00:00.0000000 UTC, January 1, 1970, in the Gregorian calendar. <see cref="F:System.DateTimeOffset.UnixEpoch" /> defines the point in time when Unix time is equal to 0.</summary>
60686068
<remarks>To be added.</remarks>
60696069
</Docs>
60706070
</Member>

xml/System/TimeSpan.xml

Lines changed: 33 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -818,9 +818,9 @@
818818
<Parameter Name="divisor" Type="System.Double" Index="0" FrameworkAlternate="netcore-2.0;netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
819819
</Parameters>
820820
<Docs>
821-
<param name="divisor">To be added.</param>
822-
<summary>To be added.</summary>
823-
<returns>To be added.</returns>
821+
<param name="divisor">The value to be divided by.</param>
822+
<summary>Returns a new <see cref="T:System.TimeSpan" /> object which value is the result of division of this instance and the specified <paramref name="divisor" />.</summary>
823+
<returns>A new object that represents the value of this instance divided by the value of <paramref name="divisor" />.</returns>
824824
<remarks>To be added.</remarks>
825825
</Docs>
826826
</Member>
@@ -851,9 +851,9 @@
851851
<Parameter Name="ts" Type="System.TimeSpan" Index="0" FrameworkAlternate="netcore-2.0;netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
852852
</Parameters>
853853
<Docs>
854-
<param name="ts">To be added.</param>
855-
<summary>To be added.</summary>
856-
<returns>To be added.</returns>
854+
<param name="ts">The value to be divided by.</param>
855+
<summary>Returns a new <see cref="T:System.Double" /> value which is the result of division of this instance and the specified <paramref name="ts" />.</summary>
856+
<returns>A new value that represents result of division of this instance by the value of the <paramref name="ts" />.</returns>
857857
<remarks>To be added.</remarks>
858858
</Docs>
859859
</Member>
@@ -1943,9 +1943,9 @@
19431943
<Parameter Name="factor" Type="System.Double" Index="0" FrameworkAlternate="netcore-2.0;netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
19441944
</Parameters>
19451945
<Docs>
1946-
<param name="factor">To be added.</param>
1947-
<summary>To be added.</summary>
1948-
<returns>To be added.</returns>
1946+
<param name="factor">The value to be multiplied by.</param>
1947+
<summary>Returns a new <see cref="T:System.TimeSpan" /> object which value is the result of multiplication of this instance and the specified <paramref name="factor" />.</summary>
1948+
<returns>A new object that represents the value of this instance multiplied by the value of <paramref name="factor" />.</returns>
19491949
<remarks>To be added.</remarks>
19501950
</Docs>
19511951
</Member>
@@ -2085,10 +2085,10 @@
20852085
<Parameter Name="divisor" Type="System.Double" Index="1" FrameworkAlternate="netcore-2.0;netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
20862086
</Parameters>
20872087
<Docs>
2088-
<param name="timeSpan">To be added.</param>
2089-
<param name="divisor">To be added.</param>
2090-
<summary>To be added.</summary>
2091-
<returns>To be added.</returns>
2088+
<param name="timeSpan">Dividend or the value to be divided.</param>
2089+
<param name="divisor">The value to be divided by.</param>
2090+
<summary>Returns a new <see cref="T:System.TimeSpan" /> object which value is the result of division of <paramref name="timeSpan" /> instance and the specified <paramref name="divisor" />.</summary>
2091+
<returns>A new object that represents the value of <paramref name="timeSpan" /> instance divided by the value of <paramref name="divisor" />.</returns>
20922092
<remarks>To be added.</remarks>
20932093
</Docs>
20942094
</Member>
@@ -2120,10 +2120,10 @@
21202120
<Parameter Name="t2" Type="System.TimeSpan" Index="1" FrameworkAlternate="netcore-2.0;netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
21212121
</Parameters>
21222122
<Docs>
2123-
<param name="t1">To be added.</param>
2124-
<param name="t2">To be added.</param>
2125-
<summary>To be added.</summary>
2126-
<returns>To be added.</returns>
2123+
<param name="t1">Divident or the value to be divided.</param>
2124+
<param name="t2">The value to be divided by.</param>
2125+
<summary>Returns a new <see cref="T:System.Double" /> value which is the result of division of <paramref name="t1" /> instance and the specified <paramref name="t2" />.</summary>
2126+
<returns>A new value that represents result of division of <paramref name="t1" /> instance by the value of the <paramref name="t2" />.</returns>
21272127
<remarks>To be added.</remarks>
21282128
</Docs>
21292129
</Member>
@@ -2533,10 +2533,10 @@
25332533
<Parameter Name="timeSpan" Type="System.TimeSpan" Index="1" FrameworkAlternate="netcore-2.0;netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
25342534
</Parameters>
25352535
<Docs>
2536-
<param name="factor">To be added.</param>
2537-
<param name="timeSpan">To be added.</param>
2538-
<summary>To be added.</summary>
2539-
<returns>To be added.</returns>
2536+
<param name="factor">The value to be multiplied by.</param>
2537+
<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>
25402540
<remarks>To be added.</remarks>
25412541
</Docs>
25422542
</Member>
@@ -3205,12 +3205,12 @@ When a time interval component in the string to be parsed contains more than sev
32053205
<Parameter Name="styles" Type="System.Globalization.TimeSpanStyles" Index="3" FrameworkAlternate="netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
32063206
</Parameters>
32073207
<Docs>
3208-
<param name="input">To be added.</param>
3209-
<param name="format">To be added.</param>
3210-
<param name="formatProvider">To be added.</param>
3211-
<param name="styles">To be added.</param>
3212-
<summary>To be added.</summary>
3213-
<returns>To be added.</returns>
3208+
<param name="input">A span that specifies the time interval to convert.</param>
3209+
<param name="format">A standard or custom format string that defines the required format of <paramref name="input" />.</param>
3210+
<param name="formatProvider">An object that provides culture-specific formatting information.</param>
3211+
<param name="styles">A bitwise combination of enumeration values that defines the style elements that may be present in <paramref name="input" />.</param>
3212+
<summary>Converts the char span 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>
3213+
<returns>A time interval that corresponds to <paramref name="input" />, as specified by <paramref name="format" /> and <paramref name="formatProvider" />.</returns>
32143214
<remarks>To be added.</remarks>
32153215
</Docs>
32163216
</Member>
@@ -3242,12 +3242,12 @@ When a time interval component in the string to be parsed contains more than sev
32423242
<Parameter Name="styles" Type="System.Globalization.TimeSpanStyles" Index="3" FrameworkAlternate="netcore-2.1;netcore-2.2;netcore-3.0;netstandard-2.1" />
32433243
</Parameters>
32443244
<Docs>
3245-
<param name="input">To be added.</param>
3246-
<param name="formats">To be added.</param>
3247-
<param name="formatProvider">To be added.</param>
3248-
<param name="styles">To be added.</param>
3249-
<summary>To be added.</summary>
3250-
<returns>To be added.</returns>
3245+
<param name="input">A span that specifies the time interval to convert.</param>
3246+
<param name="formats">An array of standard or custom format strings that define the required format of <paramref name="input" />.</param>
3247+
<param name="formatProvider">An object that provides culture-specific formatting information.</param>
3248+
<param name="styles">A bitwise combination of enumeration values that defines the style elements that may be present in input.</param>
3249+
<summary>Converts the 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>
3250+
<returns>A time interval that corresponds to <paramref name="input" />, as specified by <paramref name="formats" />, <paramref name="formatProvider" />, and <paramref name="styles" />.</returns>
32513251
<remarks>To be added.</remarks>
32523252
</Docs>
32533253
</Member>

0 commit comments

Comments
 (0)