kudu-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From abu...@apache.org
Subject kudu git commit: [c++ client] clean up inline doxygen documentation
Date Thu, 25 Oct 2018 19:05:30 GMT
Repository: kudu
Updated Branches:
  refs/heads/branch-1.8.x 4adb9a19c -> 6ac83c826


[c++ client] clean up inline doxygen documentation

This patch cleans up doxygen documentation in client.h.
Most importantly, this patch removes the internal API
methods (i.e. methods marked with KUDU_NO_EXPORT attribute)
from the auto-generated documentation.  Fixed other typos
and mistakes in doxygen formatting, so now doxygen outputs
less warnings.

The rest of the doxygen warnings will be addressed in a follow-up
patch.

Change-Id: Ib0038f45e746896b6abbcfaa5741760218d7a9ad
Reviewed-on: http://gerrit.cloudera.org:8080/11780
Tested-by: Kudu Jenkins
Reviewed-by: Adar Dembo <adar@cloudera.com>
(cherry picked from commit a30c9211e8e73ead70acdb6108e5a0eac90cb5cb)
Reviewed-on: http://gerrit.cloudera.org:8080/11783
Reviewed-by: Alexey Serbin <aserbin@cloudera.com>


Project: http://git-wip-us.apache.org/repos/asf/kudu/repo
Commit: http://git-wip-us.apache.org/repos/asf/kudu/commit/6ac83c82
Tree: http://git-wip-us.apache.org/repos/asf/kudu/tree/6ac83c82
Diff: http://git-wip-us.apache.org/repos/asf/kudu/diff/6ac83c82

Branch: refs/heads/branch-1.8.x
Commit: 6ac83c826db834ba09cf2049af43c1316e9da1d9
Parents: 4adb9a1
Author: Attila Bukor <abukor@apache.org>
Authored: Thu Oct 25 08:54:22 2018 +0200
Committer: Attila Bukor <abukor@apache.org>
Committed: Thu Oct 25 19:05:08 2018 +0000

----------------------------------------------------------------------
 src/kudu/client/client.h | 74 +++++++++++++++++++++++++++++++------------
 1 file changed, 53 insertions(+), 21 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/kudu/blob/6ac83c82/src/kudu/client/client.h
