clarify behavior of State.reload

This commit is contained in:
Mark Harrah 2012-01-19 11:00:24 -05:00
parent 58d6f34dd5
commit 3a0938878d
1 changed files with 3 additions and 1 deletions

View File

@ -64,7 +64,9 @@ trait StateOps {
@deprecated("Use setNext", "0.11.0") def setResult(ro: Option[xsbti.MainResult]): State
/** Restarts sbt without dropping loaded Scala classes. It is a shallower restart than `reboot`.*/
/** Restarts sbt without dropping loaded Scala classes. It is a shallower restart than `reboot`.
* This method takes a snapshot of the remaining commands and will resume executing those commands after reload.
* This means that any commands added to this State will be dropped.*/
def reload: State
/** Sets the next command processing action to be to rotate the global log and continue executing commands.*/