revert xml docs indentation

pull/2667/head
crobibero 5 years ago
parent cb68fbeb0a
commit 261a2e1989

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

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

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

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

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

@ -9,7 +9,7 @@ namespace Emby.Naming.TV
public static class SeasonPathParser public static class SeasonPathParser
{ {
/// <summary> /// <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> /// </summary>
private static readonly string[] _seasonFolderNames = private static readonly string[] _seasonFolderNames =
{ {
@ -41,7 +41,7 @@ namespace Emby.Naming.TV
} }
/// <summary> /// <summary>
/// Gets the season number from path. /// Gets the season number from path.
/// </summary> /// </summary>
/// <param name="path">The path.</param> /// <param name="path">The path.</param>
/// <param name="supportSpecialAliases">if set to <c>true</c> [support special aliases].</param> /// <param name="supportSpecialAliases">if set to <c>true</c> [support special aliases].</param>

@ -5,13 +5,13 @@ namespace Emby.Naming.TV
public class SeasonPathParserResult public class SeasonPathParserResult
{ {
/// <summary> /// <summary>
/// Gets or sets the season number. /// Gets or sets the season number.
/// </summary> /// </summary>
/// <value>The season number.</value> /// <value>The season number.</value>
public int? SeasonNumber { get; set; } public int? SeasonNumber { get; set; }
/// <summary> /// <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> /// </summary>
/// <value><c>true</c> if success; otherwise, <c>false</c>.</value> /// <value><c>true</c> if success; otherwise, <c>false</c>.</value>
public bool Success { get; set; } public bool Success { get; set; }

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

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

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

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

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

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

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

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

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

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

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

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

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

Loading…
Cancel
Save