mirror of
https://github.com/PepperDash/Essentials.git
synced 2026-01-30 12:54:54 +00:00
docs: complete XML documentation for all projects with inheritdoc tags
Co-authored-by: andrew-welker <1765622+andrew-welker@users.noreply.github.com>
This commit is contained in:
@@ -14,6 +14,9 @@ namespace PepperDash.Essentials.Core
|
||||
/// </summary>
|
||||
/// <param name="s">string input</param>
|
||||
/// <returns>null if the string is emtpy, otherwise returns the string</returns>
|
||||
/// <summary>
|
||||
/// NullIfEmpty method
|
||||
/// </summary>
|
||||
public static string NullIfEmpty(this string s)
|
||||
{
|
||||
return string.IsNullOrEmpty(s) ? null : s;
|
||||
@@ -24,6 +27,9 @@ namespace PepperDash.Essentials.Core
|
||||
/// </summary>
|
||||
/// <param name="s">string input</param>
|
||||
/// <returns>null if the string is wempty or made of only whitespace characters, otherwise returns the string</returns>
|
||||
/// <summary>
|
||||
/// NullIfWhiteSpace method
|
||||
/// </summary>
|
||||
public static string NullIfWhiteSpace(this string s)
|
||||
{
|
||||
return string.IsNullOrEmpty(s.Trim()) ? null : s;
|
||||
@@ -35,6 +41,9 @@ namespace PepperDash.Essentials.Core
|
||||
/// <param name="s">input string</param>
|
||||
/// <param name="newString">string to replace with if input string is empty or whitespace</param>
|
||||
/// <returns>returns newString if s is null, emtpy, or made of whitespace characters, otherwise returns s</returns>
|
||||
/// <summary>
|
||||
/// ReplaceIfNullOrEmpty method
|
||||
/// </summary>
|
||||
public static string ReplaceIfNullOrEmpty(this string s, string newString)
|
||||
{
|
||||
return string.IsNullOrEmpty(s) ? newString : s;
|
||||
@@ -47,6 +56,9 @@ namespace PepperDash.Essentials.Core
|
||||
/// <param name="toCheck">String to check in Source String</param>
|
||||
/// <param name="comp">Comparison parameters</param>
|
||||
/// <returns>true of string contains "toCheck"</returns>
|
||||
/// <summary>
|
||||
/// Contains method
|
||||
/// </summary>
|
||||
public static bool Contains(this string source, string toCheck, StringComparison comp)
|
||||
{
|
||||
if (string.IsNullOrEmpty(source)) return false;
|
||||
@@ -58,6 +70,9 @@ namespace PepperDash.Essentials.Core
|
||||
/// </summary>
|
||||
/// <param name="source">String to Trim</param>
|
||||
/// <returns>Trimmed String</returns>
|
||||
/// <summary>
|
||||
/// TrimAll method
|
||||
/// </summary>
|
||||
public static string TrimAll(this string source)
|
||||
{
|
||||
return string.IsNullOrEmpty(source) ? string.Empty : source.TrimStart().TrimEnd();
|
||||
@@ -69,6 +84,9 @@ namespace PepperDash.Essentials.Core
|
||||
/// <param name="source">String to Trim</param>
|
||||
/// <param name="chars">Char Array to trim from string</param>
|
||||
/// <returns>Trimmed String</returns>
|
||||
/// <summary>
|
||||
/// TrimAll method
|
||||
/// </summary>
|
||||
public static string TrimAll(this string source, char[] chars)
|
||||
{
|
||||
return string.IsNullOrEmpty(source) ? string.Empty : source.TrimStart(chars).TrimEnd(chars);
|
||||
|
||||
Reference in New Issue
Block a user