Fix doc

src/data/cassandra/Types.hpp

@@ -67,10 +67,20 @@ struct Limit {
 struct Text {
     std::string text;
 
+    /**
+     * @brief Construct a new Text object from string type
+     *
+     * @param text The text to wrap
+     */
     explicit Text(std::string text) : text{std::move(text)}
     {
     }
 
+    /**
+     * @brief Construct a new Text object from char const* type
+     *
+     * @param text The text to wrap
+     */
     explicit Text(char const* text) : text{text}
     {
     }

src/migration/MigrationApplication.hpp

@@ -58,17 +58,27 @@ class MigratorApplication {
 
         std::variant<Status, Migration, Rollback> state;
 
-        // Helper methods for convenience
+        /**
+         * @brief Helper function to create a status command
+         */
         static Cmd
         status()
         {
             return Cmd{Status{}};
         }
+
+        /**
+         * @brief Helper function to create a migration command
+         */
         static Cmd
         migration(std::string const& name)
         {
             return Cmd{Migration{name}};
         }
+
+        /**
+         * @brief Helper function to create a rollback command
+         */
         static Cmd
         rollback(std::string const& name)
         {
@@ -80,6 +90,7 @@ class MigratorApplication {
      * @brief Construct a new MigratorApplication object
      *
      * @param config The configuration of the application
+     * @param command The command to run
      */
     MigratorApplication(util::Config const& config, Cmd command);
 

src/migration/MigrationManagerInterface.hpp

@@ -58,12 +58,17 @@ struct MigrationManagerInterface {
 
     /**
      * @brief Get all registered migrators' names
+     *
+     * @return A vector of migrators' names
      */
     virtual std::vector<std::string>
     allMigratorsNames() const = 0;
 
     /**
      * @brief Get the status of a migrator by its name
+     *
+     * @param name The migrator's name
+     * @return The status of the migrator
      */
     virtual MigratorStatus
     getMigratorStatusByName(std::string const& name) const = 0;

src/migration/README.md

@@ -76,7 +76,7 @@ If you need to do full scan against other table, you can follow below steps:
     - `PARTITION_KEY`, it's the name of the partition key of the table.
     > **Note** The order of types should match what database will return in a row. Key types should come first, followed by other field types sorted in alphabetical order.
     - `TABLE_NAME`
-    
+
 - Inherent from `FullTableScannerAdapterBase`.
 - Implement `onRowRead`, its parameter is the `Row` we defined. It's the callback function when a row is read.
 

src/migration/cassandra/FullTableScanner.hpp

@@ -43,6 +43,12 @@ struct TokenRange {
     std::int64_t start;
     std::int64_t end;
 
+    /**
+     * @brief Construct a new Token Range object
+     *
+     * @param start The start token
+     * @param end The end token
+     */
     TokenRange(std::int64_t start, std::int64_t end) : start{start}, end{end}
     {
     }

src/migration/cassandra/FullTableScannerAdapterBase.hpp

@@ -40,14 +40,20 @@ template <TableSpec TableDesc>
 struct FullTableScannerAdapterBase {
     static_assert(TableSpec<TableDesc>);
 
+protected:
+    /**
+     * @brief The backend to use
+     */
+    std::shared_ptr<CassandraMigrationBackend> backend_;
+
+public:
     virtual ~FullTableScannerAdapterBase() = default;
 
     /**
      * @brief Construct a new Full Table Scanner Adapter Base object
      *
      * @param backend The backend
      */
-    std::shared_ptr<CassandraMigrationBackend> backend_;
     FullTableScannerAdapterBase(std::shared_ptr<CassandraMigrationBackend> backend) : backend_(std::move(backend))
     {
     }

src/migration/cassandra/TransactionsAdapter.hpp

@@ -67,6 +67,8 @@ class TransactionsAdapter : public FullTableScannerAdapterBase<TableTransactions
 
     /**
      *@brief The callback when a row is read.
+     *
+     *@param row The row to read
      */
     void
     onRowRead(TableTransactionsDesc::Row const& row) override;