Comments to methods of GRPCChannelConfiguration

1 files changed, 10 insertions, 0 deletions

diff --git a/src/objective-c/GRPCClient/private/GRPCChannelPool.h b/src/objective-c/GRPCClient/private/GRPCChannelPool.h
index e9c2ef2bd1..43e07b9845 100644
--- a/src/objective-c/GRPCClient/private/GRPCChannelPool.h
+++ b/src/objective-c/GRPCClient/private/GRPCChannelPool.h
@@ -29,12 +29,22 @@ NS_ASSUME_NONNULL_BEGIN
 
 @class GRPCChannel;
 
+/** Caching signature of a channel. */
 @interface GRPCChannelConfiguration : NSObject<NSCopying>
 
+/** The host that this channel is connected to. */
 @property(copy, readonly) NSString *host;
+
+/**
+ * Options of the corresponding call. Note that only the channel-related options are of interest to
+ * this class.
+ */
 @property(strong, readonly) GRPCCallOptions *callOptions;
 
+/** Acquire the factory to generate a new channel with current configurations. */
 @property(readonly) id<GRPCChannelFactory> channelFactory;
+
+/** Acquire the dictionary of channel args with current configurations. */
 @property(readonly) NSDictionary *channelArgs;
 
 - (nullable instancetype)initWithHost:(NSString *)host callOptions:(GRPCCallOptions *)callOptions;