luke
/
sbt
mirror of https://github.com/sbt/sbt.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

minor API updates

This commit is contained in:
Mark Harrah 2014-02-08 10:23:31 -05:00
parent 4feb7d3dc8
commit 708a3b107b
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
main/src/main/scala/sbt/AutoPlugin.scala
View File

@ -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