style: Unify style for all Doxygen comments (#3142)

src/data/BackendInterface.hpp

@@ -669,7 +669,9 @@ public:
         boost::asio::yield_context yield
     ) const = 0;
 
-    /** @brief Return type for fetchClioNodesData() method */
+    /**
+     * @brief Return type for fetchClioNodesData() method
+     */
     using ClioNodesDataFetchResult =
         std::expected<std::vector<std::pair<boost::uuids::uuid, std::string>>, std::string>;
 

src/data/CassandraBackend.hpp

@@ -72,7 +72,7 @@ public:
      */
     using DefaultCassandraFamily::DefaultCassandraFamily;
 
-    /*
+    /**
      * @brief Move constructor is deleted because handle_ is shared by reference with executor
      */
     BasicCassandraBackend(BasicCassandraBackend&&) = delete;

src/data/DBHelpers.hpp

@@ -286,5 +286,7 @@ uint256ToString(xrpl::uint256 const& input)
     return {reinterpret_cast<char const*>(input.data()), xrpl::uint256::size()};
 }
 
-/** @brief The ripple epoch start timestamp. Midnight on 1st January 2000. */
+/**
+ * @brief The ripple epoch start timestamp. Midnight on 1st January 2000.
+ */
 static constexpr std::uint32_t kRippleEpochStart = 946684800;

src/data/LedgerCache.hpp

