Added documentation to LombokApp.

1 files changed, 35 insertions, 1 deletions

diff --git a/src/core/lombok/core/LombokApp.java b/src/core/lombok/core/LombokApp.java
index b1984e12..b88db469 100644
--- a/src/core/lombok/core/LombokApp.java
+++ b/src/core/lombok/core/LombokApp.java
@@ -1,6 +1,40 @@
+/*
+ * Copyright © 2009 Reinier Zwitserloot and Roel Spilker.
+ * 
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ * 
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ * 
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
 package lombok.core;
 
+/**
+ * Implement this class, and add yourself as a provider for it, to become an app runnable by running lombok.jar as a jar.
+ * 
+ * @see lombok.delombok.DelombokApp
+ */
 public interface LombokApp {
-	public void runApp(String[] args);
+	/**
+	 * @param args The arguments; analogous to what's passed to {@code public static void main(String[] args)} methods.
+	 * @return The return value. Don't call {@code System.exit} yourself.
+	 */
+	public int runApp(String[] args) throws Exception;
+	
+	/**
+	 * @return Your app name. For example {@code delombok}.
+	 */
 	public String getAppName();
 }