Javadoc and descriptions for individual modules
authorJaroslav Tulach <jaroslav.tulach@apidesign.org>
Tue, 27 Aug 2013 07:27:51 +0000
changeset 263e52df26d579b
parent 262 30b03f2c82af
child 264 6656cca0a73a
Javadoc and descriptions for individual modules
boot-fx/pom.xml
boot/pom.xml
context/pom.xml
geo/pom.xml
json-tck/pom.xml
json/pom.xml
ko-fx/pom.xml
ko-ws-tyrus/pom.xml
ko-ws-tyrus/src/main/java/org/apidesign/html/wstyrus/TyrusContext.java
     1.1 --- a/boot-fx/pom.xml	Sun Aug 25 17:41:21 2013 +0200
     1.2 +++ b/boot-fx/pom.xml	Tue Aug 27 07:27:51 2013 +0000
     1.3 @@ -51,4 +51,6 @@
     1.4        <type>jar</type>
     1.5      </dependency>
     1.6    </dependencies>
     1.7 +    <description>A presentation provider to show JavaFX WebView 
     1.8 +when a Java/HTML based application is about to boot.</description>
     1.9  </project>
     2.1 --- a/boot/pom.xml	Sun Aug 25 17:41:21 2013 +0200
     2.2 +++ b/boot/pom.xml	Tue Aug 27 07:27:51 2013 +0000
     2.3 @@ -45,4 +45,5 @@
     2.4        <scope>provided</scope>
     2.5      </dependency>
     2.6    </dependencies>
     2.7 +    <description>Builder to launch your Java/HTML based application.</description>
     2.8  </project>
     3.1 --- a/context/pom.xml	Sun Aug 25 17:41:21 2013 +0200
     3.2 +++ b/context/pom.xml	Tue Aug 27 07:27:51 2013 +0000
     3.3 @@ -28,4 +28,5 @@
     3.4    </build>
     3.5    <dependencies>
     3.6    </dependencies>
     3.7 +    <description>Representation of an HTML page context a Java program operates in.</description>
     3.8  </project>
     4.1 --- a/geo/pom.xml	Sun Aug 25 17:41:21 2013 +0200
     4.2 +++ b/geo/pom.xml	Tue Aug 27 07:27:51 2013 +0000
     4.3 @@ -43,4 +43,5 @@
     4.4        <type>jar</type>
     4.5      </dependency>
     4.6    </dependencies>
     4.7 +    <description>Find out where your Java program running in an HTML page is!</description>
     4.8  </project>
     5.1 --- a/json-tck/pom.xml	Sun Aug 25 17:41:21 2013 +0200
     5.2 +++ b/json-tck/pom.xml	Tue Aug 27 07:27:51 2013 +0000
     5.3 @@ -52,4 +52,6 @@
     5.4        <scope>provided</scope>
     5.5      </dependency>
     5.6    </dependencies>
     5.7 +    <description>Test Compatibility Kit for anyone who wants to consume the net.java.html.json APIs and
     5.8 +render their objects using own technology (e.g. own browser, MVVC, etc.).</description>
     5.9  </project>
     6.1 --- a/json/pom.xml	Sun Aug 25 17:41:21 2013 +0200
     6.2 +++ b/json/pom.xml	Tue Aug 27 07:27:51 2013 +0000
     6.3 @@ -57,4 +57,9 @@
     6.4        <version>${project.version}</version>
     6.5      </dependency>
     6.6    </dependencies>
     6.7 +    <description>API for smooth representation of JSON objects in Java. Write your
     6.8 +application in Java and
     6.9 +present it using modern HTML rendering technologies like 
    6.10 +Knockout.
    6.11 +</description>
    6.12  </project>
     7.1 --- a/ko-fx/pom.xml	Sun Aug 25 17:41:21 2013 +0200
     7.2 +++ b/ko-fx/pom.xml	Tue Aug 27 07:27:51 2013 +0000
     7.3 @@ -98,4 +98,5 @@
     7.4          <version>3.1.0</version>
     7.5      </dependency>
     7.6    </dependencies>
     7.7 +    <description>Binds net.java.html.json APIs together with JavaFX WebView.</description>
     7.8  </project>
     8.1 --- a/ko-ws-tyrus/pom.xml	Sun Aug 25 17:41:21 2013 +0200
     8.2 +++ b/ko-ws-tyrus/pom.xml	Tue Aug 27 07:27:51 2013 +0000
     8.3 @@ -23,6 +23,13 @@
     8.4                      <target>1.7</target>
     8.5                  </configuration>
     8.6              </plugin>
     8.7 +            <plugin>
     8.8 +                <groupId>org.apache.maven.plugins</groupId>
     8.9 +                <artifactId>maven-javadoc-plugin</artifactId>
    8.10 +                <configuration>
    8.11 +                    <skip>false</skip>
    8.12 +                </configuration>
    8.13 +            </plugin>
    8.14          </plugins>
    8.15      </build>
    8.16      <properties>
    8.17 @@ -140,4 +147,6 @@
    8.18          <version>3.1.0</version>
    8.19      </dependency>
    8.20    </dependencies>
    8.21 +    <description>An implementation module that provides support for WebSocket protocol on JDK7. 
    8.22 +No need to use it when running on JDK8 with FX WebView supporting WebSocket directly.</description>
    8.23  </project>
     9.1 --- a/ko-ws-tyrus/src/main/java/org/apidesign/html/wstyrus/TyrusContext.java	Sun Aug 25 17:41:21 2013 +0200
     9.2 +++ b/ko-ws-tyrus/src/main/java/org/apidesign/html/wstyrus/TyrusContext.java	Tue Aug 27 07:27:51 2013 +0000
     9.3 @@ -33,6 +33,7 @@
     9.4  import javax.websocket.OnOpen;
     9.5  import javax.websocket.Session;
     9.6  import javax.websocket.WebSocketContainer;
     9.7 +import net.java.html.json.OnReceive;
     9.8  import org.apidesign.html.context.spi.Contexts;
     9.9  import org.apidesign.html.json.spi.JSONCall;
    9.10  import org.apidesign.html.json.spi.WSTransfer;
    9.11 @@ -43,7 +44,18 @@
    9.12  import org.json.JSONTokener;
    9.13  import org.openide.util.lookup.ServiceProvider;
    9.14  
    9.15 -/**
    9.16 +/** This is an implementation module that provides support for
    9.17 + * WebSocket protocol for {@link OnReceive} communication end point for
    9.18 + * JDK7.
    9.19 + * <p>
    9.20 + * Don't deal with this module directly, rather use the 
    9.21 + * {@link OnReceive @OnReceive(url="ws://...", ...)} API to establish your
    9.22 + * WebSocket connection.
    9.23 + * <p>
    9.24 + * There is no need to include this module in your application if you are
    9.25 + * running on JDK8. JDK8 WebView provides its own implementation of the
    9.26 + * WebSocket API based on WebSocket object inside a browser. This is included
    9.27 + * in the <code>org.apidesign.html:ko-fx:0.5</code> module.
    9.28   *
    9.29   * @author Jaroslav Tulach <jtulach@netbeans.org>
    9.30   */
    9.31 @@ -79,6 +91,9 @@
    9.32          }
    9.33      }
    9.34      
    9.35 +    /** Implementation class in an implementation. Represents a {@link ClientEndpoint} of the
    9.36 +     * WebSocket channel. You are unlikely to get on hold of it.
    9.37 +     */
    9.38      @ClientEndpoint
    9.39      public static final class Comm {
    9.40          private final JSONCall callback;