This is an automated email from the ASF dual-hosted git repository.
laiyingchun pushed a commit to branch branch-1.17.x
in repository https://gitbox.apache.org/repos/asf/kudu.git
The following commit(s) were added to refs/heads/branch-1.17.x by this push:
new 1857b99b1 [client] fix doxygen warnings
1857b99b1 is described below
commit 1857b99b1a9f6240f04fe1234a9c7a942c56b428
Author: Alexey Serbin <[email protected]>
AuthorDate: Wed Aug 30 15:02:19 2023 -0700
[client] fix doxygen warnings
This patch should help at least with follow-up Kudu releases while
building doxygen documentation for the C++ client.
This patch doesn't contain any functional modifications.
Change-Id: I440d4f79ccd1b7e4f852cdf423727245e84e8d56
Reviewed-on: http://gerrit.cloudera.org:8080/20441
Tested-by: Kudu Jenkins
Reviewed-by: Mahesh Reddy <[email protected]>
Reviewed-by: Abhishek Chennaka <[email protected]>
(cherry picked from commit 63ca4b5b43e8552f5408efbe43e7915b2f375b70)
Reviewed-on: http://gerrit.cloudera.org:8080/20446
Reviewed-by: Yifan Zhang <[email protected]>
Tested-by: Yingchun Lai <[email protected]>
---
docs/support/doxygen/client_api.doxy.in | 13 +++++++++++++
src/kudu/client/client.h | 22 +++++++++++++++-------
src/kudu/client/write_op.h | 2 ++
3 files changed, 30 insertions(+), 7 deletions(-)
diff --git a/docs/support/doxygen/client_api.doxy.in
b/docs/support/doxygen/client_api.doxy.in
index c438bf591..df783a3ba 100644
--- a/docs/support/doxygen/client_api.doxy.in
+++ b/docs/support/doxygen/client_api.doxy.in
@@ -43,6 +43,19 @@ RECURSIVE = YES
# in those anyway.
EXCLUDE = @DOXY_CLIENT_API_EXCLUDE@
+# Enable pre-processing and macro expansion in doxygen (both are turned off
+# by default otherwise), but expand only macros that specified by the
+# PREDEFINED configuration parameter below. As of now, that's to simplify the
+# signatures of the documented methods that otherwise might be interpreted
+# in a wrong way by doxygen. This recipe is documented at least at
+# https://www.doxygen.nl/manual/preprocessing.html
+ENABLE_PREPROCESSING = YES
+MACRO_EXPANSION = YES
+EXPAND_ONLY_PREDEF = YES
+
+# Below is the list of macros to be expanded by a custom way by doxygen.
+PREDEFINED = ATTRIBUTE_DEPRECATED(x):=
+
# We add information about the Kudu version the documentation is generated for.
# NOTE: this tag requires GENERATE_HTML enabled.
HTML_FOOTER = @DOXY_CLIENT_API_FOOTER@
diff --git a/src/kudu/client/client.h b/src/kudu/client/client.h
index c615a4f3b..c33a8bbd3 100644
--- a/src/kudu/client/client.h
+++ b/src/kudu/client/client.h
@@ -332,8 +332,9 @@ class KUDU_EXPORT KuduClientBuilder {
/// Add a trusted root CA certificate into the client's TLS certificate
bundle.
///
- /// @param [in] cert_pem_str
+ /// @param [in] cert_pem
/// The trusted certificate to add, in PEM format.
+ /// @return Reference to the updated object.
KuduClientBuilder& trusted_certificate(const std::string& cert_pem);
/// @brief Set the number of reactors for the RPC messenger.
@@ -711,7 +712,7 @@ class KUDU_EXPORT KuduClient : public
sp::enable_shared_from_this<KuduClient> {
/// The delete operation or drop operation means that the service will
directly
/// delete the table after receiving the instruction. Which means that once
we
/// delete the table by mistake, we have no way to recall the deleted data.
- /// We have added a new API @SoftDeleteTable to allow the deleted data to be
+ /// We have added a new SoftDeleteTable API to allow the deleted data to be
/// reserved for a period of time, which means that the wrongly deleted data
may
/// be recalled. In order to be compatible with the previous versions, this
interface
/// will continue to directly delete tables without reserving the table.
@@ -3372,6 +3373,18 @@ class KUDU_EXPORT KuduScanTokenBuilder {
/// @return Operation result status.
Status IncludeTabletMetadata(bool include_metadata) WARN_UNUSED_RESULT;
+ /// Set approximate data size (in bytes) for each key range that a single
scan
+ /// token is built for.
+ ///
+ /// @param [in] split_size_bytes
+ /// The approximate target size of the data to be retrieved per scan token.
+ /// If set to @c 0 (and that's the default, unless explicitly set by
calling
+ /// this method), the key ranges of the scan tokens to be produced
+ /// are determined by the table's partition schema, so a single token
+ /// is built per single tablet. Also see @c KuduScanToken#setSplitSizeBytes
+ /// in the Java client.
+ void SetSplitSizeBytes(uint64_t split_size_bytes);
+
/// Build the set of scan tokens.
///
/// The builder may be reused after this call.
@@ -3382,11 +3395,6 @@ class KUDU_EXPORT KuduScanTokenBuilder {
/// @return Operation result status.
Status Build(std::vector<KuduScanToken*>* tokens) WARN_UNUSED_RESULT;
- /// Set the size of the data in each key range.
- /// The default value is 0 without set and tokens build by meta cache.
- /// It's corresponding to 'setSplitSizeBytes' in Java client.
- void SetSplitSizeBytes(uint64_t split_size_bytes);
-
private:
class KUDU_NO_EXPORT Data;
diff --git a/src/kudu/client/write_op.h b/src/kudu/client/write_op.h
index 32cfa5b55..5a96a7a3f 100644
--- a/src/kudu/client/write_op.h
+++ b/src/kudu/client/write_op.h
@@ -95,6 +95,8 @@ class KUDU_EXPORT KuduWriteOperation {
/// caller must handle redaction themselves, if necessary.
virtual std::string ToString() const = 0;
+ /// @return Raw pointer to KuduTable object representing the table
+ /// that the write is targeted for.
const KuduTable* table() const { return table_.get(); }
protected:
