From commits-return-6579-archive-asf-public=cust-asf.ponee.io@kudu.apache.org Fri Oct 26 20:56:48 2018 Return-Path: X-Original-To: archive-asf-public@cust-asf.ponee.io Delivered-To: archive-asf-public@cust-asf.ponee.io Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by mx-eu-01.ponee.io (Postfix) with SMTP id F0FDD180647 for ; Fri, 26 Oct 2018 20:56:47 +0200 (CEST) Received: (qmail 19941 invoked by uid 500); 26 Oct 2018 18:56:47 -0000 Mailing-List: contact commits-help@kudu.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@kudu.apache.org Delivered-To: mailing list commits@kudu.apache.org Received: (qmail 19932 invoked by uid 99); 26 Oct 2018 18:56:47 -0000 Received: from git1-us-west.apache.org (HELO git1-us-west.apache.org) (140.211.11.23) by apache.org (qpsmtpd/0.29) with ESMTP; Fri, 26 Oct 2018 18:56:47 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id F1290E0A2D; Fri, 26 Oct 2018 18:56:46 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit From: abukor@apache.org To: commits@kudu.apache.org Message-Id: <8a547cfd53c241e5b3bb8b40da9666f0@git.apache.org> X-Mailer: ASF-Git Admin Mailer Subject: kudu git commit: [doc] run doxygen with no warnings Date: Fri, 26 Oct 2018 18:56:46 +0000 (UTC) Repository: kudu Updated Branches: refs/heads/branch-1.8.x 6ac83c826 -> 02e821279 [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 (cherry picked from commit 9042eda2c6c055c364f9c441c9b7fab3ecd15649) Reviewed-on: http://gerrit.cloudera.org:8080/11792 Reviewed-by: Attila Bukor Project: http://git-wip-us.apache.org/repos/asf/kudu/repo Commit: http://git-wip-us.apache.org/repos/asf/kudu/commit/02e82127 Tree: http://git-wip-us.apache.org/repos/asf/kudu/tree/02e82127 Diff: http://git-wip-us.apache.org/repos/asf/kudu/diff/02e82127 Branch: refs/heads/branch-1.8.x Commit: 02e821279bf5d68cdb142afa541dbfe6271ee73e Parents: 6ac83c8 Author: Alexey Serbin Authored: Thu Oct 25 00:59:20 2018 -0700 Committer: Alexey Serbin Committed: Fri Oct 26 00:18:06 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/02e82127/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/02e82127/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/02e82127/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);