kudu-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ale...@apache.org
Subject kudu git commit: [doc] run doxygen with no warnings
Date Thu, 25 Oct 2018 18:42:21 GMT
Repository: kudu
Updated Branches:
  refs/heads/master c09699ba8 -> 9042eda2c


[doc] run doxygen with no warnings

Updated doxygen configuration due to recent changes in Kudu C++ client
sample application.  Cleaned up other minor documentation issues
in src/kudu/client/schema.h.  With this patch, doxygen runs without any
warnings while auto-generating documentation for Kudu C++ client API
(verified with doxygen 1.8.14 built on OS X 10.11.6).

This is a follow-up for a30c9211e8e73ead70acdb6108e5a0eac90cb5cb.

Change-Id: Iedb31849288caa59456aff6eb075cf23c843d4e0
Reviewed-on: http://gerrit.cloudera.org:8080/11784
Tested-by: Kudu Jenkins
Reviewed-by: Adar Dembo <adar@cloudera.com>


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

Branch: refs/heads/master
Commit: 9042eda2c6c055c364f9c441c9b7fab3ecd15649
Parents: c09699b
Author: Alexey Serbin <aserbin@cloudera.com>
Authored: Thu Oct 25 00:59:20 2018 -0700
Committer: Alexey Serbin <aserbin@cloudera.com>
Committed: Thu Oct 25 18:38:02 2018 +0000

----------------------------------------------------------------------
 CMakeLists.txt                          | 2 +-
 docs/support/doxygen/client_api.doxy.in | 3 +++
 src/kudu/client/schema.h                | 6 ++++++
 3 files changed, 10 insertions(+), 1 deletion(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/kudu/blob/9042eda2/CMakeLists.txt
----------------------------------------------------------------------
diff --git a/CMakeLists.txt b/CMakeLists.txt
index df02893..388eaad 100644
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -1414,7 +1414,7 @@ if (UNIX)
     set(DOXY_CLIENT_API_FOOTER ${DOXY_SUBDIR}/client_api.footer)
     set(DOXY_CLIENT_API_OUTDIR ${DOXY_SUBDIR}/client_api)
     list(APPEND DOXY_CLIENT_API_EXCLUDE
-      "share/doc/kuduClient/samples/sample.cc")
+      "share/doc/kuduClient/examples/example.cc")
     # NOTE: DOXY_CLIENT_API_OUTDIR and DOXY_CLIENT_API_FOOTER are used
     #       in client_api.doxy.in template file
     configure_file(docs/support/doxygen/client_api.doxy.in ${DOXY_CLIENT_API_CFG} @ONLY)

http://git-wip-us.apache.org/repos/asf/kudu/blob/9042eda2/docs/support/doxygen/client_api.doxy.in
----------------------------------------------------------------------
diff --git a/docs/support/doxygen/client_api.doxy.in b/docs/support/doxygen/client_api.doxy.in
index 2abe660..33aea70 100644
--- a/docs/support/doxygen/client_api.doxy.in
+++ b/docs/support/doxygen/client_api.doxy.in
@@ -60,3 +60,6 @@ WARN_NO_PARAMDOC       = YES
 
 # As for now, documentation in LaTeX format is not needed.
 GENERATE_LATEX         = NO
+
+# Do not output warnings on undocumented friend classes/structs/unions.
+HIDE_FRIEND_COMPOUNDS  = YES

http://git-wip-us.apache.org/repos/asf/kudu/blob/9042eda2/src/kudu/client/schema.h
----------------------------------------------------------------------
diff --git a/src/kudu/client/schema.h b/src/kudu/client/schema.h
index c8d79e8..9347298 100644
--- a/src/kudu/client/schema.h
+++ b/src/kudu/client/schema.h
@@ -338,6 +338,8 @@ class KUDU_EXPORT KuduColumnSpec {
   ///
   /// The precision must be between 1 and 38.
   ///
+  /// @param [in] precision
+  ///   Desired precision to set.
   /// @return Pointer to the modified object.
   KuduColumnSpec* Precision(int8_t precision);
 
@@ -353,6 +355,8 @@ class KUDU_EXPORT KuduColumnSpec {
   /// The scale must be greater than 0 and less than the column's precision.
   /// If no scale is provided a default scale of 0 is used.
   ///
+  /// @param [in] scale
+  ///   Desired scale to set.
   /// @return Pointer to the modified object.
   KuduColumnSpec* Scale(int8_t scale);
   ///@}
@@ -589,8 +593,10 @@ class KUDU_EXPORT KuduSchema {
   friend class tools::RemoteKsckCluster;
   friend class tools::ReplicaDumper;
 
+  /// @cond
   friend KuduSchema KuduSchemaFromSchema(const Schema& schema);
   friend Schema SchemaFromKuduSchema(const KuduSchema& schema);
+  /// @endcond
 
   // For use by kudu tests.
   explicit KuduSchema(const Schema& schema);


Mime
View raw message