(#15) Clarify xmldoc summary and returns

This commit is contained in:
Oliver Booth 2021-03-10 11:34:54 +00:00
parent 98aaf67d4b
commit 5b46523c51
1 changed files with 3 additions and 3 deletions

View File

@ -10,12 +10,12 @@ namespace X10D
public static class TimeSpanParser public static class TimeSpanParser
{ {
/// <summary> /// <summary>
/// Parses a shorthand time span string (e.g. 3w 2d 1.5h) and converts it to an instance of /// Parses a shorthand time span string (e.g. 3w 2d 1.5h) and converts it to an instance of <see cref="TimeSpan" />
/// <see cref="TimeSpan" />. /// which represents that duration of time.
/// </summary> /// </summary>
/// <param name="input">The input string.</param> /// <param name="input">The input string.</param>
/// <param name="provider">The format provider.</param> /// <param name="provider">The format provider.</param>
/// <returns>Returns an instance of <see cref="TimeSpan" />.</returns> /// <returns>An instance of <see cref="TimeSpan" /> constructed from the parsed <paramref name="input" />.</returns>
public static TimeSpan Parse(string input, IFormatProvider? provider = null) public static TimeSpan Parse(string input, IFormatProvider? provider = null)
{ {
const string realNumberPattern = @"([0-9]*\.[0-9]+|[0-9]+)"; const string realNumberPattern = @"([0-9]*\.[0-9]+|[0-9]+)";