docs: Build docs using doxygen 1.14.0 (#2681)

src/data/README.md

@@ -1,4 +1,6 @@
-# Backend
+# Backend
+
+@page "backend" Backend
 
 The backend of Clio is responsible for handling the proper reading and writing of past ledger data from and to a given database. Currently, Cassandra and ScyllaDB are the only supported databases that are production-ready.
 

src/data/cassandra/CassandraBackendFamily.hpp

@@ -146,9 +146,6 @@ public:
      */
     CassandraBackendFamily(CassandraBackendFamily&&) = delete;
 
-    /**
-     * @copydoc BackendInterface::fetchAccountTransactions
-     */
     TransactionsAndCursor
     fetchAccountTransactions(
         ripple::AccountID const& account,
@@ -217,18 +214,12 @@ public:
         return {txns, {}};
     }
 
-    /**
-     * @copydoc BackendInterface::waitForWritesToFinish
-     */
     void
     waitForWritesToFinish() override
     {
         executor_.sync();
     }
 
-    /**
-     * @copydoc BackendInterface::writeLedger
-     */
     void
     writeLedger(ripple::LedgerHeader const& ledgerHeader, std::string&& blob) override
     {
@@ -239,9 +230,6 @@ public:
         ledgerSequence_ = ledgerHeader.seq;
     }
 
-    /**
-     * @copydoc BackendInterface::fetchLatestLedgerSequence
-     */
     std::optional<std::uint32_t>
     fetchLatestLedgerSequence(boost::asio::yield_context yield) const override
     {
@@ -262,9 +250,6 @@ public:
         return std::nullopt;
     }
 
-    /**
-     * @copydoc BackendInterface::fetchLedgerBySequence
-     */
     std::optional<ripple::LedgerHeader>
     fetchLedgerBySequence(std::uint32_t const sequence, boost::asio::yield_context yield) const override
     {
@@ -292,9 +277,6 @@ public:
         return std::nullopt;
     }
 
-    /**
-     * @copydoc BackendInterface::fetchLedgerByHash
-     */
     std::optional<ripple::LedgerHeader>
     fetchLedgerByHash(ripple::uint256 const& hash, boost::asio::yield_context yield) const override
     {
@@ -315,9 +297,6 @@ public:
         return std::nullopt;
     }
 
-    /**
-     * @copydoc BackendInterface::hardFetchLedgerRange(boost::asio::yield_context) const
-     */
     std::optional<LedgerRange>
     hardFetchLedgerRange(boost::asio::yield_context yield) const override
     {
@@ -356,9 +335,6 @@ public:
         return std::nullopt;
     }
 
-    /**
-     * @copydoc BackendInterface::fetchAllTransactionsInLedger
-     */
     std::vector<TransactionAndMetadata>
     fetchAllTransactionsInLedger(std::uint32_t const ledgerSequence, boost::asio::yield_context yield) const override
     {
@@ -366,9 +342,6 @@ public:
         return fetchTransactions(hashes, yield);
     }
 
-    /**
-     * @copydoc BackendInterface::fetchAllTransactionHashesInLedger
-     */
     std::vector<ripple::uint256>
     fetchAllTransactionHashesInLedger(
         std::uint32_t const ledgerSequence,
@@ -402,9 +375,6 @@ public:
         return hashes;
     }
 
-    /**
-     * @copydoc BackendInterface::fetchNFT
-     */
     std::optional<NFT>
     fetchNFT(
         ripple::uint256 const& tokenID,
@@ -444,9 +414,6 @@ public:
         return std::nullopt;
     }
 
-    /**
-     * @copydoc BackendInterface::fetchNFTTransactions
-     */
     TransactionsAndCursor
     fetchNFTTransactions(
         ripple::uint256 const& tokenID,
@@ -518,9 +485,6 @@ public:
         return {txns, {}};
     }
 
-    /**
-     * @copydoc BackendInterface::fetchMPTHolders
-     */
     MPTHoldersAndCursor
     fetchMPTHolders(
         ripple::uint192 const& mptID,
@@ -560,9 +524,6 @@ public:
         return {mptObjects, {}};
     }
 
-    /**
-     * @copydoc BackendInterface::doFetchLedgerObject
-     */
     std::optional<Blob>
     doFetchLedgerObject(
         ripple::uint256 const& key,
@@ -585,9 +546,6 @@ public:
         return std::nullopt;
     }
 
-    /**
-     * @copydoc BackendInterface::doFetchLedgerObjectSeq
-     */
     std::optional<std::uint32_t>
     doFetchLedgerObjectSeq(
         ripple::uint256 const& key,
@@ -609,9 +567,6 @@ public:
         return std::nullopt;
     }
 
-    /**
-     * @copydoc BackendInterface::fetchTransaction
-     */
     std::optional<TransactionAndMetadata>
     fetchTransaction(ripple::uint256 const& hash, boost::asio::yield_context yield) const override
     {
@@ -629,9 +584,6 @@ public:
         return std::nullopt;
     }
 
-    /**
-     * @copydoc BackendInterface::doFetchSuccessorKey
-     */
     std::optional<ripple::uint256>
     doFetchSuccessorKey(
         ripple::uint256 key,
@@ -654,9 +606,6 @@ public:
         return std::nullopt;
     }
 
-    /**
-     * @copydoc BackendInterface::fetchTransactions
-     */
     std::vector<TransactionAndMetadata>
     fetchTransactions(std::vector<ripple::uint256> const& hashes, boost::asio::yield_context yield) const override
     {
@@ -698,9 +647,6 @@ public:
         return results;
     }
 
-    /**
-     * @copydoc BackendInterface::doFetchLedgerObjects
-     */
     std::vector<Blob>
     doFetchLedgerObjects(
         std::vector<ripple::uint256> const& keys,
@@ -741,9 +687,6 @@ public:
         return results;
     }
 
-    /**
-     * @copydoc BackendInterface::fetchLedgerDiff
-     */
     std::vector<LedgerObject>
     fetchLedgerDiff(std::uint32_t const ledgerSequence, boost::asio::yield_context yield) const override
     {
@@ -789,9 +732,6 @@ public:
         return results;
     }
 
-    /**
-     * @copydoc BackendInterface::fetchMigratorStatus
-     */
     std::optional<std::string>
     fetchMigratorStatus(std::string const& migratorName, boost::asio::yield_context yield) const override
     {
@@ -812,9 +752,6 @@ public:
         return {};
     }
 
-    /**
-     * @copydoc BackendInterface::fetchClioNodesData
-     */
     std::expected<std::vector<std::pair<boost::uuids::uuid, std::string>>, std::string>
     fetchClioNodesData(boost::asio::yield_context yield) const override
     {
@@ -831,9 +768,6 @@ public:
         return result;
     }
 
-    /**
-     * @copydoc BackendInterface::doWriteLedgerObject
-     */
     void
     doWriteLedgerObject(std::string&& key, std::uint32_t const seq, std::string&& blob) override
     {
@@ -845,9 +779,6 @@ public:
         executor_.write(schema_->insertObject, std::move(key), seq, std::move(blob));
     }
 
-    /**
-     * @copydoc BackendInterface::writeSuccessor
-     */
     void
     writeSuccessor(std::string&& key, std::uint32_t const seq, std::string&& successor) override
     {
@@ -859,9 +790,6 @@ public:
         executor_.write(schema_->insertSuccessor, std::move(key), seq, std::move(successor));
     }
 
-    /**
-     * @copydoc BackendInterface::writeAccountTransactions
-     */
     void
     writeAccountTransactions(std::vector<AccountTransactionsData> data) override
     {
@@ -881,9 +809,6 @@ public:
         executor_.write(std::move(statements));
     }
 
-    /**
-     * @copydoc BackendInterface::writeAccountTransaction
-     */
     void
     writeAccountTransaction(AccountTransactionsData record) override
     {
@@ -901,9 +826,6 @@ public:
         executor_.write(std::move(statements));
     }
 
-    /**
-     * @copydoc BackendInterface::writeNFTTransactions
-     */
     void
     writeNFTTransactions(std::vector<NFTTransactionsData> const& data) override
     {
@@ -919,9 +841,6 @@ public:
         executor_.write(std::move(statements));
     }
 
-    /**
-     * @copydoc BackendInterface::writeTransaction
-     */
     void
     writeTransaction(
         std::string&& hash,
@@ -939,9 +858,6 @@ public:
         );
     }
 
