Fix typos in API docstrings

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);
 

couchbase/get_all_replicas_options.hxx

@@ -22,10 +22,7 @@
 #include <couchbase/get_replica_result.hxx>
 #include <couchbase/read_preference.hxx>
 
-#include <chrono>
 #include <functional>
-#include <memory>
-#include <optional>
 #include <vector>
 
 namespace couchbase
@@ -84,9 +81,7 @@ struct get_all_replicas_options : public common_options<get_all_replicas_options
   }
 
 private:
-  enum read_preference read_preference_ {
-    read_preference::no_preference
-  };
+  couchbase::read_preference read_preference_{ read_preference::no_preference };
 };
 
 /**

couchbase/get_any_replica_options.hxx

@@ -22,10 +22,7 @@
 #include <couchbase/get_replica_result.hxx>
 #include <couchbase/read_preference.hxx>
 
-#include <chrono>
 #include <functional>
-#include <memory>
-#include <optional>
 
 namespace couchbase
 {
@@ -83,9 +80,7 @@ struct get_any_replica_options : public common_options<get_any_replica_options>
   }
 
 private:
-  enum read_preference read_preference_ {
-    read_preference::no_preference
-  };
+  couchbase::read_preference read_preference_{ read_preference::no_preference };
 };
 
 /**

couchbase/lookup_in_all_replicas_options.hxx

@@ -27,10 +27,7 @@
 #include <couchbase/read_preference.hxx>
 #include <couchbase/store_semantics.hxx>
 
-#include <chrono>
 #include <functional>
-#include <memory>
-#include <optional>
 #include <vector>
 
 namespace couchbase
@@ -89,9 +86,7 @@ struct lookup_in_all_replicas_options : common_options<lookup_in_all_replicas_op
   }
 
 private:
-  enum read_preference read_preference_ {
-    read_preference::no_preference
-  };
+  couchbase::read_preference read_preference_{ read_preference::no_preference };
 };
 
 /**
@@ -114,28 +109,12 @@ using lookup_in_all_replicas_handler = std::function<void(error, lookup_in_all_r
 namespace core
 {
 class cluster;
-namespace impl
-{
-namespace subdoc
+
+namespace impl::subdoc
 {
 struct command;
-} // namespace subdoc
-
-/**
- * @since 1.0.0
- * @internal
- */
-void
-initiate_lookup_in_all_replicas_operation(
-  std::shared_ptr<couchbase::core::cluster> core,
-  const std::string& bucket_name,
-  const std::string& scope_name,
-  const std::string& collection_name,
-  std::string document_key,
-  const std::vector<couchbase::core::impl::subdoc::command>& specs,
-  lookup_in_all_replicas_options::built options,
-  lookup_in_all_replicas_handler&& handler);
+} // namespace impl::subdoc
 #endif
-} // namespace impl
+
 } // namespace core
 } // namespace couchbase

couchbase/lookup_in_any_replica_options.hxx

@@ -27,11 +27,7 @@
 #include <couchbase/read_preference.hxx>
 #include <couchbase/store_semantics.hxx>
 
-#include <chrono>
 #include <functional>
-#include <memory>
-#include <optional>
-#include <vector>
 
 namespace couchbase
 {
@@ -89,9 +85,7 @@ struct lookup_in_any_replica_options : common_options<lookup_in_any_replica_opti
   }
 
 private:
-  enum read_preference read_preference_ {
-    read_preference::no_preference
-  };
+  couchbase::read_preference read_preference_{ read_preference::no_preference };
 };
 
 /**
@@ -106,28 +100,12 @@ using lookup_in_any_replica_handler = std::function<void(error, lookup_in_replic
 namespace core
 {
 class cluster;
-namespace impl
-{
-namespace subdoc
+
+namespace impl::subdoc
 {
 struct command;
-} // namespace subdoc
-
-/**
- * @since 1.0.0
- * @internal
- */
-void
-initiate_lookup_in_any_replica_operation(
-  std::shared_ptr<couchbase::core::cluster> core,
-  const std::string& bucket_name,
-  const std::string& scope_name,
-  const std::string& collection_name,
-  std::string document_key,
-  const std::vector<couchbase::core::impl::subdoc::command>& specs,
-  lookup_in_any_replica_options::built options,
-  lookup_in_any_replica_handler&& handler);
+} // namespace impl::subdoc
 #endif
-} // namespace impl
+
 } // namespace core
 } // namespace couchbase

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.

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

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

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<error, transaction_result> = 0;

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.
    */