From 708a3b107bfa22e55ca40fb4241730c130cf1338 Mon Sep 17 00:00:00 2001 From: Mark Harrah Date: Sat, 8 Feb 2014 10:23:31 -0500 Subject: [PATCH] minor API updates --- main/src/main/scala/sbt/AutoPlugin.scala | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/main/src/main/scala/sbt/AutoPlugin.scala b/main/src/main/scala/sbt/AutoPlugin.scala index 3f217bb6b..182d531f6 100644 --- a/main/src/main/scala/sbt/AutoPlugin.scala +++ b/main/src/main/scala/sbt/AutoPlugin.scala @@ -9,15 +9,15 @@ package sbt trait AutoImport /** -An AutoPlugin defines a group of settings and the conditions that the settings are automatically added to a build (called "activation"). +An AutoPlugin defines a group of settings and the conditions where the settings are automatically added to a build (called "activation"). The `select` method defines the conditions, `provides` defines an identifier for the AutoPlugin, and a method like `projectSettings` defines the settings to add. Steps for plugin authors: -1. Determine the natures that, when present (or absent), activate the AutoPlugin. +1. Determine the [[Nature]]s that, when present (or absent), activate the AutoPlugin. 2. Determine the settings/configurations to automatically inject when activated. -3. Define a new, unique identifying [[Nature]], which is a wrapper around a String ID. +3. Define a new, unique identifying [[Nature]] associated with the AutoPlugin, where a Nature is essentially a String ID. For example, the following will automatically add the settings in `projectSettings` to a project that has both the `Web` and `Javascript` natures enabled. It will itself