aboutsummaryrefslogtreecommitdiff
path: root/Emby.Naming/AudioBook/AudioBookNameParser.cs
diff options
context:
space:
mode:
authorStepan <ste.martinek+git@gmail.com>2020-11-10 17:11:48 +0100
committerStepan <ste.martinek+git@gmail.com>2020-11-10 17:11:48 +0100
commit693760e38ae51b9267f9383c3957df742bb136a6 (patch)
treeac837069ba6b1f31e15a3b8cfbd15d26797a33ff /Emby.Naming/AudioBook/AudioBookNameParser.cs
parentc0747512d6d3973ac102ea4990d2e1fa44e5a5d1 (diff)
Xml-doc part1
Diffstat (limited to 'Emby.Naming/AudioBook/AudioBookNameParser.cs')
-rw-r--r--Emby.Naming/AudioBook/AudioBookNameParser.cs15
1 files changed, 12 insertions, 3 deletions
diff --git a/Emby.Naming/AudioBook/AudioBookNameParser.cs b/Emby.Naming/AudioBook/AudioBookNameParser.cs
index 7c86161241..120482bc2c 100644
--- a/Emby.Naming/AudioBook/AudioBookNameParser.cs
+++ b/Emby.Naming/AudioBook/AudioBookNameParser.cs
@@ -1,21 +1,30 @@
-#nullable enable
-#pragma warning disable CS1591
-
using System.Globalization;
using System.Text.RegularExpressions;
using Emby.Naming.Common;
namespace Emby.Naming.AudioBook
{
+ /// <summary>
+ /// Helper class to retrieve name and year from audiobook previously retrieved name.
+ /// </summary>
public class AudioBookNameParser
{
private readonly NamingOptions _options;
+ /// <summary>
+ /// Initializes a new instance of the <see cref="AudioBookNameParser"/> class.
+ /// </summary>
+ /// <param name="options">Naming options containing AudioBookNamesExpressions.</param>
public AudioBookNameParser(NamingOptions options)
{
_options = options;
}
+ /// <summary>
+ /// Parse name and year from previously determined name of audiobook.
+ /// </summary>
+ /// <param name="name">Name of the audiobook.</param>
+ /// <returns>Returns <see cref="AudioBookNameParserResult"/> object.</returns>
public AudioBookNameParserResult Parse(string name)
{
AudioBookNameParserResult result = default;