revert xml docs indentation

This commit is contained in:
crobibero 2020-03-25 14:31:03 -06:00
parent cb68fbeb0a
commit 261a2e1989
20 changed files with 76 additions and 76 deletions

View File

@ -3,36 +3,36 @@ using System;
namespace Emby.Naming.AudioBook
{
/// <summary>
/// Represents a single video file.
/// Represents a single video file.
/// </summary>
public class AudioBookFileInfo : IComparable<AudioBookFileInfo>
{
/// <summary>
/// Gets or sets the path.
/// Gets or sets the path.
/// </summary>
/// <value>The path.</value>
public string Path { get; set; }
/// <summary>
/// Gets or sets the container.
/// Gets or sets the container.
/// </summary>
/// <value>The container.</value>
public string Container { get; set; }
/// <summary>
/// Gets or sets the part number.
/// Gets or sets the part number.
/// </summary>
/// <value>The part number.</value>
public int? PartNumber { get; set; }
/// <summary>
/// Gets or sets the chapter number.
/// Gets or sets the chapter number.
/// </summary>
/// <value>The chapter number.</value>
public int? ChapterNumber { get; set; }
/// <summary>
/// Gets or sets a value indicating whether this instance is a directory.
/// Gets or sets a value indicating whether this instance is a directory.
/// </summary>
/// <value>The type.</value>
public bool IsDirectory { get; set; }

View File

@ -3,12 +3,12 @@ using System.Collections.Generic;
namespace Emby.Naming.AudioBook
{
/// <summary>
/// Represents a complete video, including all parts and subtitles.
/// Represents a complete video, including all parts and subtitles.
/// </summary>
public class AudioBookInfo
{
/// <summary>
/// Initializes a new instance of the <see cref="AudioBookInfo" /> class.
/// Initializes a new instance of the <see cref="AudioBookInfo" /> class.
/// </summary>
public AudioBookInfo()
{
@ -18,30 +18,30 @@ namespace Emby.Naming.AudioBook
}
/// <summary>
/// Gets or sets the name.
/// Gets or sets the name.
/// </summary>
/// <value>The name.</value>
public string Name { get; set; }
/// <summary>
/// Gets or sets the year.
/// Gets or sets the year.
/// </summary>
public int? Year { get; set; }
/// <summary>
/// Gets or sets the files.
/// Gets or sets the files.
/// </summary>
/// <value>The files.</value>
public List<AudioBookFileInfo> Files { get; set; }
/// <summary>
/// Gets or sets the extras.
/// Gets or sets the extras.
/// </summary>
/// <value>The extras.</value>
public List<AudioBookFileInfo> Extras { get; set; }
/// <summary>
/// Gets or sets the alternate versions.
/// Gets or sets the alternate versions.
/// </summary>
/// <value>The alternate versions.</value>
public List<AudioBookFileInfo> AlternateVersions { get; set; }

View File

@ -5,17 +5,17 @@ namespace Emby.Naming.Common
public enum MediaType
{
/// <summary>
/// The audio
/// The audio
/// </summary>
Audio = 0,
/// <summary>
/// The photo
/// The photo
/// </summary>
Photo = 1,
/// <summary>
/// The video
/// The video
/// </summary>
Video = 2
}

View File

@ -5,25 +5,25 @@ namespace Emby.Naming.Subtitles
public class SubtitleInfo
{
/// <summary>
/// Gets or sets the path.
/// Gets or sets the path.
/// </summary>
/// <value>The path.</value>
public string Path { get; set; }
/// <summary>
/// Gets or sets the language.
/// Gets or sets the language.
/// </summary>
/// <value>The language.</value>
public string Language { get; set; }
/// <summary>
/// Gets or sets a value indicating whether this instance is default.
/// Gets or sets a value indicating whether this instance is default.
/// </summary>
/// <value><c>true</c> if this instance is default; otherwise, <c>false</c>.</value>
public bool IsDefault { get; set; }
/// <summary>
/// Gets or sets a value indicating whether this instance is forced.
/// Gets or sets a value indicating whether this instance is forced.
/// </summary>
/// <value><c>true</c> if this instance is forced; otherwise, <c>false</c>.</value>
public bool IsForced { get; set; }

View File

@ -5,43 +5,43 @@ namespace Emby.Naming.TV
public class EpisodeInfo
{
/// <summary>
/// Gets or sets the path.
/// Gets or sets the path.
/// </summary>
/// <value>The path.</value>
public string Path { get; set; }
/// <summary>
/// Gets or sets the container.
/// Gets or sets the container.
/// </summary>
/// <value>The container.</value>
public string Container { get; set; }
/// <summary>
/// Gets or sets the name of the series.
/// 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 the format3 d.
/// Gets or sets the format3 d.
/// </summary>
/// <value>The format3 d.</value>
public string Format3D { get; set; }
/// <summary>
/// Gets or sets a value indicating whether [is3 d].
/// Gets or sets a value indicating whether [is3 d].
/// </summary>
/// <value><c>true</c> if [is3 d]; otherwise, <c>false</c>.</value>
public bool Is3D { get; set; }
/// <summary>
/// Gets or sets a value indicating whether this instance is stub.
/// Gets or sets a value indicating whether this instance is stub.
/// </summary>
/// <value><c>true</c> if this instance is stub; otherwise, <c>false</c>.</value>
public bool IsStub { get; set; }
/// <summary>
/// Gets or sets the type of the stub.
/// Gets or sets the type of the stub.
/// </summary>
/// <value>The type of the stub.</value>
public string StubType { get; set; }

View File

@ -9,7 +9,7 @@ namespace Emby.Naming.TV
public static class SeasonPathParser
{
/// <summary>
/// A season folder must contain one of these somewhere in the name.
/// A season folder must contain one of these somewhere in the name.
/// </summary>
private static readonly string[] _seasonFolderNames =
{
@ -41,7 +41,7 @@ namespace Emby.Naming.TV
}
/// <summary>
/// Gets the season number from path.
/// Gets the season number from path.
/// </summary>
/// <param name="path">The path.</param>
/// <param name="supportSpecialAliases">if set to <c>true</c> [support special aliases].</param>

View File

@ -5,13 +5,13 @@ namespace Emby.Naming.TV
public class SeasonPathParserResult
{
/// <summary>
/// Gets or sets the season number.
/// Gets or sets the season number.
/// </summary>
/// <value>The season number.</value>
public int? SeasonNumber { get; set; }
/// <summary>
/// Gets or sets a value indicating whether this <see cref="SeasonPathParserResult" /> is success.
/// Gets or sets a value indicating whether this <see cref="SeasonPathParserResult" /> is success.
/// </summary>
/// <value><c>true</c> if success; otherwise, <c>false</c>.</value>
public bool Success { get; set; }

View File

@ -8,7 +8,7 @@ using System.Text.RegularExpressions;
namespace Emby.Naming.Video
{
/// <summary>
/// <see href="http://kodi.wiki/view/Advancedsettings.xml#video" />.
/// <see href="http://kodi.wiki/view/Advancedsettings.xml#video" />.
/// </summary>
public static class CleanDateTimeParser
{

View File

@ -18,13 +18,13 @@ namespace Emby.Naming.Video
}
/// <summary>
/// Gets the name.
/// Gets the name.
/// </summary>
/// <value>The name.</value>
public string Name { get; }
/// <summary>
/// Gets the year.
/// Gets the year.
/// </summary>
/// <value>The year.</value>
public int? Year { get; }

View File

@ -8,7 +8,7 @@ using System.Text.RegularExpressions;
namespace Emby.Naming.Video
{
/// <summary>
/// <see href="http://kodi.wiki/view/Advancedsettings.xml#video" />.
/// <see href="http://kodi.wiki/view/Advancedsettings.xml#video" />.
/// </summary>
public static class CleanStringParser
{

View File

@ -7,13 +7,13 @@ namespace Emby.Naming.Video
public class ExtraResult
{
/// <summary>
/// Gets or sets the type of the extra.
/// Gets or sets the type of the extra.
/// </summary>
/// <value>The type of the extra.</value>
public ExtraType? ExtraType { get; set; }
/// <summary>
/// Gets or sets the rule.
/// Gets or sets the rule.
/// </summary>
/// <value>The rule.</value>
public ExtraRule Rule { get; set; }

View File

@ -8,25 +8,25 @@ namespace Emby.Naming.Video
public class ExtraRule
{
/// <summary>
/// Gets or sets the token.
/// Gets or sets the token.
/// </summary>
/// <value>The token.</value>
public string Token { get; set; }
/// <summary>
/// Gets or sets the type of the extra.
/// Gets or sets the type of the extra.
/// </summary>
/// <value>The type of the extra.</value>
public ExtraType ExtraType { get; set; }
/// <summary>
/// Gets or sets the type of the rule.
/// Gets or sets the type of the rule.
/// </summary>
/// <value>The type of the rule.</value>
public ExtraRuleType RuleType { get; set; }
/// <summary>
/// Gets or sets the type of the media.
/// Gets or sets the type of the media.
/// </summary>
/// <value>The type of the media.</value>
public MediaType MediaType { get; set; }

View File

@ -5,17 +5,17 @@ namespace Emby.Naming.Video
public enum ExtraRuleType
{
/// <summary>
/// The suffix
/// The suffix
/// </summary>
Suffix = 0,
/// <summary>
/// The filename
/// The filename
/// </summary>
Filename = 1,
/// <summary>
/// The regex
/// The regex
/// </summary>
Regex = 2
}

View File

@ -12,19 +12,19 @@ namespace Emby.Naming.Video
}
/// <summary>
/// Gets or sets a value indicating whether [is3 d].
/// Gets or sets a value indicating whether [is3 d].
/// </summary>
/// <value><c>true</c> if [is3 d]; otherwise, <c>false</c>.</value>
public bool Is3D { get; set; }
/// <summary>
/// Gets or sets the format3 d.
/// Gets or sets the format3 d.
/// </summary>
/// <value>The format3 d.</value>
public string Format3D { get; set; }
/// <summary>
/// Gets or sets the tokens.
/// Gets or sets the tokens.
/// </summary>
/// <value>The tokens.</value>
public List<string> Tokens { get; set; }

View File

@ -5,13 +5,13 @@ namespace Emby.Naming.Video
public class Format3DRule
{
/// <summary>
/// Gets or sets the token.
/// Gets or sets the token.
/// </summary>
/// <value>The token.</value>
public string Token { get; set; }
/// <summary>
/// Gets or sets the preceeding token.
/// Gets or sets the preceeding token.
/// </summary>
/// <value>The preceeding token.</value>
public string PreceedingToken { get; set; }

View File

@ -5,13 +5,13 @@ namespace Emby.Naming.Video
public struct StubResult
{
/// <summary>
/// Gets or sets a value indicating whether this instance is stub.
/// Gets or sets a value indicating whether this instance is stub.
/// </summary>
/// <value><c>true</c> if this instance is stub; otherwise, <c>false</c>.</value>
public bool IsStub { get; set; }
/// <summary>
/// Gets or sets the type of the stub.
/// Gets or sets the type of the stub.
/// </summary>
/// <value>The type of the stub.</value>
public string StubType { get; set; }

View File

@ -5,13 +5,13 @@ namespace Emby.Naming.Video
public class StubTypeRule
{
/// <summary>
/// Gets or sets the token.
/// Gets or sets the token.
/// </summary>
/// <value>The token.</value>
public string Token { get; set; }
/// <summary>
/// Gets or sets the type of the stub.
/// Gets or sets the type of the stub.
/// </summary>
/// <value>The type of the stub.</value>
public string StubType { get; set; }

View File

@ -3,78 +3,78 @@ using MediaBrowser.Model.Entities;
namespace Emby.Naming.Video
{
/// <summary>
/// Represents a single video file.
/// Represents a single video file.
/// </summary>
public class VideoFileInfo
{
/// <summary>
/// Gets or sets the path.
/// Gets or sets the path.
/// </summary>
/// <value>The path.</value>
public string Path { get; set; }
/// <summary>
/// Gets or sets the container.
/// Gets or sets the container.
/// </summary>
/// <value>The container.</value>
public string Container { get; set; }
/// <summary>
/// Gets or sets the name.
/// Gets or sets the name.
/// </summary>
/// <value>The name.</value>
public string Name { get; set; }
/// <summary>
/// Gets or sets the year.
/// Gets or sets the year.
/// </summary>
/// <value>The year.</value>
public int? Year { get; set; }
/// <summary>
/// Gets or sets the type of the extra, e.g. trailer, theme song, behind the scenes, etc.
/// Gets or sets the type of the extra, e.g. trailer, theme song, behind the scenes, etc.
/// </summary>
/// <value>The type of the extra.</value>
public ExtraType? ExtraType { get; set; }
/// <summary>
/// Gets or sets the extra rule.
/// Gets or sets the extra rule.
/// </summary>
/// <value>The extra rule.</value>
public ExtraRule ExtraRule { get; set; }
/// <summary>
/// Gets or sets the format3 d.
/// Gets or sets the format3 d.
/// </summary>
/// <value>The format3 d.</value>
public string Format3D { get; set; }
/// <summary>
/// Gets or sets a value indicating whether [is3 d].
/// Gets or sets a value indicating whether [is3 d].
/// </summary>
/// <value><c>true</c> if [is3 d]; otherwise, <c>false</c>.</value>
public bool Is3D { get; set; }
/// <summary>
/// Gets or sets a value indicating whether this instance is stub.
/// Gets or sets a value indicating whether this instance is stub.
/// </summary>
/// <value><c>true</c> if this instance is stub; otherwise, <c>false</c>.</value>
public bool IsStub { get; set; }
/// <summary>
/// Gets or sets the type of the stub.
/// Gets or sets the type of the stub.
/// </summary>
/// <value>The type of the stub.</value>
public string StubType { get; set; }
/// <summary>
/// Gets or sets a value indicating whether this instance is a directory.
/// Gets or sets a value indicating whether this instance is a directory.
/// </summary>
/// <value>The type.</value>
public bool IsDirectory { get; set; }
/// <summary>
/// Gets the file name without extension.
/// Gets the file name without extension.
/// </summary>
/// <value>The file name without extension.</value>
public string FileNameWithoutExtension => !IsDirectory

View File

@ -4,12 +4,12 @@ using System.Collections.Generic;
namespace Emby.Naming.Video
{
/// <summary>
/// Represents a complete video, including all parts and subtitles.
/// Represents a complete video, including all parts and subtitles.
/// </summary>
public class VideoInfo
{
/// <summary>
/// Initializes a new instance of the <see cref="VideoInfo" /> class.
/// Initializes a new instance of the <see cref="VideoInfo" /> class.
/// </summary>
/// <param name="name">The name.</param>
public VideoInfo(string name)
@ -22,31 +22,31 @@ namespace Emby.Naming.Video
}
/// <summary>
/// Gets or sets the name.
/// Gets or sets the name.
/// </summary>
/// <value>The name.</value>
public string Name { get; set; }
/// <summary>
/// Gets or sets the year.
/// Gets or sets the year.
/// </summary>
/// <value>The year.</value>
public int? Year { get; set; }
/// <summary>
/// Gets or sets the files.
/// Gets or sets the files.
/// </summary>
/// <value>The files.</value>
public IReadOnlyList<VideoFileInfo> Files { get; set; }
/// <summary>
/// Gets or sets the extras.
/// Gets or sets the extras.
/// </summary>
/// <value>The extras.</value>
public IReadOnlyList<VideoFileInfo> Extras { get; set; }
/// <summary>
/// Gets or sets the alternate versions.
/// Gets or sets the alternate versions.
/// </summary>
/// <value>The alternate versions.</value>
public IReadOnlyList<VideoFileInfo> AlternateVersions { get; set; }

View File

@ -18,7 +18,7 @@ namespace Emby.Naming.Video
}
/// <summary>
/// Resolves the directory.
/// Resolves the directory.
/// </summary>
/// <param name="path">The path.</param>
/// <returns>VideoFileInfo.</returns>
@ -28,7 +28,7 @@ namespace Emby.Naming.Video
}
/// <summary>
/// Resolves the file.
/// Resolves the file.
/// </summary>
/// <param name="path">The path.</param>
/// <returns>VideoFileInfo.</returns>
@ -38,7 +38,7 @@ namespace Emby.Naming.Video
}
/// <summary>
/// Resolves the specified path.
/// Resolves the specified path.
/// </summary>
/// <param name="path">The path.</param>
/// <param name="isDirectory">if set to <c>true</c> [is folder].</param>