# HG changeset patch
# User Jaroslav Tulach <jtulach@netbeans.org>
# Date 1401994916 -7200
# Node ID 055a0f3766f57f861796bc7b666d7ced748519a8
# Parent  82773e03ff40a2d7140efc2c06bc149663c8a68d
A bit of documentation

diff -r 82773e03ff40 -r 055a0f3766f5 boot-script/src/main/java/net/java/html/boot/script/Scripts.java
--- a/boot-script/src/main/java/net/java/html/boot/script/Scripts.java	Thu Jun 05 20:27:54 2014 +0200
+++ b/boot-script/src/main/java/net/java/html/boot/script/Scripts.java	Thu Jun 05 21:01:56 2014 +0200
@@ -44,10 +44,25 @@
 
 import java.util.concurrent.Executor;
 import javax.script.ScriptEngine;
+import net.java.html.boot.BrowserBuilder;
+import net.java.html.js.JavaScriptBody;
 import org.apidesign.html.boot.spi.Fn.Presenter;
 
 /** Implementations of {@link Presenter}s that delegate
- * to Java {@link ScriptEngine scripting} API.
+ * to Java {@link ScriptEngine scripting} API. Initialize your presenter
+ * like this:
+ * 
+ * <pre>
+ * 
+ * {@link Runnable} <em>run</em> = ...; // your own init code
+ * {@link Presenter Fn.Presenter} <em>p</em> = Scripts.{@link Scripts#createPresenter()};
+ * BrowserBuilder.{@link BrowserBuilder#newBrowser(java.lang.Object...) newBrowser(<em>p</em>)}.
+ *      {@link BrowserBuilder#loadFinished(java.lang.Runnable) loadFinished(run)}.
+ *      {@link BrowserBuilder#showAndWait()};
+ * </pre>
+ * 
+ * and your runnable can make extensive use of {@link JavaScriptBody} directly or
+ * indirectly via APIs using {@link JavaScriptBody such annotation} themselves.
  * 
  * @author Jaroslav Tulach
  */
@@ -69,8 +84,9 @@
         return new ScriptPresenter(null);
     }
 
-    /** Simple implementation of {@link Presenter} that delegates
-     * to Java {@link ScriptEngine scripting} API. The presenter runs headless
+    /** Implementation of {@link Presenter} that delegates
+     * to Java {@link ScriptEngine scripting} API and can control execution
+     * thread. The presenter runs headless
      * without appropriate simulation of browser APIs. Its primary usefulness
      * is inside testing environments. The presenter implements {@link Executor}
      * interface, and passes all runnables from {@link Executor#execute(java.lang.Runnable)}
diff -r 82773e03ff40 -r 055a0f3766f5 boot-script/src/main/java/net/java/html/boot/script/package.html
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/boot-script/src/main/java/net/java/html/boot/script/package.html	Thu Jun 05 21:01:56 2014 +0200
@@ -0,0 +1,51 @@
+<!--
+
+    DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
+
+    Copyright 2013-2014 Oracle and/or its affiliates. All rights reserved.
+
+    Oracle and Java are registered trademarks of Oracle and/or its affiliates.
+    Other names may be trademarks of their respective owners.
+
+    The contents of this file are subject to the terms of either the GNU
+    General Public License Version 2 only ("GPL") or the Common
+    Development and Distribution License("CDDL") (collectively, the
+    "License"). You may not use this file except in compliance with the
+    License. You can obtain a copy of the License at
+    http://www.netbeans.org/cddl-gplv2.html
+    or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
+    specific language governing permissions and limitations under the
+    License.  When distributing the software, include this License Header
+    Notice in each file and include the License file at
+    nbbuild/licenses/CDDL-GPL-2-CP.  Oracle designates this
+    particular file as subject to the "Classpath" exception as provided
+    by Oracle in the GPL Version 2 section of the License file that
+    accompanied this code. If applicable, add the following below the
+    License Header, with the fields enclosed by brackets [] replaced by
+    your own identifying information:
+    "Portions Copyrighted [year] [name of copyright owner]"
+
+    Contributor(s):
+
+    The Original Software is NetBeans. The Initial Developer of the Original
+    Software is Oracle. Portions Copyright 2013-2014 Oracle. All Rights Reserved.
+
+    If you wish your version of this file to be governed by only the CDDL
+    or only the GPL Version 2, indicate your decision by adding
+    "[Contributor] elects to include this software in this distribution
+    under the [CDDL or GPL Version 2] license." If you do not indicate a
+    single choice of license, a recipient has the option to distribute
+    your version of this file under either the CDDL, the GPL Version 2 or
+    to extend the choice of license to its licensees as provided above.
+    However, if you add GPL Version 2 code and therefore, elected the GPL
+    Version 2 license, then the option applies only if the new code is
+    made subject to such option by the copyright holder.
+
+-->
+<body>
+    <p>
+        {@link net.java.html.boot.script.Scripts Factories} headless
+        {@link net.java.html.boot.BrowserBuilder browser environment}
+        useful for testing.
+    </p>
+</body>
diff -r 82773e03ff40 -r 055a0f3766f5 boot/src/main/java/net/java/html/boot/BrowserBuilder.java
--- a/boot/src/main/java/net/java/html/boot/BrowserBuilder.java	Thu Jun 05 20:27:54 2014 +0200
+++ b/boot/src/main/java/net/java/html/boot/BrowserBuilder.java	Thu Jun 05 21:01:56 2014 +0200
@@ -72,7 +72,7 @@
  * <pre>
  * 
  * <b>public static void</b> <em>main</em>(String... args) {
- *     BrowserBuilder.{@link #newBrowser}.
+ *     BrowserBuilder.{@link #newBrowser newBrowser()}.
  *          {@link #loadClass(java.lang.Class) loadClass(YourMain.class)}.
  *          {@link #loadPage(java.lang.String) loadPage("index.html")}.
  *          {@link #invoke(java.lang.String, java.lang.String[]) invoke("initialized", args)}.
diff -r 82773e03ff40 -r 055a0f3766f5 pom.xml
--- a/pom.xml	Thu Jun 05 20:27:54 2014 +0200
+++ b/pom.xml	Thu Jun 05 21:01:56 2014 +0200
@@ -137,6 +137,10 @@
                     <packages>net.java.html.sound</packages>
                   </group>
                   <group>
+                    <title>Testing and Headless API</title>
+                    <packages>net.java.html.boot.script</packages>
+                  </group>
+                  <group>
                     <title>Service Provider APIs (not commonly interesting)</title>
                     <packages>org.apidesign.html.*</packages>
                   </group>