Merge pull request #1064 from jaceklaskowski/javadoc-changes

Javadoc changes
This commit is contained in:
Josh Suereth
2014-04-07 10:02:35 -04:00
3 changed files with 18 additions and 10 deletions
@@ -1,7 +1,9 @@
package xsbti;
/** A launched application returns an instance of this class in order to communicate to the launcher
* that the application is completely finished and the launcher should exit with the given exit code.*/
/**
* A launched application returns an instance of this class in order to communicate to the launcher
* that the application finished and the launcher should exit with the given exit code.
*/
public interface Exit extends MainResult
{
public int code();
@@ -1,8 +1,12 @@
package xsbti;
/** A launched application should return an instance of this from its 'run' method
* to communicate to the launcher what should be done now that the application
* has competed. This interface should be treated as 'sealed', with Exit and Reboot the only
* direct subtypes.
*/
/**
* A launched application should return an instance of this from its 'run' method
* to communicate to the launcher what should be done now that the application
* has completed. This interface should be treated as 'sealed', with Exit and Reboot the only
* direct subtypes.
*
* @see xsbti.Exit
* @see xsbti.Reboot
*/
public interface MainResult {}
@@ -2,9 +2,11 @@ package xsbti;
import java.io.File;
/** A launched application returns an instance of this class in order to communicate to the launcher
* that the application should be restarted. Different versions of the application and Scala can be used.
* The application can be given different arguments and a new working directory as well.*/
/**
* A launched application returns an instance of this class in order to communicate to the launcher
* that the application should be restarted. Different versions of the application and Scala can be used.
* The application can be given different arguments as well as a new working directory.
*/
public interface Reboot extends MainResult
{
public String[] arguments();