aboutsummaryrefslogtreecommitdiff
path: root/Emby.Naming/TV
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/TV
parentc0747512d6d3973ac102ea4990d2e1fa44e5a5d1 (diff)
Xml-doc part1
Diffstat (limited to 'Emby.Naming/TV')
-rw-r--r--Emby.Naming/TV/EpisodeInfo.cs30
-rw-r--r--Emby.Naming/TV/EpisodePathParser.cs20
-rw-r--r--Emby.Naming/TV/EpisodePathParserResult.cs33
-rw-r--r--Emby.Naming/TV/EpisodeResolver.cs3
-rw-r--r--Emby.Naming/TV/SeasonPathParser.cs2
-rw-r--r--Emby.Naming/TV/SeasonPathParserResult.cs2
6 files changed, 76 insertions, 14 deletions
diff --git a/Emby.Naming/TV/EpisodeInfo.cs b/Emby.Naming/TV/EpisodeInfo.cs
index e01c81062..a8920b36a 100644
--- a/Emby.Naming/TV/EpisodeInfo.cs
+++ b/Emby.Naming/TV/EpisodeInfo.cs
@@ -1,9 +1,14 @@
-#pragma warning disable CS1591
-
namespace Emby.Naming.TV
{
+ /// <summary>
+ /// Holder object for Episode information.
+ /// </summary>
public class EpisodeInfo
{
+ /// <summary>
+ /// Initializes a new instance of the <see cref="EpisodeInfo"/> class.
+ /// </summary>
+ /// <param name="path">Path to the file.</param>
public EpisodeInfo(string path)
{
Path = path;
@@ -51,18 +56,39 @@ namespace Emby.Naming.TV
/// <value>The type of the stub.</value>
public string? StubType { get; set; }
+ /// <summary>
+ /// Gets or sets optional season number.
+ /// </summary>
public int? SeasonNumber { get; set; }
+ /// <summary>
+ /// Gets or sets optional episode number.
+ /// </summary>
public int? EpisodeNumber { get; set; }
+ /// <summary>
+ /// Gets or sets optional ending episode number. For multi-episode files 1-13.
+ /// </summary>
public int? EndingEpisodeNumber { get; set; }
+ /// <summary>
+ /// Gets or sets optional year of release.
+ /// </summary>
public int? Year { get; set; }
+ /// <summary>
+ /// Gets or sets optional year of release.
+ /// </summary>
public int? Month { get; set; }
+ /// <summary>
+ /// Gets or sets optional day of release.
+ /// </summary>
public int? Day { get; set; }
+ /// <summary>
+ /// Gets or sets a value indicating whether by date expression was used.
+ /// </summary>
public bool IsByDate { get; set; }
}
}
diff --git a/Emby.Naming/TV/EpisodePathParser.cs b/Emby.Naming/TV/EpisodePathParser.cs
index d9cc8172b..6d0597356 100644
--- a/Emby.Naming/TV/EpisodePathParser.cs
+++ b/Emby.Naming/TV/EpisodePathParser.cs
@@ -1,6 +1,3 @@
-#pragma warning disable CS1591
-#nullable enable
-
using System;
using System.Collections.Generic;
using System.Globalization;
@@ -9,15 +6,32 @@ using Emby.Naming.Common;
namespace Emby.Naming.TV
{
+ /// <summary>
+ /// Used to parse information about episode from path.
+ /// </summary>
public class EpisodePathParser
{
private readonly NamingOptions _options;
+ /// <summary>
+ /// Initializes a new instance of the <see cref="EpisodePathParser"/> class.
+ /// </summary>
+ /// <param name="options"><see cref="NamingOptions"/> object containing EpisodeExpressions and MultipleEpisodeExpressions.</param>
public EpisodePathParser(NamingOptions options)
{
_options = options;
}
+ /// <summary>
+ /// Parses information about episode from path.
+ /// </summary>
+ /// <param name="path">Path.</param>
+ /// <param name="isDirectory">Is path for a directory or file.</param>
+ /// <param name="isNamed">Do we want to use IsNamed expressions.</param>
+ /// <param name="isOptimistic">Do we want to use Optimistic expressions.</param>
+ /// <param name="supportsAbsoluteNumbers">Do we want to use expressions supporting absolute episode numbers.</param>
+ /// <param name="fillExtendedInfo">Should we attempt to retrieve extended information.</param>
+ /// <returns>Returns <see cref="EpisodePathParserResult"/> object.</returns>
public EpisodePathParserResult Parse(
string path,
bool isDirectory,
diff --git a/Emby.Naming/TV/EpisodePathParserResult.cs b/Emby.Naming/TV/EpisodePathParserResult.cs
index 5fa0b6f0b..233d5a4f6 100644
--- a/Emby.Naming/TV/EpisodePathParserResult.cs
+++ b/Emby.Naming/TV/EpisodePathParserResult.cs
@@ -1,25 +1,54 @@
-#pragma warning disable CS1591
-
namespace Emby.Naming.TV
{
+ /// <summary>
+ /// Holder object for <see cref="EpisodePathParser"/> result.
+ /// </summary>
public class EpisodePathParserResult
{
+ /// <summary>
+ /// Gets or sets optional season number.
+ /// </summary>
public int? SeasonNumber { get; set; }
+ /// <summary>
+ /// Gets or sets optional episode number.
+ /// </summary>
public int? EpisodeNumber { get; set; }
+ /// <summary>
+ /// Gets or sets optional ending episode number. For multi-episode files 1-13.
+ /// </summary>
public int? EndingEpisodeNumber { get; set; }
+ /// <summary>
+ /// Gets or sets the name of the series.
+ /// </summary>
+ /// <value>The name of the series.</value>
public string? SeriesName { get; set; }
+ /// <summary>
+ /// Gets or sets a value indicating whether parsing was successful.
+ /// </summary>
public bool Success { get; set; }
+ /// <summary>
+ /// Gets or sets a value indicating whether by date expression was used.
+ /// </summary>
public bool IsByDate { get; set; }
+ /// <summary>
+ /// Gets or sets optional year of release.
+ /// </summary>
public int? Year { get; set; }
+ /// <summary>
+ /// Gets or sets optional year of release.
+ /// </summary>
public int? Month { get; set; }
+ /// <summary>
+ /// Gets or sets optional day of release.
+ /// </summary>
public int? Day { get; set; }
}
}
diff --git a/Emby.Naming/TV/EpisodeResolver.cs b/Emby.Naming/TV/EpisodeResolver.cs
index 5f02c553d..26dd6915b 100644
--- a/Emby.Naming/TV/EpisodeResolver.cs
+++ b/Emby.Naming/TV/EpisodeResolver.cs
@@ -1,6 +1,3 @@
-#pragma warning disable CS1591
-#nullable enable
-
using System;
using System.IO;
using System.Linq;
diff --git a/Emby.Naming/TV/SeasonPathParser.cs b/Emby.Naming/TV/SeasonPathParser.cs
index 142680f0c..cf99097bc 100644
--- a/Emby.Naming/TV/SeasonPathParser.cs
+++ b/Emby.Naming/TV/SeasonPathParser.cs
@@ -1,5 +1,3 @@
-#pragma warning disable CS1591
-
using System;
using System.Globalization;
using System.IO;
diff --git a/Emby.Naming/TV/SeasonPathParserResult.cs b/Emby.Naming/TV/SeasonPathParserResult.cs
index a142fafea..f52f941a7 100644
--- a/Emby.Naming/TV/SeasonPathParserResult.cs
+++ b/Emby.Naming/TV/SeasonPathParserResult.cs
@@ -1,5 +1,3 @@
-#pragma warning disable CS1591
-
namespace Emby.Naming.TV
{
public class SeasonPathParserResult