[GitHub] [pulsar] BewareMyPower commented on a change in pull request #10103: [Doc] Add descriptions for C++ Client API doc (ClientConfiguration.h + ConsumerConfiguration.h + ReaderConfiguration.h)

[GitBox <gi...@apache.org>]

BewareMyPower commented on a change in pull request #10103:
URL: https://github.com/apache/pulsar/pull/10103#discussion_r605415066



##########
File path: pulsar-client-cpp/include/pulsar/ClientConfiguration.h
##########
@@ -142,29 +142,84 @@ class PULSAR_PUBLIC ClientConfiguration {
      */
     ClientConfiguration& setLogger(LoggerFactory* loggerFactory);
 
+    /**
+     * Configure whether to use the TLS encryption on the connections.
+     * <p>
+     * The default value is false.
+     *
+     * @param useTls
+     */
     ClientConfiguration& setUseTls(bool useTls);
+
+    /**
+     * @return whether the TLS encryption is used on the connections
+     */
     bool isUseTls() const;
 
+    /**
+     * Set the path to the trusted TLS certificate file.
+     *
+     * @param tlsTrustCertsFilePath
+     */
     ClientConfiguration& setTlsTrustCertsFilePath(const std::string& tlsTrustCertsFilePath);
+
+    /**
+     * @return the path to the trusted TLS certificate file
+     */
     std::string getTlsTrustCertsFilePath() const;
 
+    /**
+     * Configure whether the Pulsar client accepts untrusted TLS certificates from brokers.
+     * <p>
+     * The default value is false.
+     *
+     * @param tlsAllowInsecureConnection
+     */
     ClientConfiguration& setTlsAllowInsecureConnection(bool allowInsecure);
+
+    /**
+     * @return whether the Pulsar client accepts untrusted TLS certificates from brokers
+     */
     bool isTlsAllowInsecureConnection() const;
 
+    /**
+     * Configure whether it allows validating hostname verification when a client connects to a broker over
+     * TLS. <p> It validates the incoming x509 certificate and matches the provided hostname (CN/SAN) with the

Review comment:
       Please use an empty line to separate the short description and the detail description




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org