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

Doc fix ups from review. 

* Fix plugin mispellings
* Clarify `select` behavior.
This commit is contained in:
Josh Suereth 2014-03-10 16:12:05 -04:00
parent af25df1777
commit 7413fbe9c0
5 changed files with 8 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
main/src/main/scala/sbt/Plugins.scala
View File

@ -85,7 +85,7 @@ abstract class AutoPlugin extends Plugins.Basic
}
}
/**
* A root AutoPlugin is a plugin which must be explicitly enabled by users in their `setPlugins` method
* A root AutoPlugin is a plugin which must be explicitly enabled by users in their `addPlugins` method
* on a project. However, RootAutoPlugins represent the "root" of a tree of dependent auto-plugins.
*/
abstract class RootAutoPlugin extends AutoPlugin {

4
main/src/main/scala/sbt/PluginsDebug.scala
View File

@ -165,9 +165,9 @@ private[sbt] object PluginsDebug
final case class PluginImpossible(plugin: AutoPlugin, context: Context, contradictions: Set[AutoPlugin]) extends EnableDeactivated
/** Describes the requirements for activating [[plugin]] in [[context]].
* @param context The base plguins, exclusions, and ultimately activated plugins
* @param context The base plugins, exclusions, and ultimately activated plugins
* @param blockingExcludes Existing exclusions that prevent [[plugin]] from being activated and must be dropped
* @param enablingPlguins [[AutoPlugin]]s that are not currently enabled, but need to be enabled for [[plugin]] to activate
* @param enablingPlugins [[AutoPlugin]]s that are not currently enabled, but need to be enabled for [[plugin]] to activate
* @param extraEnabledPlugins Plugins that will be enabled as a result of [[plugin]] activating, but are not required for [[plugin]] to activate
* @param willRemove Plugins that will be deactivated as a result of [[plugin]] activating
* @param deactivate Describes plugins that must be deactivated for [[plugin]] to activate. These require an explicit exclusion or dropping a transitive [[AutoPlugin]].*/

2
main/src/main/scala/sbt/Project.scala
View File

@ -51,7 +51,7 @@ sealed trait ProjectDefinition[PR <: ProjectReference]
def auto: AddSettings
/** The defined [[Plugins]] associated with this project.
A [[AutoPlguin]] is a common label that is used by plugins to determine what settings, if any, to add to a project. */
A [[AutoPlugin]] is a common label that is used by plugins to determine what settings, if any, to add to a project. */
def plugins: Plugins
/** The [[AutoPlugin]]s enabled for this project. This value is only available on a loaded Project. */

3
main/src/main/scala/sbt/plugins/IvyModule.scala
View File

@ -14,7 +14,8 @@ import Def.Setting
* - `publishedArtifacts`
*/
object IvyModule extends AutoPlugin {
// We must be explicitly enabled
// We are automatically included on everything that has the global module,
// which is automatically included on everything.
def select = GlobalModule
override lazy val projectSettings: Seq[Setting[_]] =

3
main/src/main/scala/sbt/plugins/JvmModule.scala
View File

@ -15,7 +15,8 @@ import Def.Setting
* - `Compile`
*/
object JvmModule extends AutoPlugin {
// We must be explicitly enabled
// We are automatically enabled for any IvyModule project. We also require its settings
// for ours to work.
def select = IvyModule
override lazy val projectSettings: Seq[Setting[_]] =