diff options
| author | Stepan <ste.martinek+git@gmail.com> | 2020-11-10 17:11:48 +0100 |
|---|---|---|
| committer | Stepan <ste.martinek+git@gmail.com> | 2020-11-10 17:11:48 +0100 |
| commit | 693760e38ae51b9267f9383c3957df742bb136a6 (patch) | |
| tree | ac837069ba6b1f31e15a3b8cfbd15d26797a33ff /Emby.Naming/Video/CleanStringParser.cs | |
| parent | c0747512d6d3973ac102ea4990d2e1fa44e5a5d1 (diff) | |
Xml-doc part1
Diffstat (limited to 'Emby.Naming/Video/CleanStringParser.cs')
| -rw-r--r-- | Emby.Naming/Video/CleanStringParser.cs | 10 |
1 files changed, 7 insertions, 3 deletions
diff --git a/Emby.Naming/Video/CleanStringParser.cs b/Emby.Naming/Video/CleanStringParser.cs index 3f584d584..09a0cd189 100644 --- a/Emby.Naming/Video/CleanStringParser.cs +++ b/Emby.Naming/Video/CleanStringParser.cs @@ -1,6 +1,3 @@ -#pragma warning disable CS1591 -#nullable enable - using System; using System.Collections.Generic; using System.Text.RegularExpressions; @@ -12,6 +9,13 @@ namespace Emby.Naming.Video /// </summary> public static class CleanStringParser { + /// <summary> + /// Attempts to extract clean name with regular expressions. + /// </summary> + /// <param name="name">Name of file.</param> + /// <param name="expressions">List of regex to parse name and year from.</param> + /// <param name="newName">Parsing result string.</param> + /// <returns>True if parsing was successful.</returns> public static bool TryClean(string name, IReadOnlyList<Regex> expressions, out ReadOnlySpan<char> newName) { var len = expressions.Count; |
