Skip to content

Commit

Permalink
docs: updated outdated docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
jenspots committed Jul 4, 2024
1 parent f059de2 commit f414028
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions src/main/kotlin/runner/jvm/Processor.kt
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ import technology.idlab.util.Log

abstract class Processor(
/**
* The arguments of a processor are stored in a map and can be accessed by name. At the time of
* writing, the user must manually cast the arguments to the correct type.
* The arguments of a processor are stored in a map and can be accessed by name. Type safety is
* assured through the use of Kotlin reflection.
*/
protected val arguments: Arguments,
) {
Expand All @@ -16,5 +16,9 @@ abstract class Processor(
*/
@JvmField protected val log = Log.shared

/**
* The `exec` function will be called when the pipeline executes. All inter-processor
* communication must happen here, and not in the constructor.
*/
abstract suspend fun exec()
}

0 comments on commit f414028

Please sign in to comment.