Skip to content

Commit

Permalink
Fix kdoc
Browse files Browse the repository at this point in the history
  • Loading branch information
jan-goral authored and mergify-bot committed Jul 26, 2021
1 parent c3b7e50 commit 2efede9
Showing 1 changed file with 9 additions and 9 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@ import flank.exection.parallel.plantuml.internal.generatePlantUmlString
import java.io.File

/**
* Generates plant uml file and save on drive.
* Generates plantuml file and saves on drive.
*
* @receiver Source object of execution. Used for generating filename and reducing tasks names.
* @param tasks Tasks relations graph required to generate diagram.
* @param dir optional path to directory for generated file.
* @param tasks Graph of tasks required to generate diagram.
* @param dir Optional path to directory for generated file.
*/
fun Any.generatePlanUml(
tasks: Tasks,
Expand All @@ -22,9 +22,9 @@ fun Any.generatePlanUml(
)

/**
* Generates plant uml file and save on drive.
* Generates plantuml file and saves on drive.
*
* @param tasks Tasks relations graph required to generate diagram.
* @param tasks Graph of tasks required to generate diagram.
* @param path Path to generated file.
* @param prefixToRemove Optional prefix to remove from each task name.
*/
Expand All @@ -39,10 +39,10 @@ fun generatePlanUml(
)

/**
* Generates plant uml string.
* Generates plantuml string.
*
* @receiver Source object of execution. Used for reducing tasks names.
* @param tasks Tasks relations graph required to generate diagram.
* @param tasks Graph of tasks required to generate diagram.
*/
fun Any.generatePlantUml(
tasks: Tasks
Expand All @@ -52,9 +52,9 @@ fun Any.generatePlantUml(
)

/**
* Generates plant uml string.
* Generates plantuml string.
*
* @param tasks Tasks relations graph required to generate diagram.
* @param tasks Graph of tasks required to generate diagram.
* @param prefixToRemove Optional prefix to remove from each task name.
*/
fun generatePlantUml(
Expand Down

0 comments on commit 2efede9

Please sign in to comment.