Merge pull request #5978 from dgquintas/channel_args_docs

small improvements to channel_args docstrings
pull/6020/head
Jan Tattermusch 9 years ago
commit e8e100f38a
  1. 14
      src/core/lib/channel/channel_args.h

@ -37,23 +37,23 @@
#include <grpc/compression.h> #include <grpc/compression.h>
#include <grpc/grpc.h> #include <grpc/grpc.h>
/* Copy some arguments */ /** Copy the arguments in \a src into a new instance */
grpc_channel_args *grpc_channel_args_copy(const grpc_channel_args *src); grpc_channel_args *grpc_channel_args_copy(const grpc_channel_args *src);
/* Copy some arguments, stably sorting keys */ /** Copy the arguments in \a src into a new instance, stably sorting keys */
grpc_channel_args *grpc_channel_args_normalize(const grpc_channel_args *a); grpc_channel_args *grpc_channel_args_normalize(const grpc_channel_args *src);
/** Copy some arguments and add the to_add parameter in the end. /** Copy the arguments in \a src and append \a to_add. If \a to_add is NULL, it
If to_add is NULL, it is equivalent to call grpc_channel_args_copy. */ * is equivalent to calling \a grpc_channel_args_copy. */
grpc_channel_args *grpc_channel_args_copy_and_add(const grpc_channel_args *src, grpc_channel_args *grpc_channel_args_copy_and_add(const grpc_channel_args *src,
const grpc_arg *to_add, const grpc_arg *to_add,
size_t num_to_add); size_t num_to_add);
/** Copy args from a then args from b into a new channel args */ /** Concatenate args from \a a and \a b into a new instance */
grpc_channel_args *grpc_channel_args_merge(const grpc_channel_args *a, grpc_channel_args *grpc_channel_args_merge(const grpc_channel_args *a,
const grpc_channel_args *b); const grpc_channel_args *b);
/** Destroy arguments created by grpc_channel_args_copy */ /** Destroy arguments created by \a grpc_channel_args_copy */
void grpc_channel_args_destroy(grpc_channel_args *a); void grpc_channel_args_destroy(grpc_channel_args *a);
/** Reads census_enabled settings from channel args. Returns 1 if census_enabled /** Reads census_enabled settings from channel args. Returns 1 if census_enabled

Loading…
Cancel
Save