Merge pull request #35 from momosetkn/feat/kdoc

Fix KDoc
momosetkn · Sep 24, 2024 · abfbc69 · abfbc69
2 parents 2930df1 + 264301f
commit abfbc69
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 2 deletions.
diff --git a/dsl/src/main/kotlin/momosetkn/liquibase/kotlin/dsl/ChangeSetDsl.kt b/dsl/src/main/kotlin/momosetkn/liquibase/kotlin/dsl/ChangeSetDsl.kt
@@ -1327,8 +1327,8 @@ class ChangeSetDsl(
      * [official-document](https://docs.liquibase.com/change-types/custom-change.html)
      *
      * @param `class` specify KClass or Class<*> of CustomChange or className of CustomChange.
-     * @param clazz specify KClass or Class<*> of CustomChange or className of CustomChange.
-     * @param className className of CustomChange.
+     * @param clazz specify KClass or Class<*> of CustomChange or className of CustomChange. not official param.
+     * @param className className of CustomChange. not official param.
      * @param block Key-value to be given to CustomChange.
      */
     fun customChange(

diff --git a/dsl/src/main/kotlin/momosetkn/liquibase/kotlin/dsl/PreConditionDsl.kt b/dsl/src/main/kotlin/momosetkn/liquibase/kotlin/dsl/PreConditionDsl.kt
@@ -238,6 +238,17 @@ class PreConditionDsl<PRECONDITION_LOGIC : PreconditionLogic>(
         preConditions.add(precondition)
     }
 
+    /**
+     * Applies a custom-precondition to the preconditions.
+     * This function requires at least one of the parameters `class`, `clazz`, or `className`.
+     * Class is requiring implements the [liquibase.precondition.CustomPrecondition]
+     * [official-document](https://docs.liquibase.com/concepts/changelogs/preconditions.html)
+     *
+     * @param `class` specify KClass or Class<*> of CustomChange or className of CustomChange.
+     * @param clazz specify KClass or Class<*> of CustomChange or className of CustomChange. not official param.
+     * @param className className of CustomChange. not official param.
+     * @param block Key-value to be given to CustomChange.
+     */
     fun customPrecondition(
         @Suppress("FunctionParameterNaming")
         `class`: Any? = null,