----------------------------------------------------------------------
diff --git a/src/kudu/client/client.h b/src/kudu/client/client.h
index e479aa9..1c95388 100644
--- a/src/kudu/client/client.h
+++ b/src/kudu/client/client.h
@@ -339,8 +339,12 @@ class KUDU_EXPORT KuduClient : public sp::enable_shared_from_this<KuduClient>
{
   /// @return Operation status.
   Status DeleteTable(const std::string& table_name);
 
+  /// @cond PRIVATE_API
+
   /// Delete/drop a table in internal catalogs and possibly external catalogs.
   ///
+  /// Private API.
+  ///
   /// @param [in] table_name
   ///   Name of the table to drop.
   /// @param [in] modify_external_catalogs
@@ -349,6 +353,7 @@ class KUDU_EXPORT KuduClient : public sp::enable_shared_from_this<KuduClient>
{
   /// @return Operation status.
   Status DeleteTableInCatalogs(const std::string& table_name,
                                bool modify_external_catalogs) KUDU_NO_EXPORT;
+  /// @endcond
 
   /// Create a KuduTableAlterer object.
   ///
@@ -431,7 +436,7 @@ class KUDU_EXPORT KuduClient : public sp::enable_shared_from_this<KuduClient>
{
   /// @return A new session object; caller is responsible for destroying it.
   sp::shared_ptr<KuduSession> NewSession();
 
-  /// @cond false
+  /// @cond PRIVATE_API
 
   /// Get tablet information for a tablet by ID.
   ///
@@ -544,25 +549,35 @@ class KUDU_EXPORT KuduClient : public sp::enable_shared_from_this<KuduClient>
{
   /// @return Status object for the operation.
   Status ExportAuthenticationCredentials(std::string* authn_creds) const;
 
-  // @return the configured Hive Metastore URIs on the most recently connected to
-  //    leader master, or an empty string if the Hive Metastore integration is not
-  //    enabled.
+  /// @cond PRIVATE_API
+
+  /// Private API.
+  ///
+  /// @return the configured Hive Metastore URIs on the most recently connected to
+  ///   leader master, or an empty string if the Hive Metastore integration is not
+  ///   enabled.
   std::string GetHiveMetastoreUris() const KUDU_NO_EXPORT;
 
-  // @return the configured Hive Metastore SASL (Kerberos) configuration on the most
-  //    recently connected to leader master, or an arbitrary value if the Hive
-  //    Metastore integration is not enabled.
+  /// Private API.
+  ///
+  /// @return the configured Hive Metastore SASL (Kerberos) configuration on the most
+  ///   recently connected to leader master, or an arbitrary value if the Hive
+  ///   Metastore integration is not enabled.
   bool GetHiveMetastoreSaslEnabled() const KUDU_NO_EXPORT;
 
-  // @return a unique ID which identifies the Hive Metastore instance, if the
-  //    cluster is configured with the Hive Metastore integration, or an
-  //    arbitrary value if the Hive Metastore integration is not enabled.
-  //
-  // @note this is provided on a best-effort basis, as not all Hive Metastore
-  //    versions which Kudu is compatible with include the necessary APIs. See
-  //    HIVE-16452 for more info.
+  /// Private API.
+  ///
+  /// @note this is provided on a best-effort basis, as not all Hive Metastore
+  ///   versions which Kudu is compatible with include the necessary APIs. See
+  ///   HIVE-16452 for more info.
+  ///
+  /// @return a unique ID which identifies the Hive Metastore instance, if the
+  ///   cluster is configured with the Hive Metastore integration, or an
+  ///   arbitrary value if the Hive Metastore integration is not enabled.
   std::string GetHiveMetastoreUuid() const KUDU_NO_EXPORT;
 
+  /// @endcond
+
  private:
   class KUDU_NO_EXPORT Data;
 
@@ -1208,14 +1223,20 @@ class KUDU_EXPORT KuduTableAlterer {
   /// @return Raw pointer to this alterer object.
   KuduTableAlterer* wait(bool wait);
 
+  /// @cond PRIVATE_API
+
   /// Whether to apply the alteration to external catalogs, such as the Hive
   /// Metastore, which the Kudu master has been configured to integrate with.
   ///
+  /// Private API.
+  ///
   /// @param [in] modify_external_catalogs
   ///   Whether to apply the alteration to external catalogs.
   /// @return Raw pointer to this alterer object.
   KuduTableAlterer* modify_external_catalogs(bool modify_external_catalogs) KUDU_NO_EXPORT;
 
+  /// @endcond
+
   /// @return Status of the ALTER TABLE operation. The return value
   ///   may indicate an error in the alter operation,
   ///   or a misuse of the builder (e.g. add_column() with default_value=NULL).
@@ -2122,6 +2143,7 @@ class KUDU_EXPORT KuduScanner {
   ///   data for further decoding. Using KuduScanBatch::Row() might yield incorrect/corrupt
   ///   results and might even cause the client to crash.
   static const uint64_t PAD_UNIXTIME_MICROS_TO_16_BYTES = 1 << 0;
+
   /// Optionally set row format modifier flags.
   ///
   /// If flags is RowFormatFlags::NO_FLAGS, then no modifications will be made to the row
@@ -2145,12 +2167,16 @@ class KUDU_EXPORT KuduScanner {
   ///     ... // Row data decoding and handling.
   ///   }
   /// @endcode
+  ///
+  /// @param [in] flags
+  ///   Row format modifier flags to set.
+  /// @return Operation result status.
   Status SetRowFormatFlags(uint64_t flags);
   ///@}
 
   /// Set the maximum number of rows the scanner should return.
   ///
-  /// @param [in] rows
+  /// @param [in] limit
   ///   Limit on the number of rows to return.
   /// @return Operation result status.
   Status SetLimit(int64_t limit) WARN_UNUSED_RESULT;
@@ -2370,6 +2396,10 @@ class KUDU_EXPORT KuduPartitionerBuilder {
   ~KuduPartitionerBuilder();
 
   /// Set the timeout used for building the Partitioner object.
+  ///
+  /// @param [in] timeout
+  ///   The timeout to set.
+  /// @return Pointer to the result object.
   KuduPartitionerBuilder* SetBuildTimeout(MonoDelta timeout);
 
   /// Create a KuduPartitioner object for the specified table.
@@ -2388,6 +2418,8 @@ class KUDU_EXPORT KuduPartitionerBuilder {
   /// This means that the resulting partitioner is not guaranteed to have
   /// up-to-date partition information in the case that there has been
   /// a recent change to the partitioning of the target table.
+  ///
+  /// @return Operation result status.
   Status Build(KuduPartitioner** partitioner);
  private:
   class KUDU_NO_EXPORT Data;
@@ -2412,9 +2444,9 @@ class KUDU_EXPORT KuduPartitioner {
  public:
   ~KuduPartitioner();
 
-  /// Return the number of partitions known by this partitioner.
-  /// The partition indices returned by @c PartitionRow are guaranteed
-  /// to be less than this value.
+  /// @return the number of partitions known by this partitioner.
+  ///   The partition indices returned by @c PartitionRow are guaranteed
+  ///   to be less than this value.
   int NumPartitions() const;
 
   /// Determine the partition index that the given row falls into.
@@ -2425,9 +2457,9 @@ class KUDU_EXPORT KuduPartitioner {
   ///   The resulting partition index, or -1 if the row falls into a
   ///   non-covered range. The result will be less than @c NumPartitioons().
   ///
-  /// @return Status OK if successful. May return a bad Status if the
-  /// provided row does not have all columns of the partition key
-  /// set.
+  /// @return Status::OK if successful. May return a bad Status if the
+  ///   provided row does not have all columns of the partition key
+  ///   set.
   Status PartitionRow(const KuduPartialRow& row, int* partition);
  private:
   class KUDU_NO_EXPORT Data;


Mime
View raw message