From 3e6760f8f527dff1baa8fa9c028036685eb76fca Mon Sep 17 00:00:00 2001 From: Cedric Beust Date: Mon, 23 Nov 2015 22:51:57 -0800 Subject: [PATCH] =?UTF-8?q?Better=20documentation.=E2=80=A8?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- src/main/kotlin/com/beust/kobalt/api/IRunContributor.kt | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/src/main/kotlin/com/beust/kobalt/api/IRunContributor.kt b/src/main/kotlin/com/beust/kobalt/api/IRunContributor.kt index e5dcecad..16c05a3b 100644 --- a/src/main/kotlin/com/beust/kobalt/api/IRunContributor.kt +++ b/src/main/kotlin/com/beust/kobalt/api/IRunContributor.kt @@ -3,10 +3,14 @@ package com.beust.kobalt.api import com.beust.kobalt.TaskResult /** - * Plugins that can implement the "task" run should implement this interface. + * Plugins that can run a project (task "run") should implement this interface. */ interface IRunContributor : IContributor { companion object { + /** + * The recommended default affinity if your plug-in can run this project. Use a higher + * number if you expect to compete against other runners and you'd like to win over them. + */ const val DEFAULT_POSITIVE_AFFINITY = 100 }