Browse Source

fix some documentation periods

telans 5 years ago
parent
commit
8de6452967

+ 1 - 1
Emby.Server.Implementations/Data/SqliteItemRepository.cs

@@ -6308,7 +6308,7 @@ where AncestorIdText not null and ItemValues.Value not null and ItemValues.Type
         /// Gets the attachment.
         /// </summary>
         /// <param name="reader">The reader.</param>
-        /// <returns>MediaAttachment</returns>
+        /// <returns>MediaAttachment.</returns>
         private MediaAttachment GetMediaAttachment(IReadOnlyList<IResultSetValue> reader)
         {
             var item = new MediaAttachment

+ 2 - 2
Emby.Server.Implementations/Library/LibraryManager.cs

@@ -136,7 +136,7 @@ namespace Emby.Server.Implementations.Library
         /// <summary>
         /// Initializes a new instance of the <see cref="LibraryManager" /> class.
         /// </summary>
-        /// <param name="appHost">The application host</param>
+        /// <param name="appHost">The application host.</param>
         /// <param name="logger">The logger.</param>
         /// <param name="taskManager">The task manager.</param>
         /// <param name="userManager">The user manager.</param>
@@ -1793,7 +1793,7 @@ namespace Emby.Server.Implementations.Library
         /// Creates the items.
         /// </summary>
         /// <param name="items">The items.</param>
-        /// <param name="parent">The parent item</param>
+        /// <param name="parent">The parent item.</param>
         /// <param name="cancellationToken">The cancellation token.</param>
         public void CreateItems(IEnumerable<BaseItem> items, BaseItem parent, CancellationToken cancellationToken)
         {

+ 2 - 2
Emby.Server.Implementations/Library/Resolvers/TV/SeasonResolver.cs

@@ -23,8 +23,8 @@ namespace Emby.Server.Implementations.Library.Resolvers.TV
         /// </summary>
         /// <param name="config">The config.</param>
         /// <param name="libraryManager">The library manager.</param>
-        /// <param name="localization">The localization</param>
-        /// <param name="logger">The logger</param>
+        /// <param name="localization">The localization.</param>
+        /// <param name="logger">The logger.</param>
         public SeasonResolver(
             IServerConfigurationManager config,
             ILibraryManager libraryManager,

+ 1 - 1
Emby.Server.Implementations/ScheduledTasks/TaskManager.cs

@@ -95,7 +95,7 @@ namespace Emby.Server.Implementations.ScheduledTasks
         /// Queues the scheduled task.
         /// </summary>
         /// <typeparam name="T"></typeparam>
-        /// <param name="options">Task options</param>
+        /// <param name="options">Task options.</param>
         public void QueueScheduledTask<T>(TaskOptions options)
             where T : IScheduledTask
         {

+ 4 - 4
Jellyfin.Data/Entities/BookMetadata.cs

@@ -29,8 +29,8 @@ namespace Jellyfin.Data.Entities
         /// <summary>
         /// Public constructor with required data.
         /// </summary>
-        /// <param name="title">The title or name of the object</param>
-        /// <param name="language">ISO-639-3 3-character language codes</param>
+        /// <param name="title">The title or name of the object.</param>
+        /// <param name="language">ISO-639-3 3-character language codes.</param>
         /// <param name="_book0"></param>
         public BookMetadata(string title, string language, DateTime dateadded, DateTime datemodified, Book _book0)
         {
@@ -51,8 +51,8 @@ namespace Jellyfin.Data.Entities
         /// <summary>
         /// Static create function (for use in LINQ queries, etc.)
         /// </summary>
-        /// <param name="title">The title or name of the object</param>
-        /// <param name="language">ISO-639-3 3-character language codes</param>
+        /// <param name="title">The title or name of the object.</param>
+        /// <param name="language">ISO-639-3 3-character language codes.</param>
         /// <param name="_book0"></param>
         public static BookMetadata Create(string title, string language, DateTime dateadded, DateTime datemodified, Book _book0)
         {

+ 2 - 2
Jellyfin.Data/Entities/Chapter.cs

@@ -27,7 +27,7 @@ namespace Jellyfin.Data.Entities
         /// <summary>
         /// Public constructor with required data.
         /// </summary>
-        /// <param name="language">ISO-639-3 3-character language codes</param>
+        /// <param name="language">ISO-639-3 3-character language codes.</param>
         /// <param name="timestart"></param>
         /// <param name="_release0"></param>
         public Chapter(string language, long timestart, Release _release0)
@@ -47,7 +47,7 @@ namespace Jellyfin.Data.Entities
         /// <summary>
         /// Static create function (for use in LINQ queries, etc.)
         /// </summary>
-        /// <param name="language">ISO-639-3 3-character language codes</param>
+        /// <param name="language">ISO-639-3 3-character language codes.</param>
         /// <param name="timestart"></param>
         /// <param name="_release0"></param>
         public static Chapter Create(string language, long timestart, Release _release0)

+ 4 - 4
Jellyfin.Data/Entities/CompanyMetadata.cs

@@ -26,8 +26,8 @@ namespace Jellyfin.Data.Entities
         /// <summary>
         /// Public constructor with required data.
         /// </summary>
-        /// <param name="title">The title or name of the object</param>
-        /// <param name="language">ISO-639-3 3-character language codes</param>
+        /// <param name="title">The title or name of the object.</param>
+        /// <param name="language">ISO-639-3 3-character language codes.</param>
         /// <param name="_company0"></param>
         public CompanyMetadata(string title, string language, DateTime dateadded, DateTime datemodified, Company _company0)
         {
@@ -47,8 +47,8 @@ namespace Jellyfin.Data.Entities
         /// <summary>
         /// Static create function (for use in LINQ queries, etc.)
         /// </summary>
-        /// <param name="title">The title or name of the object</param>
-        /// <param name="language">ISO-639-3 3-character language codes</param>
+        /// <param name="title">The title or name of the object.</param>
+        /// <param name="language">ISO-639-3 3-character language codes.</param>
         /// <param name="_company0"></param>
         public static CompanyMetadata Create(string title, string language, DateTime dateadded, DateTime datemodified, Company _company0)
         {

+ 4 - 4
Jellyfin.Data/Entities/CustomItemMetadata.cs

@@ -25,8 +25,8 @@ namespace Jellyfin.Data.Entities
         /// <summary>
         /// Public constructor with required data.
         /// </summary>
-        /// <param name="title">The title or name of the object</param>
-        /// <param name="language">ISO-639-3 3-character language codes</param>
+        /// <param name="title">The title or name of the object.</param>
+        /// <param name="language">ISO-639-3 3-character language codes.</param>
         /// <param name="_customitem0"></param>
         public CustomItemMetadata(string title, string language, DateTime dateadded, DateTime datemodified, CustomItem _customitem0)
         {
@@ -46,8 +46,8 @@ namespace Jellyfin.Data.Entities
         /// <summary>
         /// Static create function (for use in LINQ queries, etc.)
         /// </summary>
-        /// <param name="title">The title or name of the object</param>
-        /// <param name="language">ISO-639-3 3-character language codes</param>
+        /// <param name="title">The title or name of the object.</param>
+        /// <param name="language">ISO-639-3 3-character language codes.</param>
         /// <param name="_customitem0"></param>
         public static CustomItemMetadata Create(string title, string language, DateTime dateadded, DateTime datemodified, CustomItem _customitem0)
         {

+ 4 - 4
Jellyfin.Data/Entities/EpisodeMetadata.cs

@@ -26,8 +26,8 @@ namespace Jellyfin.Data.Entities
         /// <summary>
         /// Public constructor with required data.
         /// </summary>
-        /// <param name="title">The title or name of the object</param>
-        /// <param name="language">ISO-639-3 3-character language codes</param>
+        /// <param name="title">The title or name of the object.</param>
+        /// <param name="language">ISO-639-3 3-character language codes.</param>
         /// <param name="_episode0"></param>
         public EpisodeMetadata(string title, string language, DateTime dateadded, DateTime datemodified, Episode _episode0)
         {
@@ -47,8 +47,8 @@ namespace Jellyfin.Data.Entities
         /// <summary>
         /// Static create function (for use in LINQ queries, etc.)
         /// </summary>
-        /// <param name="title">The title or name of the object</param>
-        /// <param name="language">ISO-639-3 3-character language codes</param>
+        /// <param name="title">The title or name of the object.</param>
+        /// <param name="language">ISO-639-3 3-character language codes.</param>
         /// <param name="_episode0"></param>
         public static EpisodeMetadata Create(string title, string language, DateTime dateadded, DateTime datemodified, Episode _episode0)
         {

+ 1 - 1
Jellyfin.Data/Entities/Group.cs

@@ -99,7 +99,7 @@ namespace Jellyfin.Data.Entities
         /// <summary>
         /// Static create function (for use in LINQ queries, etc.)
         /// </summary>
-        /// <param name="name">The name of this group</param>
+        /// <param name="name">The name of this group.</param>
         public static Group Create(string name)
         {
             return new Group(name);

+ 2 - 2
Jellyfin.Data/Entities/LibraryRoot.cs

@@ -27,7 +27,7 @@ namespace Jellyfin.Data.Entities
         /// <summary>
         /// Public constructor with required data.
         /// </summary>
-        /// <param name="path">Absolute Path</param>
+        /// <param name="path">Absolute Path.</param>
         public LibraryRoot(string path)
         {
             if (string.IsNullOrEmpty(path)) throw new ArgumentNullException(nameof(path));
@@ -40,7 +40,7 @@ namespace Jellyfin.Data.Entities
         /// <summary>
         /// Static create function (for use in LINQ queries, etc.)
         /// </summary>
-        /// <param name="path">Absolute Path</param>
+        /// <param name="path">Absolute Path.</param>
         public static LibraryRoot Create(string path)
         {
             return new LibraryRoot(path);

+ 2 - 2
Jellyfin.Data/Entities/MediaFile.cs

@@ -30,7 +30,7 @@ namespace Jellyfin.Data.Entities
         /// <summary>
         /// Public constructor with required data.
         /// </summary>
-        /// <param name="path">Relative to the LibraryRoot</param>
+        /// <param name="path">Relative to the LibraryRoot.</param>
         /// <param name="kind"></param>
         /// <param name="_release0"></param>
         public MediaFile(string path, Enums.MediaFileKind kind, Release _release0)
@@ -51,7 +51,7 @@ namespace Jellyfin.Data.Entities
         /// <summary>
         /// Static create function (for use in LINQ queries, etc.)
         /// </summary>
-        /// <param name="path">Relative to the LibraryRoot</param>
+        /// <param name="path">Relative to the LibraryRoot.</param>
         /// <param name="kind"></param>
         /// <param name="_release0"></param>
         public static MediaFile Create(string path, Enums.MediaFileKind kind, Release _release0)

+ 2 - 2
Jellyfin.Data/Entities/Metadata.cs

@@ -26,8 +26,8 @@ namespace Jellyfin.Data.Entities
         /// <summary>
         /// Public constructor with required data.
         /// </summary>
-        /// <param name="title">The title or name of the object</param>
-        /// <param name="language">ISO-639-3 3-character language codes</param>
+        /// <param name="title">The title or name of the object.</param>
+        /// <param name="language">ISO-639-3 3-character language codes.</param>
         protected Metadata(string title, string language, DateTime dateadded, DateTime datemodified)
         {
             if (string.IsNullOrEmpty(title)) throw new ArgumentNullException(nameof(title));

+ 4 - 4
Jellyfin.Data/Entities/MovieMetadata.cs

@@ -30,8 +30,8 @@ namespace Jellyfin.Data.Entities
         /// <summary>
         /// Public constructor with required data.
         /// </summary>
-        /// <param name="title">The title or name of the object</param>
-        /// <param name="language">ISO-639-3 3-character language codes</param>
+        /// <param name="title">The title or name of the object.</param>
+        /// <param name="language">ISO-639-3 3-character language codes.</param>
         /// <param name="_movie0"></param>
         public MovieMetadata(string title, string language, DateTime dateadded, DateTime datemodified, Movie _movie0)
         {
@@ -52,8 +52,8 @@ namespace Jellyfin.Data.Entities
         /// <summary>
         /// Static create function (for use in LINQ queries, etc.)
         /// </summary>
-        /// <param name="title">The title or name of the object</param>
-        /// <param name="language">ISO-639-3 3-character language codes</param>
+        /// <param name="title">The title or name of the object.</param>
+        /// <param name="language">ISO-639-3 3-character language codes.</param>
         /// <param name="_movie0"></param>
         public static MovieMetadata Create(string title, string language, DateTime dateadded, DateTime datemodified, Movie _movie0)
         {

+ 4 - 4
Jellyfin.Data/Entities/MusicAlbumMetadata.cs

@@ -30,8 +30,8 @@ namespace Jellyfin.Data.Entities
         /// <summary>
         /// Public constructor with required data.
         /// </summary>
-        /// <param name="title">The title or name of the object</param>
-        /// <param name="language">ISO-639-3 3-character language codes</param>
+        /// <param name="title">The title or name of the object.</param>
+        /// <param name="language">ISO-639-3 3-character language codes.</param>
         /// <param name="_musicalbum0"></param>
         public MusicAlbumMetadata(string title, string language, DateTime dateadded, DateTime datemodified, MusicAlbum _musicalbum0)
         {
@@ -52,8 +52,8 @@ namespace Jellyfin.Data.Entities
         /// <summary>
         /// Static create function (for use in LINQ queries, etc.)
         /// </summary>
-        /// <param name="title">The title or name of the object</param>
-        /// <param name="language">ISO-639-3 3-character language codes</param>
+        /// <param name="title">The title or name of the object.</param>
+        /// <param name="language">ISO-639-3 3-character language codes.</param>
         /// <param name="_musicalbum0"></param>
         public static MusicAlbumMetadata Create(string title, string language, DateTime dateadded, DateTime datemodified, MusicAlbum _musicalbum0)
         {

+ 4 - 4
Jellyfin.Data/Entities/PhotoMetadata.cs

@@ -26,8 +26,8 @@ namespace Jellyfin.Data.Entities
         /// <summary>
         /// Public constructor with required data.
         /// </summary>
-        /// <param name="title">The title or name of the object</param>
-        /// <param name="language">ISO-639-3 3-character language codes</param>
+        /// <param name="title">The title or name of the object.</param>
+        /// <param name="language">ISO-639-3 3-character language codes.</param>
         /// <param name="_photo0"></param>
         public PhotoMetadata(string title, string language, DateTime dateadded, DateTime datemodified, Photo _photo0)
         {
@@ -47,8 +47,8 @@ namespace Jellyfin.Data.Entities
         /// <summary>
         /// Static create function (for use in LINQ queries, etc.)
         /// </summary>
-        /// <param name="title">The title or name of the object</param>
-        /// <param name="language">ISO-639-3 3-character language codes</param>
+        /// <param name="title">The title or name of the object.</param>
+        /// <param name="language">ISO-639-3 3-character language codes.</param>
         /// <param name="_photo0"></param>
         public static PhotoMetadata Create(string title, string language, DateTime dateadded, DateTime datemodified, Photo _photo0)
         {

+ 4 - 4
Jellyfin.Data/Entities/SeasonMetadata.cs

@@ -27,8 +27,8 @@ namespace Jellyfin.Data.Entities
         /// <summary>
         /// Public constructor with required data.
         /// </summary>
-        /// <param name="title">The title or name of the object</param>
-        /// <param name="language">ISO-639-3 3-character language codes</param>
+        /// <param name="title">The title or name of the object.</param>
+        /// <param name="language">ISO-639-3 3-character language codes.</param>
         /// <param name="_season0"></param>
         public SeasonMetadata(string title, string language, DateTime dateadded, DateTime datemodified, Season _season0)
         {
@@ -48,8 +48,8 @@ namespace Jellyfin.Data.Entities
         /// <summary>
         /// Static create function (for use in LINQ queries, etc.)
         /// </summary>
-        /// <param name="title">The title or name of the object</param>
-        /// <param name="language">ISO-639-3 3-character language codes</param>
+        /// <param name="title">The title or name of the object.</param>
+        /// <param name="language">ISO-639-3 3-character language codes.</param>
         /// <param name="_season0"></param>
         public static SeasonMetadata Create(string title, string language, DateTime dateadded, DateTime datemodified, Season _season0)
         {

+ 4 - 4
Jellyfin.Data/Entities/SeriesMetadata.cs

@@ -30,8 +30,8 @@ namespace Jellyfin.Data.Entities
         /// <summary>
         /// Public constructor with required data.
         /// </summary>
-        /// <param name="title">The title or name of the object</param>
-        /// <param name="language">ISO-639-3 3-character language codes</param>
+        /// <param name="title">The title or name of the object.</param>
+        /// <param name="language">ISO-639-3 3-character language codes.</param>
         /// <param name="_series0"></param>
         public SeriesMetadata(string title, string language, DateTime dateadded, DateTime datemodified, Series _series0)
         {
@@ -52,8 +52,8 @@ namespace Jellyfin.Data.Entities
         /// <summary>
         /// Static create function (for use in LINQ queries, etc.)
         /// </summary>
-        /// <param name="title">The title or name of the object</param>
-        /// <param name="language">ISO-639-3 3-character language codes</param>
+        /// <param name="title">The title or name of the object.</param>
+        /// <param name="language">ISO-639-3 3-character language codes.</param>
         /// <param name="_series0"></param>
         public static SeriesMetadata Create(string title, string language, DateTime dateadded, DateTime datemodified, Series _series0)
         {

+ 4 - 4
Jellyfin.Data/Entities/TrackMetadata.cs

@@ -26,8 +26,8 @@ namespace Jellyfin.Data.Entities
         /// <summary>
         /// Public constructor with required data.
         /// </summary>
-        /// <param name="title">The title or name of the object</param>
-        /// <param name="language">ISO-639-3 3-character language codes</param>
+        /// <param name="title">The title or name of the object.</param>
+        /// <param name="language">ISO-639-3 3-character language codes.</param>
         /// <param name="_track0"></param>
         public TrackMetadata(string title, string language, DateTime dateadded, DateTime datemodified, Track _track0)
         {
@@ -47,8 +47,8 @@ namespace Jellyfin.Data.Entities
         /// <summary>
         /// Static create function (for use in LINQ queries, etc.)
         /// </summary>
-        /// <param name="title">The title or name of the object</param>
-        /// <param name="language">ISO-639-3 3-character language codes</param>
+        /// <param name="title">The title or name of the object.</param>
+        /// <param name="language">ISO-639-3 3-character language codes.</param>
         /// <param name="_track0"></param>
         public static TrackMetadata Create(string title, string language, DateTime dateadded, DateTime datemodified, Track _track0)
         {

+ 3 - 3
MediaBrowser.Controller/Drawing/IImageProcessor.cs

@@ -30,7 +30,7 @@ namespace MediaBrowser.Controller.Drawing
         /// Gets the dimensions of the image.
         /// </summary>
         /// <param name="path">Path to the image file.</param>
-        /// <returns>ImageDimensions</returns>
+        /// <returns>ImageDimensions.</returns>
         ImageDimensions GetImageDimensions(string path);
 
         /// <summary>
@@ -38,14 +38,14 @@ namespace MediaBrowser.Controller.Drawing
         /// </summary>
         /// <param name="item">The base item.</param>
         /// <param name="info">The information.</param>
-        /// <returns>ImageDimensions</returns>
+        /// <returns>ImageDimensions.</returns>
         ImageDimensions GetImageDimensions(BaseItem item, ItemImageInfo info);
 
         /// <summary>
         /// Gets the blurhash of the image.
         /// </summary>
         /// <param name="path">Path to the image file.</param>
-        /// <returns>BlurHash</returns>
+        /// <returns>BlurHash.</returns>
         string GetImageBlurHash(string path);
 
         /// <summary>

+ 1 - 1
MediaBrowser.Controller/Entities/BaseItem.cs

@@ -1371,7 +1371,7 @@ namespace MediaBrowser.Controller.Entities
         /// </summary>
         /// <param name="options">The options.</param>
         /// <param name="cancellationToken">The cancellation token.</param>
-        /// <returns>true if a provider reports we changed</returns>
+        /// <returns>true if a provider reports we changed.</returns>
         public async Task<ItemUpdateType> RefreshMetadata(MetadataRefreshOptions options, CancellationToken cancellationToken)
         {
             TriggerOnRefreshStart();

+ 3 - 3
MediaBrowser.Controller/Net/AuthenticatedAttribute.cs

@@ -31,9 +31,9 @@ namespace MediaBrowser.Controller.Net
         /// <summary>
         /// The request filter is executed before the service.
         /// </summary>
-        /// <param name="request">The http request wrapper</param>
-        /// <param name="response">The http response wrapper</param>
-        /// <param name="requestDto">The request DTO</param>
+        /// <param name="request">The http request wrapper.</param>
+        /// <param name="response">The http response wrapper.</param>
+        /// <param name="requestDto">The request DTO.</param>
         public void RequestFilter(IRequest request, HttpResponse response, object requestDto)
         {
             AuthService.Authenticate(request, this);

+ 1 - 1
MediaBrowser.Controller/Net/SecurityException.cs

@@ -27,7 +27,7 @@ namespace MediaBrowser.Controller.Net
         /// <summary>
         /// Initializes a new instance of the <see cref="SecurityException"/> class.
         /// </summary>
-        /// <param name="message">The message that describes the error</param>
+        /// <param name="message">The message that describes the error.</param>
         /// <param name="innerException">The exception that is the cause of the current exception, or a null reference if no inner exception is specified.</param>
         public SecurityException(string message, Exception innerException)
             : base(message, innerException)

+ 1 - 1
MediaBrowser.MediaEncoding/Encoder/MediaEncoder.cs

@@ -166,7 +166,7 @@ namespace MediaBrowser.MediaEncoding.Encoder
         /// Validates the supplied FQPN to ensure it is a ffmpeg utility.
         /// If checks pass, global variable FFmpegPath and EncoderLocation are updated.
         /// </summary>
-        /// <param name="path">FQPN to test</param>
+        /// <param name="path">FQPN to test.</param>
         /// <param name="location">Location (External, Custom, System) of tool</param>
         /// <returns></returns>
         private bool ValidatePath(string path, FFmpegLocation location)

+ 2 - 2
MediaBrowser.Model/Services/QueryParamCollection.cs

@@ -124,8 +124,8 @@ namespace MediaBrowser.Model.Services
         /// Gets or sets a query parameter value by name. A query may contain multiple values of the same name
         /// (i.e. "x=1&amp;x=2"), in which case the value is an array, which works for both getting and setting.
         /// </summary>
-        /// <param name="name">The query parameter name</param>
-        /// <returns>The query parameter value or array of values</returns>
+        /// <param name="name">The query parameter name.</param>
+        /// <returns>The query parameter value or array of values.</returns>
         public string this[string name]
         {
             get => Get(name);

+ 1 - 1
MediaBrowser.Providers/Plugins/Tmdb/Movies/TmdbMovieProvider.cs

@@ -312,7 +312,7 @@ namespace MediaBrowser.Providers.Plugins.Tmdb.Movies
         /// <param name="id">The id.</param>
         /// <param name="isTmdbId">if set to <c>true</c> [is TMDB identifier].</param>
         /// <param name="language">The language.</param>
-        /// <param name="cancellationToken">The cancellation token</param>
+        /// <param name="cancellationToken">The cancellation token.</param>
         /// <returns>Task{CompleteMovieData}.</returns>
         internal async Task<MovieResult> FetchMainResult(string id, bool isTmdbId, string language, CancellationToken cancellationToken)
         {