Write comments for functions in ChannelArgsUtil

2 files changed, 9 insertions, 7 deletions

diff --git a/src/objective-c/GRPCClient/private/ChannelArgsUtil.h b/src/objective-c/GRPCClient/private/ChannelArgsUtil.h
index d0be484910..3fb876ecc4 100644
--- a/src/objective-c/GRPCClient/private/ChannelArgsUtil.h
+++ b/src/objective-c/GRPCClient/private/ChannelArgsUtil.h
@@ -20,6 +20,15 @@
 
 #include <grpc/impl/codegen/grpc_types.h>
 
+/** Free resources in the grpc core struct grpc_channel_args */
 void GRPCFreeChannelArgs(grpc_channel_args* channel_args);
 
+/**
+ * Allocates a @c grpc_channel_args and populates it with the options specified in the
+ * @c dictionary. Keys must be @c NSString, @c NSNumber, or a pointer. If the value responds to
+ * @c @selector(UTF8String) then it will be mapped to @c GRPC_ARG_STRING. If the value responds to
+ * @c @selector(intValue), it will be mapped to @c GRPC_ARG_INTEGER. Otherwise, if the value is not
+ * nil, it is mapped as a pointer. The caller of this function is responsible for calling
+ * @c GRPCFreeChannelArgs to free the @c grpc_channel_args struct.
+ */
 grpc_channel_args* GRPCBuildChannelArgs(NSDictionary* dictionary);
diff --git a/src/objective-c/GRPCClient/private/ChannelArgsUtil.m b/src/objective-c/GRPCClient/private/ChannelArgsUtil.m
index 8669f79992..b8342a79e7 100644
--- a/src/objective-c/GRPCClient/private/ChannelArgsUtil.m
+++ b/src/objective-c/GRPCClient/private/ChannelArgsUtil.m
@@ -51,13 +51,6 @@ void GRPCFreeChannelArgs(grpc_channel_args *channel_args) {
   gpr_free(channel_args);
 }
 
-/**
- * Allocates a @c grpc_channel_args and populates it with the options specified in the
- * @c dictionary. Keys must be @c NSString. If the value responds to @c @selector(UTF8String) then
- * it will be mapped to @c GRPC_ARG_STRING. If not, it will be mapped to @c GRPC_ARG_INTEGER if the
- * value responds to @c @selector(intValue). Otherwise, an exception will be raised. The caller of
- * this function is responsible for calling @c freeChannelArgs on a non-NULL returned value.
- */
 grpc_channel_args *GRPCBuildChannelArgs(NSDictionary *dictionary) {
   if (!dictionary) {
     return NULL;