From 693760e38ae51b9267f9383c3957df742bb136a6 Mon Sep 17 00:00:00 2001
From: Stepan <ste.martinek+git@gmail.com>
Date: Tue, 10 Nov 2020 17:11:48 +0100
Subject: Xml-doc part1

---
 Emby.Naming/Video/CleanStringParser.cs | 10 +++++++---
 1 file changed, 7 insertions(+), 3 deletions(-)

(limited to 'Emby.Naming/Video/CleanStringParser.cs')

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;
-- 
cgit v1.2.3