浏览代码

Merge pull request #13360 from reuterma24/doc-improvement-container-helper

improve documentation for ContainerHelper class
Bond-009 5 月之前
父节点
当前提交
13c9880100
共有 2 个文件被更改,包括 11 次插入5 次删除
  1. 1 0
      CONTRIBUTORS.md
  2. 10 5
      MediaBrowser.Model/Extensions/ContainerHelper.cs

+ 1 - 0
CONTRIBUTORS.md

@@ -268,3 +268,4 @@
  - [0x25CBFC4F](https://github.com/0x25CBFC4F)
  - [Robert Lützner](https://github.com/rluetzner)
  - [Nathan McCrina](https://github.com/nfmccrina)
+ - [Martin Reuter](https://github.com/reuterma24)

+ 10 - 5
MediaBrowser.Model/Extensions/ContainerHelper.cs

@@ -14,7 +14,8 @@ public static class ContainerHelper
     /// in <paramref name="profileContainers"/>.
     /// </summary>
     /// <param name="profileContainers">The comma-delimited string being searched.
-    /// If the parameter begins with the <c>-</c> character, the operation is reversed.</param>
+    /// If the parameter begins with the <c>-</c> character, the operation is reversed.
+    /// If the parameter is empty or null, all containers in <paramref name="inputContainer"/> will be accepted.</param>
     /// <param name="inputContainer">The comma-delimited string being matched.</param>
     /// <returns>The result of the operation.</returns>
     public static bool ContainsContainer(string? profileContainers, string? inputContainer)
@@ -34,7 +35,8 @@ public static class ContainerHelper
     /// in <paramref name="profileContainers"/>.
     /// </summary>
     /// <param name="profileContainers">The comma-delimited string being searched.
-    /// If the parameter begins with the <c>-</c> character, the operation is reversed.</param>
+    /// If the parameter begins with the <c>-</c> character, the operation is reversed.
+    /// If the parameter is empty or null, all containers in <paramref name="inputContainer"/> will be accepted.</param>
     /// <param name="inputContainer">The comma-delimited string being matched.</param>
     /// <returns>The result of the operation.</returns>
     public static bool ContainsContainer(string? profileContainers, ReadOnlySpan<char> inputContainer)
@@ -53,7 +55,8 @@ public static class ContainerHelper
     /// Compares two containers, returning <paramref name="isNegativeList"/> if an item in <paramref name="inputContainer"/>
     /// does not exist in <paramref name="profileContainers"/>.
     /// </summary>
-    /// <param name="profileContainers">The comma-delimited string being searched.</param>
+    /// <param name="profileContainers">The comma-delimited string being searched.
+    /// If the parameter is empty or null, all containers in <paramref name="inputContainer"/> will be accepted.</param>
     /// <param name="isNegativeList">The boolean result to return if a match is not found.</param>
     /// <param name="inputContainer">The comma-delimited string being matched.</param>
     /// <returns>The result of the operation.</returns>
@@ -71,7 +74,8 @@ public static class ContainerHelper
     /// Compares two containers, returning <paramref name="isNegativeList"/> if an item in <paramref name="inputContainer"/>
     /// does not exist in <paramref name="profileContainers"/>.
     /// </summary>
-    /// <param name="profileContainers">The comma-delimited string being searched.</param>
+    /// <param name="profileContainers">The comma-delimited string being searched.
+    /// If the parameter is empty or null, all containers in <paramref name="inputContainer"/> will be accepted.</param>
     /// <param name="isNegativeList">The boolean result to return if a match is not found.</param>
     /// <param name="inputContainer">The comma-delimited string being matched.</param>
     /// <returns>The result of the operation.</returns>
@@ -106,7 +110,8 @@ public static class ContainerHelper
     /// Compares two containers, returning <paramref name="isNegativeList"/> if an item in <paramref name="inputContainer"/>
     /// does not exist in <paramref name="profileContainers"/>.
     /// </summary>
-    /// <param name="profileContainers">The profile containers being matched searched.</param>
+    /// <param name="profileContainers">The profile containers being matched searched.
+    /// If the parameter is empty or null, all containers in <paramref name="inputContainer"/> will be accepted.</param>
     /// <param name="isNegativeList">The boolean result to return if a match is not found.</param>
     /// <param name="inputContainer">The comma-delimited string being matched.</param>
     /// <returns>The result of the operation.</returns>