oliverbooth/X10D
oliverbooth
/
X10D
mirror of https://github.com/oliverbooth/X10D
1
0
Fork 0
Code Issues

(#15) Explicitly describe return value

This commit is contained in:
Oliver Booth 2021-03-10 11:29:10 +00:00
parent a3815a1e10
commit 4c5f02b221
1 changed files with 8 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
X10D/src/StringExtensions/StringExtensions.cs
View File

@ -14,7 +14,10 @@ namespace X10D.StringExtensions
/// Returns the current string, or <see langword="null" /> if the current string is null or empty.
/// </summary>
/// <param name="value">The value to sanitize.</param>
/// <returns><see langword="null" /> or <paramref name="value" />.</returns>
/// <returns>
/// <see langword="null" /> if <paramref name="value" /> is <see langword="null" /> or equal to
/// <see cref="string.Empty" />, or <paramref name="value" /> otherwise.
/// </returns>
public static string? AsNullIfEmpty(this string value)
{
return string.IsNullOrEmpty(value) ? null : value;
@ -25,7 +28,10 @@ namespace X10D.StringExtensions
/// whitespace.
/// </summary>
/// <param name="value">The value to sanitize.</param>
/// <returns><see langword="null" /> or <paramref name="value" />.</returns>
/// <returns>
/// <see langword="null" /> if <paramref name="value" /> is <see langword="null" /> or equal to
/// <see cref="string.Empty" /> or is composed of only whitespace characters, or <paramref name="value" /> otherwise.
/// </returns>
public static string? AsNullIfWhiteSpace(this string value)
{
return string.IsNullOrWhiteSpace(value) ? null : value;