-    /**
-     * @copydoc BackendInterface::writeNFTs
-     */
     void
     writeNFTs(std::vector<NFTsData> const& data) override
     {
@@ -980,9 +896,6 @@ public:
         executor_.writeEach(std::move(statements));
     }
 
-    /**
-     * @copydoc BackendInterface::writeNFTs
-     */
     void
     writeMPTHolders(std::vector<MPTHolderData> const& data) override
     {
@@ -994,9 +907,6 @@ public:
         executor_.write(std::move(statements));
     }
 
-    /**
-     * @copydoc BackendInterface::startWrites
-     */
     void
     startWrites() const override
     {
@@ -1004,9 +914,6 @@ public:
         // probably was used in PG to start a transaction or smth.
     }
 
-    /**
-     * @copydoc BackendInterface::writeMigratorStatus
-     */
     void
     writeMigratorStatus(std::string const& migratorName, std::string const& status) override
     {
@@ -1015,27 +922,18 @@ public:
         );
     }
 
-    /**
-     * @copydoc BackendInterface::writeNodeMessage
-     */
     void
     writeNodeMessage(boost::uuids::uuid const& uuid, std::string message) override
     {
         executor_.writeSync(schema_->updateClioNodeMessage, data::cassandra::Text{std::move(message)}, uuid);
     }
 
-    /**
-     * @copydoc BackendInterface::isTooBusy
-     */
     bool
     isTooBusy() const override
     {
         return executor_.isTooBusy();
     }
 
-    /**
-     * @copydoc BackendInterface::stats
-     */
     boost::json::object
     stats() const override
     {