Skip to content
Snippets Groups Projects

Add Kdoc

Merged Lorenz Boguhn requested to merge stu203404/theodolite:140-add-kdoc into theodolite-kotlin
Files
54
@@ -5,8 +5,19 @@ import theodolite.util.ConfigurationOverride
@@ -5,8 +5,19 @@ import theodolite.util.ConfigurationOverride
import theodolite.util.LoadDimension
import theodolite.util.LoadDimension
import theodolite.util.Resource
import theodolite.util.Resource
 
/**
 
* A Benchmark contains:
 
* - The [Resource]s that can be scaled for the benchmark.
 
* - The [LoadDimension]s that can be scaled the benchmark.
 
* - additional [ConfigurationOverride]s.
 
*/
@RegisterForReflection
@RegisterForReflection
interface Benchmark {
interface Benchmark {
 
 
/**
 
* Builds a Deployment that can be deployed.
 
* @return a BenchmarkDeployment.
 
*/
fun buildDeployment(
fun buildDeployment(
load: LoadDimension,
load: LoadDimension,
res: Resource,
res: Resource,
Loading