From f0e87f73649f605e5de76c507780a4e441813eb6 Mon Sep 17 00:00:00 2001 From: Mehrdad Afshari Date: Sun, 7 May 2017 22:42:59 -0700 Subject: [PATCH] doxygenize comment --- .../ext/health_check_service_server_builder_option.h | 2 +- include/grpc++/ext/proto_server_reflection_plugin.h | 4 ++-- include/grpc++/security/server_credentials.h | 11 ++++++----- 3 files changed, 9 insertions(+), 8 deletions(-) diff --git a/include/grpc++/ext/health_check_service_server_builder_option.h b/include/grpc++/ext/health_check_service_server_builder_option.h index a27841af01d..9da8e91cd5a 100644 --- a/include/grpc++/ext/health_check_service_server_builder_option.h +++ b/include/grpc++/ext/health_check_service_server_builder_option.h @@ -44,7 +44,7 @@ namespace grpc { class HealthCheckServiceServerBuilderOption : public ServerBuilderOption { public: - /// The ownership of hc will be taken and transferred to the grpc server. + /// The ownership of \a hc will be taken and transferred to the grpc server. /// To explicitly disable default service, pass in a nullptr. explicit HealthCheckServiceServerBuilderOption( std::unique_ptr hc); diff --git a/include/grpc++/ext/proto_server_reflection_plugin.h b/include/grpc++/ext/proto_server_reflection_plugin.h index 6497bba905c..f4a0eec9868 100644 --- a/include/grpc++/ext/proto_server_reflection_plugin.h +++ b/include/grpc++/ext/proto_server_reflection_plugin.h @@ -59,8 +59,8 @@ class ProtoServerReflectionPlugin : public ::grpc::ServerBuilderPlugin { std::shared_ptr reflection_service_; }; -/// Add proto reflection plugin to ServerBuilder. This function should be called -/// at the static initialization time. +/// Add proto reflection plugin to \a ServerBuilder. +/// This function should be called at the static initialization time. void InitProtoReflectionServerBuilderPlugin(); } // namespace reflection diff --git a/include/grpc++/security/server_credentials.h b/include/grpc++/security/server_credentials.h index 4676b04c5d0..d7720e41e5a 100644 --- a/include/grpc++/security/server_credentials.h +++ b/include/grpc++/security/server_credentials.h @@ -70,7 +70,7 @@ class ServerCredentials { /// Options to create ServerCredentials with SSL struct SslServerCredentialsOptions { - /// Deprecated + /// \warning Deprecated SslServerCredentialsOptions() : force_client_auth(false), client_certificate_request(GRPC_SSL_DONT_REQUEST_CLIENT_CERTIFICATE) {} @@ -84,12 +84,13 @@ struct SslServerCredentialsOptions { }; grpc::string pem_root_certs; std::vector pem_key_cert_pairs; - /// Deprecated + /// \warning Deprecated bool force_client_auth; - /// If both force_client_auth and client_certificate_request fields are set, - /// force_client_auth takes effect i.e - /// REQUEST_AND_REQUIRE_CLIENT_CERTIFICATE_AND_VERIFY will be enforced. + /// If both \a force_client_auth and \a client_certificate_request + /// fields are set, \a force_client_auth takes effect, i.e. + /// \a REQUEST_AND_REQUIRE_CLIENT_CERTIFICATE_AND_VERIFY + /// will be enforced. grpc_ssl_client_certificate_request_type client_certificate_request; };