From 52df48dc3fc2bd06f964403b9582100b4d24e7d7 Mon Sep 17 00:00:00 2001 From: Sergey Avseyev Date: Tue, 25 Jun 2024 12:21:42 -0700 Subject: [PATCH] Fix typos in API docstrings --- core/transactions.hxx | 9 +++--- couchbase/get_all_replicas_options.hxx | 7 +--- couchbase/get_any_replica_options.hxx | 7 +--- couchbase/lookup_in_all_replicas_options.hxx | 31 +++--------------- couchbase/lookup_in_any_replica_options.hxx | 32 +++---------------- couchbase/scan_type.hxx | 2 +- couchbase/search_options.hxx | 5 ++- couchbase/search_result.hxx | 2 +- couchbase/transactions.hxx | 4 +-- .../transactions/transactions_config.hxx | 2 +- 10 files changed, 24 insertions(+), 77 deletions(-) diff --git a/core/transactions.hxx b/core/transactions.hxx index c65c7b73b..daf80e05c 100644 --- a/core/transactions.hxx +++ b/core/transactions.hxx @@ -173,8 +173,9 @@ public: * * @param logic The lambda containing the transaction logic. * @return A struct containing some internal state information about the transaction. - * @throws @ref transaction_failed, @ref transaction_expired, @ref transaction_commit_ambiguous, - * all of which share a common base class @ref transaction_exception. + * @throws @ref transaction_failed, @ref errc::transaction::expired, @ref + * transaction_commit_ambiguous, all of which share a common base class @ref + * transaction_exception. */ auto run(logic&& code) -> couchbase::transactions::transaction_result; @@ -194,8 +195,8 @@ public: * @param logic The lambda containing the async transaction logic. * @param cb Called when the transaction is complete. * @return A struct containing some internal state information about the transaction. - * @throws @ref transaction_failed, @ref transaction_expired, @ref transaction_commit_ambiguous, - * all of which share a common base class @ref transaction_exception. + * @throws @ref errc::transaction::failed, @ref errc::transaction::expired, @ref + * errc::transaction::ambiguous. */ void run(async_logic&& code, txn_complete_callback&& cb); diff --git a/couchbase/get_all_replicas_options.hxx b/couchbase/get_all_replicas_options.hxx index 8979e4772..974eadc95 100644 --- a/couchbase/get_all_replicas_options.hxx +++ b/couchbase/get_all_replicas_options.hxx @@ -22,10 +22,7 @@ #include #include -#include #include -#include -#include #include namespace couchbase @@ -84,9 +81,7 @@ struct get_all_replicas_options : public common_options #include -#include #include -#include -#include namespace couchbase { @@ -83,9 +80,7 @@ struct get_any_replica_options : public common_options } private: - enum read_preference read_preference_ { - read_preference::no_preference - }; + couchbase::read_preference read_preference_{ read_preference::no_preference }; }; /** diff --git a/couchbase/lookup_in_all_replicas_options.hxx b/couchbase/lookup_in_all_replicas_options.hxx index 5401a1ae4..771fcc953 100644 --- a/couchbase/lookup_in_all_replicas_options.hxx +++ b/couchbase/lookup_in_all_replicas_options.hxx @@ -27,10 +27,7 @@ #include #include -#include #include -#include -#include #include namespace couchbase @@ -89,9 +86,7 @@ struct lookup_in_all_replicas_options : common_options core, - const std::string& bucket_name, - const std::string& scope_name, - const std::string& collection_name, - std::string document_key, - const std::vector& specs, - lookup_in_all_replicas_options::built options, - lookup_in_all_replicas_handler&& handler); +} // namespace impl::subdoc #endif -} // namespace impl + } // namespace core } // namespace couchbase diff --git a/couchbase/lookup_in_any_replica_options.hxx b/couchbase/lookup_in_any_replica_options.hxx index 40d06899b..76b778c45 100644 --- a/couchbase/lookup_in_any_replica_options.hxx +++ b/couchbase/lookup_in_any_replica_options.hxx @@ -27,11 +27,7 @@ #include #include -#include #include -#include -#include -#include namespace couchbase { @@ -89,9 +85,7 @@ struct lookup_in_any_replica_options : common_options core, - const std::string& bucket_name, - const std::string& scope_name, - const std::string& collection_name, - std::string document_key, - const std::vector& specs, - lookup_in_any_replica_options::built options, - lookup_in_any_replica_handler&& handler); +} // namespace impl::subdoc #endif -} // namespace impl + } // namespace core } // namespace couchbase diff --git a/couchbase/scan_type.hxx b/couchbase/scan_type.hxx index 1325518d5..7f4160ea8 100644 --- a/couchbase/scan_type.hxx +++ b/couchbase/scan_type.hxx @@ -277,7 +277,7 @@ public: } /** - * Creates an instance of a sampling scan type with a seed.. + * Creates an instance of a sampling scan type with a seed. * * @param limit the maximum number of documents the sampling scan can return. * @param seed the seed used for the random number generator that selects the documents. diff --git a/couchbase/search_options.hxx b/couchbase/search_options.hxx index cbb45ac8b..121fb133b 100644 --- a/couchbase/search_options.hxx +++ b/couchbase/search_options.hxx @@ -35,7 +35,7 @@ namespace couchbase { /** - * Options for @ref cluster#search_query(), @ref cluster#search() and @ref scope#search(). + * Options for @ref cluster#search() and @ref scope#search(). * * @since 1.0.0 * @committed @@ -514,8 +514,7 @@ private: }; /** - * The signature for the handler of the @ref cluster#search_query(), @ref cluster#search() and @ref - * scope#search() operations + * The signature for the handler of the @ref cluster#search() and @ref scope#search() operations * * @since 1.0.0 * @uncommitted diff --git a/couchbase/search_result.hxx b/couchbase/search_result.hxx index b90bad79f..2e97731eb 100644 --- a/couchbase/search_result.hxx +++ b/couchbase/search_result.hxx @@ -35,7 +35,7 @@ class internal_search_result; #endif /** - * Represents result of @ref cluster#search_query(), @ref cluster#search() and @ref scope#search() + * Represents result of @ref cluster#search() and @ref scope#search() * calls. * * @since 1.0.0 diff --git a/couchbase/transactions.hxx b/couchbase/transactions.hxx index e95582311..2f10bd2c5 100644 --- a/couchbase/transactions.hxx +++ b/couchbase/transactions.hxx @@ -53,8 +53,8 @@ public: * desired transactional operations. * @param cfg if passed in, these options override the defaults, or those set in the {@link * cluster_options}. - * @return an {@link transaction_error_context}, and a {@link transaction_result} representing the - * results of the transaction. + * @return an {@link error}, and a {@link transaction_result} representing the results of the + * transaction. */ virtual auto run(txn_logic&& logic, const transaction_options& cfg) -> std::pair = 0; diff --git a/couchbase/transactions/transactions_config.hxx b/couchbase/transactions/transactions_config.hxx index 88c2c82c6..007b7ebd2 100644 --- a/couchbase/transactions/transactions_config.hxx +++ b/couchbase/transactions/transactions_config.hxx @@ -83,7 +83,7 @@ public: * * Transactions can conflict (or other operations on those documents), and may retry. * This is the maximum time a transaction can take, including any retries. The transaction will - * throw an @ref transaction_expired and rollback when this occurs. + * throw an @ref errc::transaction::expired and rollback when this occurs. * * @return timeout for transactions. */