kudu-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From granthe...@apache.org
Subject [kudu] 01/02: Fix KuduScanTokenBuilder::SetDiffScan docs
Date Thu, 11 Jul 2019 12:58:27 GMT
This is an automated email from the ASF dual-hosted git repository.

granthenke pushed a commit to branch branch-1.10.x
in repository https://gitbox.apache.org/repos/asf/kudu.git

commit 8d98b65b433df8e2e111abc07456ac493254fcc7
Author: Grant Henke <granthenke@apache.org>
AuthorDate: Wed Jul 10 16:04:19 2019 -0500

    Fix KuduScanTokenBuilder::SetDiffScan docs
    
    It looks like Doxygen can’t use `@copydoc` when
    the doc being copied is in a `@cond PRIVATE_API`.
    
    Change-Id: I448c00b78f9d14685e87d154e1bbee0eaa8e8e24
    Reviewed-on: http://gerrit.cloudera.org:8080/13837
    Tested-by: Kudu Jenkins
    Reviewed-by: Adar Dembo <adar@cloudera.com>
    (cherry picked from commit 0b4948ea3beac43a0dcd2ae2933440d089e337fd)
    Reviewed-on: http://gerrit.cloudera.org:8080/13839
    Reviewed-by: Andrew Wong <awong@cloudera.com>
---
 src/kudu/client/client.h | 19 ++++++++++++++++++-
 1 file changed, 18 insertions(+), 1 deletion(-)

diff --git a/src/kudu/client/client.h b/src/kudu/client/client.h
index 2ef8da5..20c3440 100644
--- a/src/kudu/client/client.h
+++ b/src/kudu/client/client.h
@@ -2431,10 +2431,27 @@ class KUDU_EXPORT KuduScanTokenBuilder {
   /// @copydoc KuduScanner::SetSnapshotRaw
   Status SetSnapshotRaw(uint64_t snapshot_timestamp) WARN_UNUSED_RESULT;
 
-  /// @copydoc KuduScanner::SetDiffScan
+  /// @cond PRIVATE_API
+
+  /// Set the start and end timestamp for a diff scan. The timestamps should be
+  /// encoded HT timestamps.
+  ///
+  /// Additionally sets any other scan properties required by diff scans.
+  ///
+  /// Private API.
+  ///
+  /// @param [in] start_timestamp
+  ///   Start timestamp to set in raw encoded form
+  ///   (i.e. as returned by a previous call to a server).
+  /// @param [in] end_timestamp
+  ///   End timestamp to set in raw encoded form
+  ///   (i.e. as returned by a previous call to a server).
+  /// @return Operation result status.
   Status SetDiffScan(uint64_t start_timestamp, uint64_t end_timestamp)
       WARN_UNUSED_RESULT KUDU_NO_EXPORT;
 
+  /// @endcond
+
   /// @copydoc KuduScanner::SetTimeoutMillis
   Status SetTimeoutMillis(int millis) WARN_UNUSED_RESULT;
 


Mime
View raw message