[doxygen] fixed recent doxygen warnings Fixed a few doxygen warnings output by the 'make doxygen' target. Also, fixed few typos in the comments.
Change-Id: I85b38a2a90915d823005797962a34a350ad18da6 Reviewed-on: http://gerrit.cloudera.org:8080/6174 Reviewed-by: Adar Dembo <[email protected]> Tested-by: Kudu Jenkins Project: http://git-wip-us.apache.org/repos/asf/kudu/repo Commit: http://git-wip-us.apache.org/repos/asf/kudu/commit/99ed6297 Tree: http://git-wip-us.apache.org/repos/asf/kudu/tree/99ed6297 Diff: http://git-wip-us.apache.org/repos/asf/kudu/diff/99ed6297 Branch: refs/heads/master Commit: 99ed6297244e009c9b7a371c1517ee7b733a30d1 Parents: b39bfcb Author: Alexey Serbin <[email protected]> Authored: Mon Feb 27 18:09:52 2017 -0800 Committer: Alexey Serbin <[email protected]> Committed: Tue Feb 28 02:42:48 2017 +0000 ---------------------------------------------------------------------- src/kudu/client/client.h | 12 +++++++----- src/kudu/util/status.h | 8 +++++--- 2 files changed, 12 insertions(+), 8 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/kudu/blob/99ed6297/src/kudu/client/client.h ---------------------------------------------------------------------- diff --git a/src/kudu/client/client.h b/src/kudu/client/client.h index d8f2610..06eb895 100644 --- a/src/kudu/client/client.h +++ b/src/kudu/client/client.h @@ -230,6 +230,7 @@ class KUDU_EXPORT KuduClientBuilder { /// The serialized authentication credentials, provided by a call to /// @c KuduClient.ExportAuthenticationCredentials in the C++ client or /// @c KuduClient#exportAuthenticationCredentials in the Java client. + /// @return Reference to the updated object. KuduClientBuilder& import_authentication_credentials(std::string authn_creds); /// Create a client object. @@ -494,7 +495,8 @@ class KUDU_EXPORT KuduClient : public sp::enable_shared_from_this<KuduClient> { /// Java client via @c KuduClient#importAuthenticationCredentials. /// /// @param [out] authn_creds - /// The resulting binary authentication credsentials. + /// The resulting binary authentication credentials. + /// @return Status object for the operation. Status ExportAuthenticationCredentials(std::string* authn_creds) const; private: @@ -1029,7 +1031,7 @@ class KUDU_EXPORT KuduTableAlterer { /// @param [in] name /// Name of the column to alter. /// @return Pointer to the result ColumnSpec object. The alterer keeps - /// owhership of the newly created object. + /// ownership of the newly created object. KuduColumnSpec* AlterColumn(const std::string& name); /// Drops an existing column from the table. @@ -1544,7 +1546,7 @@ class KUDU_EXPORT KuduSession : public sp::enable_shared_from_this<KuduSession> /// @endcode /// ... @c callback_2 will be triggered once @c b has been inserted, /// regardless of whether @c a has completed or not. That means there might be - /// pending operations left in prior batches even after the the callback + /// pending operations left in prior batches even after the callback /// has been invoked to report on the flush status of the latest batch. /// /// @note This also means that, if FlushAsync is called twice in succession, @@ -1565,7 +1567,7 @@ class KUDU_EXPORT KuduSession : public sp::enable_shared_from_this<KuduSession> void FlushAsync(KuduStatusCallback* cb); /// @return Status of the session closure. In particular, an error is returned - /// if there are unflushed or in-flight operations. + /// if there are non-flushed or in-flight operations. Status Close() WARN_UNUSED_RESULT; /// Check if there are any pending operations in this session. @@ -1863,7 +1865,7 @@ class KUDU_EXPORT KuduScanner { /// for an additional time-to-live (set by a configuration flag on /// the tablet server). This is useful if the interval in between /// NextBatch() calls is big enough that the remote scanner might be garbage - /// collected (default ttl is set to 60 secs.). + /// collected (default TTL is set to 60 secs.). /// This does not invalidate any previously fetched results. /// /// @return Operation result status. In particular, this method returns http://git-wip-us.apache.org/repos/asf/kudu/blob/99ed6297/src/kudu/util/status.h ---------------------------------------------------------------------- diff --git a/src/kudu/util/status.h b/src/kudu/util/status.h index 75f0699..aaa5427 100644 --- a/src/kudu/util/status.h +++ b/src/kudu/util/status.h @@ -89,6 +89,8 @@ KUDU_DCHECK(_s.ok()) << (msg) << ": " << _s.ToString(); \ } while (0); +/// @brief If the status is bad, DCHECK immediately, appending the status to the +/// logged 'Bad status' message. #define KUDU_DCHECK_OK(s) KUDU_DCHECK_OK_PREPEND(s, "Bad status") /// @file status.h @@ -309,11 +311,11 @@ class KUDU_EXPORT Status { std::string ToString() const; /// @return A string representation of the status code, without the message - /// text or posix code information. + /// text or POSIX code information. std::string CodeAsString() const; /// This is similar to ToString, except that it does not include - /// the stringified error code or posix code. + /// the stringified error code or POSIX code. /// /// @note The returned Slice is only valid as long as this Status object /// remains live and unchanged. @@ -400,7 +402,7 @@ inline Status::Status(const Status& s) { } inline void Status::operator=(const Status& s) { // The following condition catches both aliasing (when this == &s), - // and the common case where both s and *this are ok. + // and the common case where both s and *this are OK. if (state_ != s.state_) { delete[] state_; state_ = (s.state_ == NULL) ? NULL : CopyState(s.state_);
