diff options
| author | reuterma24 <martinreuter24@googlemail.com> | 2025-01-12 18:54:19 +0100 |
|---|---|---|
| committer | reuterma24 <martinreuter24@googlemail.com> | 2025-01-12 18:54:19 +0100 |
| commit | fdb489ae477bfac2ad738227e9d5ea657f4fc395 (patch) | |
| tree | 256c8bc6398458616029c5fd2a3eba8d43a39ff1 | |
| parent | fb5da641f418f5e696d3d021fa3638bde456e981 (diff) | |
improve parameter documentation for ContainsContainer method in ContainerHelper class
| -rw-r--r-- | MediaBrowser.Model/Extensions/ContainerHelper.cs | 15 |
1 files changed, 10 insertions, 5 deletions
diff --git a/MediaBrowser.Model/Extensions/ContainerHelper.cs b/MediaBrowser.Model/Extensions/ContainerHelper.cs index c86328ba6..39e5358ba 100644 --- a/MediaBrowser.Model/Extensions/ContainerHelper.cs +++ b/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> |