Skip to content

Commit 978f460

Browse files
committed
fix: update documentation to include full type names for WebSocket and Predicate
1 parent 8816c70 commit 978f460

File tree

3 files changed

+13
-13
lines changed

3 files changed

+13
-13
lines changed

src/KubernetesClient/IStreamDemuxer.cs

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,13 @@ namespace k8s
33
/// <summary>
44
/// <para>
55
/// The <see cref="IStreamDemuxer"/> interface allows you to interact with processes running in a container in a Kubernetes pod. You can start an exec or attach command
6-
/// by calling <see cref="Kubernetes.WebSocketNamespacedPodExecAsync(string, string, IEnumerable{string}, string, bool, bool, bool, bool, Dictionary{string, List{string}}, CancellationToken)"/>
7-
/// or <see cref="Kubernetes.WebSocketNamespacedPodAttachAsync(string, string, string, bool, bool, bool, bool, Dictionary{string, List{string}}, CancellationToken)"/>. These methods
8-
/// will return you a <see cref="WebSocket"/> connection.
6+
/// by calling <see cref="Kubernetes.WebSocketNamespacedPodExecAsync(string, string, IEnumerable{string}, string, bool, bool, bool, bool, string, Dictionary{string, List{string}}, CancellationToken)"/>
7+
/// or <see cref="Kubernetes.WebSocketNamespacedPodAttachAsync(string, string, string, bool, bool, bool, bool, string, Dictionary{string, List{string}}, CancellationToken)"/>. These methods
8+
/// will return you a <see cref="System.Net.WebSockets.WebSocket"/> connection.
99
/// </para>
1010
/// <para>
11-
/// Kubernetes 'multiplexes' multiple channels over this <see cref="WebSocket"/> connection, such as standard input, standard output and standard error. The <see cref="StreamDemuxer"/>
12-
/// allows you to extract individual <see cref="Stream"/>s from this <see cref="WebSocket"/> class. You can then use these streams to send/receive data from that process.
11+
/// Kubernetes 'multiplexes' multiple channels over this <see cref="System.Net.WebSockets.WebSocket"/> connection, such as standard input, standard output and standard error. The <see cref="StreamDemuxer"/>
12+
/// allows you to extract individual <see cref="Stream"/>s from this <see cref="System.Net.WebSockets.WebSocket"/>. You can then use these streams to send/receive data from that process.
1313
/// </para>
1414
/// </summary>
1515
public interface IStreamDemuxer : IDisposable

src/KubernetesClient/Models/ModelExtensions.cs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -208,7 +208,7 @@ public static int FindOwnerReference(this IMetadata<V1ObjectMeta> obj, IKubernet
208208
/// reference could be found.
209209
/// </summary>
210210
/// <param name="obj">the object meta<see cref="V1ObjectMeta"/></param>
211-
/// <param name="predicate">a <see cref="Predicate"/> to test owner reference</param>
211+
/// <param name="predicate">a <see cref="System.Predicate{V1OwnerReference}"/> to test owner reference</param>
212212
/// <returns>the index of the <see cref="V1OwnerReference"/> that matches the given object, or -1 if no such
213213
/// reference could be found.</returns>
214214
public static int FindOwnerReference(this IMetadata<V1ObjectMeta> obj, Predicate<V1OwnerReference> predicate)
@@ -300,7 +300,7 @@ public static V1OwnerReference GetOwnerReference(
300300

301301
/// <summary>Gets the <see cref="V1OwnerReference"/> that matches the given predicate, or null if no matching reference exists.</summary>
302302
/// <param name="obj">the object meta<see cref="V1ObjectMeta"/></param>
303-
/// <param name="predicate">a <see cref="Predicate"/> to test owner reference</param>
303+
/// <param name="predicate">a <see cref="System.Predicate{V1OwnerReference}"/> to test owner reference</param>
304304
/// <returns>the <see cref="V1OwnerReference"/> that matches the given object, or null if no matching reference exists.</returns>
305305
public static V1OwnerReference GetOwnerReference(
306306
this IMetadata<V1ObjectMeta> obj,
@@ -400,7 +400,7 @@ public static V1OwnerReference RemoveOwnerReference(
400400
/// any were removed.
401401
/// </summary>
402402
/// <param name="obj">the object meta<see cref="V1ObjectMeta"/></param>
403-
/// <param name="predicate">a <see cref="Predicate"/> to test owner reference</param>
403+
/// <param name="predicate">a <see cref="System.Predicate{V1OwnerReference}"/> to test owner reference</param>
404404
/// <returns>true if any were removed</returns>
405405
public static bool RemoveOwnerReferences(
406406
this IMetadata<V1ObjectMeta> obj,

src/KubernetesClient/StreamDemuxer.cs

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,13 @@ namespace k8s
77
/// <summary>
88
/// <para>
99
/// The <see cref="StreamDemuxer"/> allows you to interact with processes running in a container in a Kubernetes pod. You can start an exec or attach command
10-
/// by calling <see cref="Kubernetes.WebSocketNamespacedPodExecAsync(string, string, IEnumerable{string}, string, bool, bool, bool, bool, Dictionary{string, List{string}}, CancellationToken)"/>
11-
/// or <see cref="Kubernetes.WebSocketNamespacedPodAttachAsync(string, string, string, bool, bool, bool, bool, Dictionary{string, List{string}}, CancellationToken)"/>. These methods
12-
/// will return you a <see cref="WebSocket"/> connection.
10+
/// by calling <see cref="Kubernetes.WebSocketNamespacedPodExecAsync(string, string, IEnumerable{string}, string, bool, bool, bool, bool, string, Dictionary{string, List{string}}, CancellationToken)"/>
11+
/// or <see cref="Kubernetes.WebSocketNamespacedPodAttachAsync(string, string, string, bool, bool, bool, bool, string, Dictionary{string, List{string}}, CancellationToken)"/>. These methods
12+
/// will return you a <see cref="System.Net.WebSockets.WebSocket"/> connection.
1313
/// </para>
1414
/// <para>
15-
/// Kubernetes 'multiplexes' multiple channels over this <see cref="WebSocket"/> connection, such as standard input, standard output and standard error. The <see cref="StreamDemuxer"/>
16-
/// allows you to extract individual <see cref="Stream"/>s from this <see cref="WebSocket"/> class. You can then use these streams to send/receive data from that process.
15+
/// Kubernetes 'multiplexes' multiple channels over this <see cref="System.Net.WebSockets.WebSocket"/> connection, such as standard input, standard output and standard error. The <see cref="StreamDemuxer"/>
16+
/// allows you to extract individual <see cref="Stream"/>s from this <see cref="System.Net.WebSockets.WebSocket"/>. You can then use these streams to send/receive data from that process.
1717
/// </para>
1818
/// </summary>
1919
public class StreamDemuxer : IStreamDemuxer

0 commit comments

Comments
 (0)