Add full stop at end of comments (SA1629)

This commit is contained in:
telans
2020-06-16 10:37:52 +12:00
parent 100e9d586d
commit 9018f8d8be
269 changed files with 816 additions and 816 deletions

View File

@@ -38,7 +38,7 @@ namespace MediaBrowser.Model.Channels
public ChannelMediaContentType[] ContentTypes { get; set; }
/// <summary>
/// Represents the maximum number of records the channel allows retrieving at a time
/// Represents the maximum number of records the channel allows retrieving at a time.
/// </summary>
public int? MaxPageSize { get; set; }

View File

@@ -10,7 +10,7 @@ namespace MediaBrowser.Model.Channels
public class ChannelQuery
{
/// <summary>
/// Fields to return within the items, in addition to basic information
/// Fields to return within the items, in addition to basic information.
/// </summary>
/// <value>The fields.</value>
public ItemFields[] Fields { get; set; }
@@ -34,7 +34,7 @@ namespace MediaBrowser.Model.Channels
public int? StartIndex { get; set; }
/// <summary>
/// The maximum number of items to return
/// The maximum number of items to return.
/// </summary>
/// <value>The limit.</value>
public int? Limit { get; set; }

View File

@@ -12,7 +12,7 @@ namespace MediaBrowser.Model.Configuration
public class BaseApplicationConfiguration
{
/// <summary>
/// The number of days we should retain log files
/// The number of days we should retain log files.
/// </summary>
/// <value>The log file retention days.</value>
public int LogFileRetentionDays { get; set; }

View File

@@ -3,7 +3,7 @@
namespace MediaBrowser.Model.Configuration
{
/// <summary>
/// Enum MetadataPluginType
/// Enum MetadataPluginType.
/// </summary>
public enum MetadataPluginType
{

View File

@@ -111,19 +111,19 @@ namespace MediaBrowser.Model.Configuration
public string MetadataCountryCode { get; set; }
/// <summary>
/// Characters to be replaced with a ' ' in strings to create a sort name
/// Characters to be replaced with a ' ' in strings to create a sort name.
/// </summary>
/// <value>The sort replace characters.</value>
public string[] SortReplaceCharacters { get; set; }
/// <summary>
/// Characters to be removed from strings to create a sort name
/// Characters to be removed from strings to create a sort name.
/// </summary>
/// <value>The sort remove characters.</value>
public string[] SortRemoveCharacters { get; set; }
/// <summary>
/// Words to be removed from strings to create a sort name
/// Words to be removed from strings to create a sort name.
/// </summary>
/// <value>The sort remove words.</value>
public string[] SortRemoveWords { get; set; }

View File

@@ -7,7 +7,7 @@ using Jellyfin.Data.Enums;
namespace MediaBrowser.Model.Configuration
{
/// <summary>
/// Class UserConfiguration
/// Class UserConfiguration.
/// </summary>
public class UserConfiguration
{

View File

@@ -47,7 +47,7 @@ namespace MediaBrowser.Model.Dlna
public int? MaxAudioChannels { get; set; }
/// <summary>
/// The application's configured quality setting
/// The application's configured quality setting.
/// </summary>
public long? MaxBitrate { get; set; }

View File

@@ -465,7 +465,7 @@ namespace MediaBrowser.Model.Dlna
}
/// <summary>
/// Returns the audio stream that will be used
/// Returns the audio stream that will be used.
/// </summary>
public MediaStream TargetAudioStream
{
@@ -481,7 +481,7 @@ namespace MediaBrowser.Model.Dlna
}
/// <summary>
/// Returns the video stream that will be used
/// Returns the video stream that will be used.
/// </summary>
public MediaStream TargetVideoStream
{
@@ -497,7 +497,7 @@ namespace MediaBrowser.Model.Dlna
}
/// <summary>
/// Predicts the audio sample rate that will be in the output stream
/// Predicts the audio sample rate that will be in the output stream.
/// </summary>
public int? TargetAudioSampleRate
{
@@ -509,7 +509,7 @@ namespace MediaBrowser.Model.Dlna
}
/// <summary>
/// Predicts the audio sample rate that will be in the output stream
/// Predicts the audio sample rate that will be in the output stream.
/// </summary>
public int? TargetAudioBitDepth
{
@@ -532,7 +532,7 @@ namespace MediaBrowser.Model.Dlna
}
/// <summary>
/// Predicts the audio sample rate that will be in the output stream
/// Predicts the audio sample rate that will be in the output stream.
/// </summary>
public int? TargetVideoBitDepth
{
@@ -579,7 +579,7 @@ namespace MediaBrowser.Model.Dlna
}
/// <summary>
/// Predicts the audio sample rate that will be in the output stream
/// Predicts the audio sample rate that will be in the output stream.
/// </summary>
public float? TargetFramerate
{
@@ -593,7 +593,7 @@ namespace MediaBrowser.Model.Dlna
}
/// <summary>
/// Predicts the audio sample rate that will be in the output stream
/// Predicts the audio sample rate that will be in the output stream.
/// </summary>
public double? TargetVideoLevel
{
@@ -680,7 +680,7 @@ namespace MediaBrowser.Model.Dlna
}
/// <summary>
/// Predicts the audio sample rate that will be in the output stream
/// Predicts the audio sample rate that will be in the output stream.
/// </summary>
public int? TargetPacketLength
{
@@ -694,7 +694,7 @@ namespace MediaBrowser.Model.Dlna
}
/// <summary>
/// Predicts the audio sample rate that will be in the output stream
/// Predicts the audio sample rate that will be in the output stream.
/// </summary>
public string TargetVideoProfile
{
@@ -732,7 +732,7 @@ namespace MediaBrowser.Model.Dlna
}
/// <summary>
/// Predicts the audio bitrate that will be in the output stream
/// Predicts the audio bitrate that will be in the output stream.
/// </summary>
public int? TargetAudioBitrate
{
@@ -746,7 +746,7 @@ namespace MediaBrowser.Model.Dlna
}
/// <summary>
/// Predicts the audio channels that will be in the output stream
/// Predicts the audio channels that will be in the output stream.
/// </summary>
public int? TargetAudioChannels
{
@@ -787,7 +787,7 @@ namespace MediaBrowser.Model.Dlna
}
/// <summary>
/// Predicts the audio codec that will be in the output stream
/// Predicts the audio codec that will be in the output stream.
/// </summary>
public string[] TargetAudioCodec
{
@@ -840,7 +840,7 @@ namespace MediaBrowser.Model.Dlna
}
/// <summary>
/// Predicts the audio channels that will be in the output stream
/// Predicts the audio channels that will be in the output stream.
/// </summary>
public long? TargetSize
{

View File

@@ -5,22 +5,22 @@ namespace MediaBrowser.Model.Dlna
public enum SubtitleDeliveryMethod
{
/// <summary>
/// The encode
/// The encode.
/// </summary>
Encode = 0,
/// <summary>
/// The embed
/// The embed.
/// </summary>
Embed = 1,
/// <summary>
/// The external
/// The external.
/// </summary>
External = 2,
/// <summary>
/// The HLS
/// The HLS.
/// </summary>
Hls = 3
}

View File

@@ -308,7 +308,7 @@ namespace MediaBrowser.Model.Dto
public int? LocalTrailerCount { get; set; }
/// <summary>
/// User data for this item based on the user it's being requested for
/// User data for this item based on the user it's being requested for.
/// </summary>
/// <value>The user data.</value>
public UserItemDataDto UserData { get; set; }

View File

@@ -61,7 +61,7 @@ namespace MediaBrowser.Model.Dto
/// <summary>
/// Gets or sets the image tag.
/// If set this will result in strong, unconditional response caching
/// If set this will result in strong, unconditional response caching.
/// </summary>
/// <value>The hash.</value>
public string Tag { get; set; }

View File

@@ -28,7 +28,7 @@ namespace MediaBrowser.Model.Dto
public string Name { get; set; }
/// <summary>
/// Differentiate internet url vs local network
/// Differentiate internet url vs local network.
/// </summary>
public bool IsRemote { get; set; }

View File

@@ -104,7 +104,7 @@ namespace MediaBrowser.Model.Entities
public bool ShowSidebar { get; set; }
/// <summary>
/// Gets or sets the client
/// Gets or sets the client.
/// </summary>
public string Client { get; set; }
}

View File

@@ -13,7 +13,7 @@ using MediaBrowser.Model.MediaInfo;
namespace MediaBrowser.Model.Entities
{
/// <summary>
/// Class MediaStream
/// Class MediaStream.
/// </summary>
public class MediaStream
{

View File

@@ -3,28 +3,28 @@
namespace MediaBrowser.Model.Entities
{
/// <summary>
/// Enum MetadataProviders
/// Enum MetadataProviders.
/// </summary>
public enum MetadataProvider
{
/// <summary>
/// The imdb
/// The imdb.
/// </summary>
Imdb = 2,
/// <summary>
/// The TMDB
/// The TMDB.
/// </summary>
Tmdb = 3,
/// <summary>
/// The TVDB
/// The TVDB.
/// </summary>
Tvdb = 4,
/// <summary>
/// The tvcom
/// The tvcom.
/// </summary>
Tvcom = 5,
/// <summary>
/// Tmdb Collection Id
/// Tmdb Collection Id.
/// </summary>
TmdbCollection = 7,
MusicBrainzAlbum = 8,

View File

@@ -7,7 +7,7 @@ using MediaBrowser.Model.Configuration;
namespace MediaBrowser.Model.Entities
{
/// <summary>
/// Used to hold information about a user's list of configured virtual folders
/// Used to hold information about a user's list of configured virtual folders.
/// </summary>
public class VirtualFolderInfo
{

View File

@@ -5,7 +5,7 @@ using System.IO;
namespace MediaBrowser.Model.IO
{
/// <summary>
/// Interface IZipClient
/// Interface IZipClient.
/// </summary>
public interface IZipClient
{

View File

@@ -6,7 +6,7 @@ namespace MediaBrowser.Model.LiveTv
public enum ChannelType
{
/// <summary>
/// The TV
/// The TV.
/// </summary>
TV,

View File

@@ -54,7 +54,7 @@ namespace MediaBrowser.Model.LiveTv
public int? StartIndex { get; set; }
/// <summary>
/// The maximum number of items to return
/// The maximum number of items to return.
/// </summary>
/// <value>The limit.</value>
public int? Limit { get; set; }
@@ -67,13 +67,13 @@ namespace MediaBrowser.Model.LiveTv
public bool EnableUserData { get; set; }
/// <summary>
/// Used to specific whether to return news or not
/// Used to specific whether to return news or not.
/// </summary>
/// <remarks>If set to null, all programs will be returned</remarks>
public bool? IsNews { get; set; }
/// <summary>
/// Used to specific whether to return movies or not
/// Used to specific whether to return movies or not.
/// </summary>
/// <remarks>If set to null, all programs will be returned</remarks>
public bool? IsMovie { get; set; }
@@ -93,7 +93,7 @@ namespace MediaBrowser.Model.LiveTv
public string[] SortBy { get; set; }
/// <summary>
/// The sort order to return results with
/// The sort order to return results with.
/// </summary>
/// <value>The sort order.</value>
public SortOrder? SortOrder { get; set; }

View File

@@ -37,7 +37,7 @@ namespace MediaBrowser.Model.LiveTv
public int? StartIndex { get; set; }
/// <summary>
/// The maximum number of items to return
/// The maximum number of items to return.
/// </summary>
/// <value>The limit.</value>
public int? Limit { get; set; }
@@ -61,7 +61,7 @@ namespace MediaBrowser.Model.LiveTv
public string SeriesTimerId { get; set; }
/// <summary>
/// Fields to return within the items, in addition to basic information
/// Fields to return within the items, in addition to basic information.
/// </summary>
/// <value>The fields.</value>
public ItemFields[] Fields { get; set; }

View File

@@ -7,7 +7,7 @@ namespace MediaBrowser.Model.LiveTv
public class SeriesTimerQuery
{
/// <summary>
/// Gets or sets the sort by - SortName, Priority
/// Gets or sets the sort by - SortName, Priority.
/// </summary>
/// <value>The sort by.</value>
public string? SortBy { get; set; }

View File

@@ -6,27 +6,27 @@ namespace MediaBrowser.Model.Net
public class NetworkShare
{
/// <summary>
/// The name of the computer that this share belongs to
/// The name of the computer that this share belongs to.
/// </summary>
public string Server { get; set; }
/// <summary>
/// Share name
/// Share name.
/// </summary>
public string Name { get; set; }
/// <summary>
/// Local path
/// Local path.
/// </summary>
public string Path { get; set; }
/// <summary>
/// Share type
/// Share type.
/// </summary>
public NetworkShareType ShareType { get; set; }
/// <summary>
/// Comment
/// Comment.
/// </summary>
public string Remark { get; set; }
}

View File

@@ -18,7 +18,7 @@ namespace MediaBrowser.Model.Notifications
public string Type { get; set; }
/// <summary>
/// User Ids to not monitor (it's opt out)
/// User Ids to not monitor (it's opt out).
/// </summary>
public string[] DisabledMonitorUsers { get; set; }

View File

@@ -8,198 +8,198 @@ namespace MediaBrowser.Model.Querying
public enum ItemFields
{
/// <summary>
/// The air time
/// The air time.
/// </summary>
AirTime,
/// <summary>
/// The can delete
/// The can delete.
/// </summary>
CanDelete,
/// <summary>
/// The can download
/// The can download.
/// </summary>
CanDownload,
/// <summary>
/// The channel information
/// The channel information.
/// </summary>
ChannelInfo,
/// <summary>
/// The chapters
/// The chapters.
/// </summary>
Chapters,
ChildCount,
/// <summary>
/// The cumulative run time ticks
/// The cumulative run time ticks.
/// </summary>
CumulativeRunTimeTicks,
/// <summary>
/// The custom rating
/// The custom rating.
/// </summary>
CustomRating,
/// <summary>
/// The date created of the item
/// The date created of the item.
/// </summary>
DateCreated,
/// <summary>
/// The date last media added
/// The date last media added.
/// </summary>
DateLastMediaAdded,
/// <summary>
/// Item display preferences
/// Item display preferences.
/// </summary>
DisplayPreferencesId,
/// <summary>
/// The etag
/// The etag.
/// </summary>
Etag,
/// <summary>
/// The external urls
/// The external urls.
/// </summary>
ExternalUrls,
/// <summary>
/// Genres
/// Genres.
/// </summary>
Genres,
/// <summary>
/// The home page URL
/// The home page URL.
/// </summary>
HomePageUrl,
/// <summary>
/// The item counts
/// The item counts.
/// </summary>
ItemCounts,
/// <summary>
/// The media source count
/// The media source count.
/// </summary>
MediaSourceCount,
/// <summary>
/// The media versions
/// The media versions.
/// </summary>
MediaSources,
OriginalTitle,
/// <summary>
/// The item overview
/// The item overview.
/// </summary>
Overview,
/// <summary>
/// The id of the item's parent
/// The id of the item's parent.
/// </summary>
ParentId,
/// <summary>
/// The physical path of the item
/// The physical path of the item.
/// </summary>
Path,
/// <summary>
/// The list of people for the item
/// The list of people for the item.
/// </summary>
People,
PlayAccess,
/// <summary>
/// The production locations
/// The production locations.
/// </summary>
ProductionLocations,
/// <summary>
/// Imdb, tmdb, etc
/// Imdb, tmdb, etc.
/// </summary>
ProviderIds,
/// <summary>
/// The aspect ratio of the primary image
/// The aspect ratio of the primary image.
/// </summary>
PrimaryImageAspectRatio,
RecursiveItemCount,
/// <summary>
/// The settings
/// The settings.
/// </summary>
Settings,
/// <summary>
/// The screenshot image tags
/// The screenshot image tags.
/// </summary>
ScreenshotImageTags,
SeriesPrimaryImage,
/// <summary>
/// The series studio
/// The series studio.
/// </summary>
SeriesStudio,
/// <summary>
/// The sort name of the item
/// The sort name of the item.
/// </summary>
SortName,
/// <summary>
/// The special episode numbers
/// The special episode numbers.
/// </summary>
SpecialEpisodeNumbers,
/// <summary>
/// The studios of the item
/// The studios of the item.
/// </summary>
Studios,
BasicSyncInfo,
/// <summary>
/// The synchronize information
/// The synchronize information.
/// </summary>
SyncInfo,
/// <summary>
/// The taglines of the item
/// The taglines of the item.
/// </summary>
Taglines,
/// <summary>
/// The tags
/// The tags.
/// </summary>
Tags,
/// <summary>
/// The trailer url of the item
/// The trailer url of the item.
/// </summary>
RemoteTrailers,
/// <summary>
/// The media streams
/// The media streams.
/// </summary>
MediaStreams,
/// <summary>
/// The season user data
/// The season user data.
/// </summary>
SeasonUserData,
/// <summary>
/// The service name
/// The service name.
/// </summary>
ServiceName,
ThemeSongIds,

View File

@@ -3,7 +3,7 @@
namespace MediaBrowser.Model.Querying
{
/// <summary>
/// These represent sort orders that are known by the core
/// These represent sort orders that are known by the core.
/// </summary>
public static class ItemSortBy
{

View File

@@ -33,13 +33,13 @@ namespace MediaBrowser.Model.Querying
public int? StartIndex { get; set; }
/// <summary>
/// The maximum number of items to return
/// The maximum number of items to return.
/// </summary>
/// <value>The limit.</value>
public int? Limit { get; set; }
/// <summary>
/// Fields to return within the items, in addition to basic information
/// Fields to return within the items, in addition to basic information.
/// </summary>
/// <value>The fields.</value>
public ItemFields[] Fields { get; set; }

View File

@@ -15,7 +15,7 @@ namespace MediaBrowser.Model.Querying
public IReadOnlyList<T> Items { get; set; }
/// <summary>
/// The total number of records available
/// The total number of records available.
/// </summary>
/// <value>The total record count.</value>
public int TotalRecordCount { get; set; }

View File

@@ -26,13 +26,13 @@ namespace MediaBrowser.Model.Querying
public int? StartIndex { get; set; }
/// <summary>
/// The maximum number of items to return
/// The maximum number of items to return.
/// </summary>
/// <value>The limit.</value>
public int? Limit { get; set; }
/// <summary>
/// Fields to return within the items, in addition to basic information
/// Fields to return within the items, in addition to basic information.
/// </summary>
/// <value>The fields.</value>
public ItemFields[] Fields { get; set; }

View File

@@ -8,7 +8,7 @@ namespace MediaBrowser.Model.Search
public class SearchQuery
{
/// <summary>
/// The user to localize search results for
/// The user to localize search results for.
/// </summary>
/// <value>The user id.</value>
public Guid UserId { get; set; }
@@ -26,7 +26,7 @@ namespace MediaBrowser.Model.Search
public int? StartIndex { get; set; }
/// <summary>
/// The maximum number of items to return
/// The maximum number of items to return.
/// </summary>
/// <value>The limit.</value>
public int? Limit { get; set; }

View File

@@ -58,7 +58,7 @@ namespace MediaBrowser.Model.Services
public string Route { get; set; }
/// <summary>
/// Whether to exclude this property from being included in the ModelSchema
/// Whether to exclude this property from being included in the ModelSchema.
/// </summary>
public bool ExcludeInSchema { get; set; }
}

View File

@@ -23,7 +23,7 @@ namespace MediaBrowser.Model.Services
string Verb { get; }
/// <summary>
/// The request ContentType
/// The request ContentType.
/// </summary>
string ContentType { get; }
@@ -32,7 +32,7 @@ namespace MediaBrowser.Model.Services
string UserAgent { get; }
/// <summary>
/// The expected Response ContentType for this request
/// The expected Response ContentType for this request.
/// </summary>
string ResponseContentType { get; set; }
@@ -55,7 +55,7 @@ namespace MediaBrowser.Model.Services
string RemoteIp { get; }
/// <summary>
/// The value of the Authorization Header used to send the Api Key, null if not available
/// The value of the Authorization Header used to send the Api Key, null if not available.
/// </summary>
string Authorization { get; }
@@ -68,7 +68,7 @@ namespace MediaBrowser.Model.Services
long ContentLength { get; }
/// <summary>
/// The value of the Referrer, null if not available
/// The value of the Referrer, null if not available.
/// </summary>
Uri UrlReferrer { get; }
}

View File

@@ -7,7 +7,7 @@ namespace MediaBrowser.Model.Services
public interface IRequiresRequestStream
{
/// <summary>
/// The raw Http Request Input Stream
/// The raw Http Request Input Stream.
/// </summary>
Stream RequestStream { get; set; }
}

View File

@@ -7,7 +7,7 @@ using MediaBrowser.Model.Services;
namespace MediaBrowser.Model.Session
{
/// <summary>
/// Class PlayRequest
/// Class PlayRequest.
/// </summary>
public class PlayRequest
{
@@ -19,7 +19,7 @@ namespace MediaBrowser.Model.Session
public Guid[] ItemIds { get; set; }
/// <summary>
/// Gets or sets the start position ticks that the first item should be played at
/// Gets or sets the start position ticks that the first item should be played at.
/// </summary>
/// <value>The start position ticks.</value>
[ApiMember(Name = "StartPositionTicks", Description = "The starting position of the first item.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "POST")]

View File

@@ -5,15 +5,15 @@ namespace MediaBrowser.Model.Sync
public enum SyncCategory
{
/// <summary>
/// The latest
/// The latest.
/// </summary>
Latest = 0,
/// <summary>
/// The next up
/// The next up.
/// </summary>
NextUp = 1,
/// <summary>
/// The resume
/// The resume.
/// </summary>
Resume = 2
}

View File

@@ -23,7 +23,7 @@ namespace MediaBrowser.Model.System
};
/// <summary>
/// Class SystemInfo
/// Class SystemInfo.
/// </summary>
public class SystemInfo : PublicSystemInfo
{

View File

@@ -57,7 +57,7 @@ namespace MediaBrowser.Model.Tasks
double? CurrentProgress { get; }
/// <summary>
/// Gets the triggers that define when the task will run
/// Gets the triggers that define when the task will run.
/// </summary>
/// <value>The triggers.</value>
/// <exception cref="ArgumentNullException">value</exception>

View File

@@ -10,7 +10,7 @@ namespace MediaBrowser.Model.Tasks
public interface ITaskManager : IDisposable
{
/// <summary>
/// Gets the list of Scheduled Tasks
/// Gets the list of Scheduled Tasks.
/// </summary>
/// <value>The scheduled tasks.</value>
IScheduledTaskWorker[] ScheduledTasks { get; }