This is an automated email from the ASF dual-hosted git repository. alexey pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/kudu.git
commit 4ed31b55ff39bd75465fc17f725f130f1a2167e1 Author: Alexey Serbin <[email protected]> AuthorDate: Fri Nov 8 17:14:38 2024 -0800 [client] fix doxygen warning Before this patch, doxygen of 1.11 and newer versions would output the following warnings when generating documentation for Kudu C++ client API: scan_batch.h:163: warning: Compound kudu::client::KuduScanBatch::RowPtr is not documented. scan_batch.h:378: warning: Compound kudu::client::KuduScanBatch::const_iterator is not documented. Change-Id: I07c51acf8cb9d0a314731781c177ea8f7b4f9889 Reviewed-on: http://gerrit.cloudera.org:8080/22048 Tested-by: Alexey Serbin <[email protected]> Reviewed-by: Abhishek Chennaka <[email protected]> --- src/kudu/client/scan_batch.h | 2 ++ 1 file changed, 2 insertions(+) diff --git a/src/kudu/client/scan_batch.h b/src/kudu/client/scan_batch.h index cef7f7609..2259df6f1 100644 --- a/src/kudu/client/scan_batch.h +++ b/src/kudu/client/scan_batch.h @@ -160,6 +160,7 @@ class KUDU_EXPORT KuduScanBatch { DISALLOW_COPY_AND_ASSIGN(KuduScanBatch); }; +/// @brief A handle for a single row in @c KuduScanBatch class KUDU_EXPORT KuduScanBatch::RowPtr { public: /// Construct an invalid RowPtr. Before use, you must assign @@ -375,6 +376,7 @@ class KUDU_EXPORT KuduScanBatch::RowPtr { // required by the STL iterator traits, the deprecation warnings are silenced. #pragma GCC diagnostic push #pragma GCC diagnostic ignored "-Wdeprecated-declarations" +/// @brief Iterator to work with immutable KuduScanBatch instances class KUDU_EXPORT KuduScanBatch::const_iterator : public std::iterator<std::forward_iterator_tag, KuduScanBatch::RowPtr> { public:
