Fixed doc links

Author: gammelalf

src/migrate/config.rs

@@ -7,9 +7,7 @@ use anyhow::Context;
 use rorm_declaration::config::DatabaseConfig;
 use serde::{Deserialize, Serialize};
 
-/**
-Outer wrapper for the database configuration file.
-*/
+/// Outer wrapper for the database configuration file.
 #[derive(Serialize, Deserialize, Debug, Clone)]
 #[serde(rename_all = "PascalCase")]
 pub struct DatabaseConfigFile {
@@ -61,9 +59,7 @@ mod test {
     }
 }
 
-/**
-Helper method to create a dummy database configuration file
- */
+/// Helper method to create a dummy database configuration file
 pub(crate) fn create_db_config(path: &Path) -> anyhow::Result<()> {
     let fh = File::create(path).with_context(|| format!("Couldn't open {path:?} for writing"))?;
 
@@ -74,11 +70,9 @@ pub(crate) fn create_db_config(path: &Path) -> anyhow::Result<()> {
     Ok(())
 }
 
-/**
-Helper method to deserialize an existing database configuration file
-
-`path`: [&Path]: Path to the configuration file
- */
+/// Helper method to deserialize an existing database configuration file
+///
+/// - `path`: [`&Path`](Path): Path to the configuration file
 pub fn deserialize_db_conf(path: &Path) -> anyhow::Result<DatabaseConfig> {
     let db_conf_toml =
         read_to_string(path).with_context(|| "Couldn't read database configuration file")?;

src/migrate/mod.rs

@@ -19,9 +19,7 @@ use crate::utils::migrations::get_existing_migrations;
 pub mod config;
 pub mod sql_builder;
 
-/**
-Options for running migrations
-*/
+/// Options for running migrations
 pub struct MigrateOptions {
     /// Directory, migrations exist in
     pub migration_dir: String,
@@ -36,21 +34,19 @@ pub struct MigrateOptions {
     pub apply_until: Option<u16>,
 }
 
-/**
-Helper method to apply one migration. Writes also to last migration table.
-
-`migration`: [&Migration]: Reference to the migration to apply.
-`pool`: [&SqlitePool]: Pool to apply the migration onto.
-`last_migration_table_name`: [&str]: Name of the table to insert successful applied migrations into.
-*/
+/// Helper method to apply one migration. Writes also to last migration table.
+///
+/// - `migration`: [`&Migration`](Migration): Reference to the migration to apply.
+/// - `db`: [`&Database`](Database): Database to apply the migration onto.
+/// - `last_migration_table_name`: [`&str`]: Name of the table to insert successful applied migrations into.
 pub async fn apply_migration(
     dialect: DBImpl,
     migration: &Migration,
-    pool: &Database,
+    db: &Database,
     last_migration_table_name: &str,
     do_log: bool,
 ) -> anyhow::Result<()> {
-    let mut tx = pool
+    let mut tx = db
         .start_transaction()
         .await
         .with_context(|| format!("Error while starting transaction {}", migration.id))?;
@@ -72,7 +68,7 @@ pub async fn apply_migration(
         println!("{query_string}");
     }
 
-    pool.execute::<Nothing>(query_string, bind_params).await.with_context(|| {
+    db.execute::<Nothing>(query_string, bind_params).await.with_context(|| {
         format!(
             "Error while inserting applied migration {last_migration_table_name} into last migration table",
         )

src/migrate/sql_builder.rs

@@ -7,12 +7,10 @@ use rorm_sql::drop_table::DropTable;
 use rorm_sql::value::Value;
 use rorm_sql::DBImpl;
 
-/**
-Helper method to convert a migration to a transaction string
-
-`db_impl`: [DBImpl]: The database implementation to use.
-`migration`: [&Migration]: Reference to the migration that should be converted.
-*/
+/// Helper method to convert a migration to a transaction string
+///
+/// - `db_impl`: [`DBImpl`]: The database implementation to use.
+/// - `migration`: [`&Migration`](Migration): Reference to the migration that should be converted.
 pub async fn migration_to_sql<'a>(
     tx: &'a mut Transaction,
     db_impl: DBImpl,