Skip to content
Snippets Groups Projects

Resolve "Add KDocs for all classes, interfaces, public methods"

Closed Lorenz Boguhn requested to merge stu203404/theodolite:140-add-kdoc into theodolite-kotlin
48 files
+ 650
58
Compare changes
  • Side-by-side
  • Inline
Files
48
@@ -5,8 +5,20 @@ import theodolite.util.ConfigurationOverride
import theodolite.util.LoadDimension
import theodolite.util.Resource
/**
* A Benchmark contains:
* - The resources to be benchmarked.
* - The [Resource]s that can be scaled for the benchmark.
* - The [LoadDimension]s that can be scaled the benchmark.
* - additional infrastructure configurations.
*/
@RegisterForReflection
interface Benchmark {
/**
* Builds a Deployment that can be deployed.
* @return a BenchmarkDeployment.
*/
fun buildDeployment(
load: LoadDimension,
res: Resource,
Loading