diff options
| author |  Mehrdad Afshari <mmx@google.com> | 2017-05-07 22:42:59 -0700 |
|---|---|---|
| committer |  Mehrdad Afshari <mehrdad@afshari.me> | 2017-05-17 23:30:09 -0700 |
| commit | f0e87f73649f605e5de76c507780a4e441813eb6 (patch) | |
| tree | 154d335aff868e3a4c4faa62c1c92ad17ea1c943 /include/grpc++/security | |
| parent | 6f07e3aa42f8f3d61c24d6f7ee314f70c3994e87 (diff) | |
doxygenize comment
Diffstat (limited to 'include/grpc++/security')
| -rw-r--r-- | include/grpc++/security/server_credentials.h | 11 |
1 files changed, 6 insertions, 5 deletions
diff --git a/include/grpc++/security/server_credentials.h b/include/grpc++/security/server_credentials.h index 4676b04c5d..d7720e41e5 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<PemKeyCertPair> 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; }; |