@@ -29,7 +29,9 @@ namespace data {
  */
 class LedgerCache : public LedgerCacheInterface {
 public:
-    /** @brief An entry of the cache */
+    /**
+     * @brief An entry of the cache
+     */
     struct CacheEntry {
         uint32_t seq = 0;
         Blob blob;

src/data/LedgerCacheLoadingState.hpp

@@ -73,23 +73,33 @@ public:
      */
     explicit LedgerCacheLoadingState(LedgerCacheInterface const& cache);
 
-    /** @copydoc LedgerCacheLoadingStateInterface::allowLoading() */
+    /**
+     * @copydoc LedgerCacheLoadingStateInterface::allowLoading()
+     */
     void
     allowLoading() override;
 
-    /** @copydoc LedgerCacheLoadingStateInterface::isLoadingAllowed() */
+    /**
+     * @copydoc LedgerCacheLoadingStateInterface::isLoadingAllowed()
+     */
     [[nodiscard]] bool
     isLoadingAllowed() const override;
 
-    /** @copydoc LedgerCacheLoadingStateInterface::waitForLoadingAllowed() */
+    /**
+     * @copydoc LedgerCacheLoadingStateInterface::waitForLoadingAllowed()
+     */
     void
     waitForLoadingAllowed() const override;
 
-    /** @copydoc LedgerCacheLoadingStateInterface::isCurrentlyLoading() */
+    /**
+     * @copydoc LedgerCacheLoadingStateInterface::isCurrentlyLoading()
+     */
     [[nodiscard]] bool
     isCurrentlyLoading() const override;
 
-    /** @copydoc LedgerCacheLoadingStateInterface::clone() */
+    /**
+     * @copydoc LedgerCacheLoadingStateInterface::clone()
+     */
     [[nodiscard]] std::unique_ptr<LedgerCacheLoadingStateInterface>
     clone() const override;
 };

src/data/Types.hpp

@@ -294,13 +294,19 @@ struct AmendmentKey {
     {
     }
 
-    /** @brief Conversion to string */
+    /**
+     * @brief Conversion to string
+     */
     operator std::string const&() const;
 
-    /** @brief Conversion to string_view */
+    /**
+     * @brief Conversion to string_view
+     */
     operator std::string_view() const;
 
-    /** @brief Conversion to uint256 */
+    /**
+     * @brief Conversion to uint256
+     */
     operator xrpl::uint256() const;
 
     /**

src/data/cassandra/CassandraBackendFamily.hpp

@@ -134,7 +134,7 @@ public:
         LOG(log_.info()) << "Created (revamped) CassandraBackend";
     }
 
-    /*
+    /**
      * @brief Move constructor is deleted because handle_ is shared by reference with executor
      */
     CassandraBackendFamily(CassandraBackendFamily&&) = delete;

src/data/cassandra/impl/Cluster.hpp

@@ -56,50 +56,78 @@ struct Settings {
         std::string bundle;  // no meaningful default
     };
 
-    /** @brief Enables or disables cassandra driver logger */
+    /**
+     * @brief Enables or disables cassandra driver logger
+     */
     bool enableLog = false;
 
-    /** @brief Connect timeout specified in milliseconds */
+    /**
+     * @brief Connect timeout specified in milliseconds
+     */
     std::chrono::milliseconds connectionTimeout =
         std::chrono::milliseconds{kDefaultConnectionTimeout};
 
-    /** @brief Request timeout specified in milliseconds */
+    /**
+     * @brief Request timeout specified in milliseconds
+     */
     std::chrono::milliseconds requestTimeout = std::chrono::milliseconds{0};  // no timeout at all
 
-    /** @brief Connection information; either ContactPoints or SecureConnectionBundle */
+    /**
+     * @brief Connection information; either ContactPoints or SecureConnectionBundle
+     */
     std::variant<ContactPoints, SecureConnectionBundle> connectionInfo = ContactPoints{};
 
-    /** @brief The number of threads for the driver to pool */
+    /**
+     * @brief The number of threads for the driver to pool
+     */
     uint32_t threads = std::thread::hardware_concurrency();
 
-    /** @brief The maximum number of outstanding write requests at any given moment */
+    /**
+     * @brief The maximum number of outstanding write requests at any given moment
+     */
     uint32_t maxWriteRequestsOutstanding = kDefaultMaxWriteRequestsOutstanding;
 
-    /** @brief The maximum number of outstanding read requests at any given moment */
+    /**
+     * @brief The maximum number of outstanding read requests at any given moment
+     */
     uint32_t maxReadRequestsOutstanding = kDefaultMaxReadRequestsOutstanding;
 
-    /** @brief The number of connection per host to always have active */
+    /**
+     * @brief The number of connection per host to always have active
+     */
     uint32_t coreConnectionsPerHost = 3u;
 
-    /** @brief Size of batches when writing */
+    /**
+     * @brief Size of batches when writing
+     */
     std::size_t writeBatchSize = kDefaultBatchSize;
 
-    /** @brief Provider to know if we are using scylladb or keyspace */
+    /**
+     * @brief Provider to know if we are using scylladb or keyspace
+     */
     Provider provider = kDefaultProvider;
 
-    /** @brief Size of the IO queue */
+    /**
+     * @brief Size of the IO queue
+     */
     std::optional<uint32_t> queueSizeIO =
         std::nullopt;  // NOLINT(readability-redundant-member-init)
 
-    /** @brief SSL certificate */
+    /**
+     * @brief SSL certificate
+     */
     std::optional<std::string> certificate =
         std::nullopt;  // NOLINT(readability-redundant-member-init)
 
-    /** @brief Username/login */
+    /**
+     * @brief Username/login
+     */
     std::optional<std::string> username =
         std::nullopt;  // NOLINT(readability-redundant-member-init)
 
-    /** @brief Password to match the `username` */
+    /**
+     * @brief Password to match the `username`
+     */
     std::optional<std::string> password =
         std::nullopt;  // NOLINT(readability-redundant-member-init)
 

src/data/cassandra/impl/ExecutionStrategy.hpp

@@ -169,7 +169,7 @@ public:
      *
      * @param preparedStatement Statement to prepare and execute
      * @param args Args to bind to the prepared statement
-     * @throw DatabaseTimeout on timeout
+     * @throws DatabaseTimeout on timeout
      */
     template <typename... Args>
     void
@@ -185,7 +185,7 @@ public:
      * Retries forever with retry policy specified by @ref AsyncExecutor
      *
      * @param statement Statement to execute
-     * @throw DatabaseTimeout on timeout
+     * @throws DatabaseTimeout on timeout
      */
     void
     write(StatementType&& statement)
@@ -215,7 +215,7 @@ public:
      * Retries forever with retry policy specified by @ref AsyncExecutor.
      *
      * @param statements Vector of statements to execute as a batch
-     * @throw DatabaseTimeout on timeout
+     * @throws DatabaseTimeout on timeout
      */
     void
     write(std::vector<StatementType>&& statements)
@@ -254,7 +254,7 @@ public:
      * Retries forever with retry policy specified by @ref AsyncExecutor.
      *
      * @param statements Vector of statements to execute
-     * @throw DatabaseTimeout on timeout
+     * @throws DatabaseTimeout on timeout
      */
     void
     writeEach(std::vector<StatementType>&& statements)
@@ -272,7 +272,7 @@ public:
      * @param token Completion token (yield_context)
      * @param preparedStatement Statement to prepare and execute
      * @param args Args to bind to the prepared statement
-     * @throw DatabaseTimeout on timeout
+     * @throws DatabaseTimeout on timeout
      * @return ResultType or error wrapped in Expected
      */
     template <typename... Args>
@@ -289,7 +289,7 @@ public:
      *
      * @param token Completion token (yield_context)
      * @param statements Statements to execute in a batch
-     * @throw DatabaseTimeout on timeout
+     * @throws DatabaseTimeout on timeout
      * @return ResultType or error wrapped in Expected
      */
     [[maybe_unused]] ResultOrErrorType
@@ -346,7 +346,7 @@ public:
      *
      * @param token Completion token (yield_context)
      * @param statement Statement to execute
-     * @throw DatabaseTimeout on timeout
+     * @throws DatabaseTimeout on timeout
      * @return ResultType or error wrapped in Expected
      */
     [[maybe_unused]] ResultOrErrorType
@@ -402,7 +402,7 @@ public:
      *
      * @param token Completion token (yield_context)
      * @param statements Statements to execute
-     * @throw DatabaseTimeout on db error
+     * @throws DatabaseTimeout on db error
      * @return Vector of results
      */
     std::vector<ResultType>

src/data/cassandra/impl/Future.hpp

@@ -33,7 +33,9 @@ public:
     FutureWithCallback(FutureWithCallback&&) = default;
 
 private:
-    /** Wrapped in a unique_ptr so it can survive std::move :/ */
+    /**
+     * Wrapped in a unique_ptr so it can survive std::move :/
+     */
     FnPtrType cb_;
 };