Fixing Javadoc warnings
authorJaroslav Tulach <jaroslav.tulach@netbeans.org>
Thu, 06 Feb 2014 10:52:45 +0100
changeset 53415907d1499fb
parent 533 d4f44b4b4602
child 535 349f6c9278bb
Fixing Javadoc warnings
boot-fx/src/main/java/org/netbeans/html/boot/fx/FXBrwsr.java
boot-fx/src/main/java/org/netbeans/html/boot/fx/FXConsole.java
boot/src/main/java/org/netbeans/html/boot/impl/FnUtils.java
context/src/main/java/org/apidesign/html/context/spi/Contexts.java
context/src/main/java/org/netbeans/html/context/impl/CtxAccssr.java
geo/src/main/java/org/netbeans/html/geo/impl/GeoProcessor.java
json-tck/src/main/java/org/apidesign/html/json/tck/JavaScriptTCK.java
json-tck/src/main/java/org/apidesign/html/json/tck/KnockoutTCK.java
json/src/main/java/org/apidesign/html/json/spi/Technology.java
json/src/main/java/org/apidesign/html/json/spi/Transfer.java
json/src/main/java/org/apidesign/html/json/spi/WSTransfer.java
     1.1 --- a/boot-fx/src/main/java/org/netbeans/html/boot/fx/FXBrwsr.java	Thu Feb 06 10:16:26 2014 +0100
     1.2 +++ b/boot-fx/src/main/java/org/netbeans/html/boot/fx/FXBrwsr.java	Thu Feb 06 10:52:45 2014 +0100
     1.3 @@ -66,8 +66,8 @@
     1.4  import javafx.stage.Modality;
     1.5  import javafx.stage.Stage;
     1.6  
     1.7 -/** This is an implementation class, use {@link BrowserBuilder} API. Just
     1.8 - * include this JAR on classpath and the {@link BrowserBuilder} API will find
     1.9 +/** This is an implementation class, to implement browser builder API. Just
    1.10 + * include this JAR on classpath and the browser builder API will find
    1.11   * this implementation automatically.
    1.12   */
    1.13  public class FXBrwsr extends Application {
     2.1 --- a/boot-fx/src/main/java/org/netbeans/html/boot/fx/FXConsole.java	Thu Feb 06 10:16:26 2014 +0100
     2.2 +++ b/boot-fx/src/main/java/org/netbeans/html/boot/fx/FXConsole.java	Thu Feb 06 10:52:45 2014 +0100
     2.3 @@ -48,7 +48,7 @@
     2.4  import netscape.javascript.JSObject;
     2.5  
     2.6  /** This is an implementation package - just
     2.7 - * include its JAR on classpath and use official {@link Context} API
     2.8 + * include its JAR on classpath and use official browser builder API
     2.9   * to access the functionality.
    2.10   * <p>
    2.11   * Redirects JavaScript's messages to Java's {@link Logger}.
     3.1 --- a/boot/src/main/java/org/netbeans/html/boot/impl/FnUtils.java	Thu Feb 06 10:16:26 2014 +0100
     3.2 +++ b/boot/src/main/java/org/netbeans/html/boot/impl/FnUtils.java	Thu Feb 06 10:52:45 2014 +0100
     3.3 @@ -50,6 +50,8 @@
     3.4  import java.util.Collections;
     3.5  import java.util.Enumeration;
     3.6  import java.util.List;
     3.7 +import net.java.html.js.JavaScriptBody;
     3.8 +import net.java.html.js.JavaScriptResource;
     3.9  import org.apidesign.html.boot.spi.Fn;
    3.10  import org.objectweb.asm.AnnotationVisitor;
    3.11  import org.objectweb.asm.ClassReader;
     4.1 --- a/context/src/main/java/org/apidesign/html/context/spi/Contexts.java	Thu Feb 06 10:16:26 2014 +0100
     4.2 +++ b/context/src/main/java/org/apidesign/html/context/spi/Contexts.java	Thu Feb 06 10:52:45 2014 +0100
     4.3 @@ -54,7 +54,7 @@
     4.4      }
     4.5  
     4.6      /** Creates new, empty builder for creation of {@link BrwsrCtx}. At the
     4.7 -     * end call the {@link #build()} method to generate the context.
     4.8 +     * end call the {@link Builder#build()} method to generate the context.
     4.9       *
    4.10       * @return new instance of the builder
    4.11       */
    4.12 @@ -68,15 +68,15 @@
    4.13       * @param context the context to seek in 
    4.14       *    (previously filled with ({@link Builder#register(java.lang.Class, java.lang.Object, int)})
    4.15       * @param technology class that identifies the technology
    4.16 -     * @return 
    4.17 +     * @return the technology in the context or <code>null</code>
    4.18       */
    4.19      public static <Tech> Tech find(BrwsrCtx context, Class<Tech> technology) {
    4.20          return CtxImpl.find(context, technology);
    4.21      }
    4.22  
    4.23      /** Implementors of various HTML technologies should
    4.24 -     * register their implementation via {@link ServiceProvider} so
    4.25 -     * {@link ServiceProvider} can find them, when their JARs are included
    4.26 +     * register their implementation via {@link java.util.ServiceProvider} so
    4.27 +     * {@link java.util.ServiceProvider} can find them, when their JARs are included
    4.28       * on the classpath of the running application.
    4.29       *
    4.30       * @author Jaroslav Tulach <jaroslav.tulach@apidesign.org>
     5.1 --- a/context/src/main/java/org/netbeans/html/context/impl/CtxAccssr.java	Thu Feb 06 10:16:26 2014 +0100
     5.2 +++ b/context/src/main/java/org/netbeans/html/context/impl/CtxAccssr.java	Thu Feb 06 10:52:45 2014 +0100
     5.3 @@ -43,9 +43,10 @@
     5.4  package org.netbeans.html.context.impl;
     5.5  
     5.6  import net.java.html.BrwsrCtx;
     5.7 +import org.apidesign.html.context.spi.Contexts.Builder;
     5.8  
     5.9  /** Internal communication between API (e.g. {@link BrwsrCtx}), SPI
    5.10 - * (e.g. {@link ContextBuilder}) and the implementation package.
    5.11 + * (e.g. {@link Builder}) and the implementation package.
    5.12   *
    5.13   * @author Jaroslav Tulach <jtulach@netbeans.org>
    5.14   */
     6.1 --- a/geo/src/main/java/org/netbeans/html/geo/impl/GeoProcessor.java	Thu Feb 06 10:16:26 2014 +0100
     6.2 +++ b/geo/src/main/java/org/netbeans/html/geo/impl/GeoProcessor.java	Thu Feb 06 10:52:45 2014 +0100
     6.3 @@ -67,9 +67,10 @@
     6.4  import javax.tools.JavaFileObject;
     6.5  import net.java.html.geo.OnLocation;
     6.6  import net.java.html.geo.Position;
     6.7 +import net.java.html.geo.Position.Handle;
     6.8  import org.openide.util.lookup.ServiceProvider;
     6.9  
    6.10 -/** Annotation processor to generate callbacks from {@link GeoHandle} class.
    6.11 +/** Annotation processor to generate callbacks from {@link Handle} class.
    6.12   *
    6.13   * @author Jaroslav Tulach <jtulach@netbeans.org>
    6.14   */
     7.1 --- a/json-tck/src/main/java/org/apidesign/html/json/tck/JavaScriptTCK.java	Thu Feb 06 10:16:26 2014 +0100
     7.2 +++ b/json-tck/src/main/java/org/apidesign/html/json/tck/JavaScriptTCK.java	Thu Feb 06 10:52:45 2014 +0100
     7.3 @@ -48,7 +48,7 @@
     7.4  /** Subclass this class, implements is abstract methods (if any).
     7.5   *
     7.6   * @author Jaroslav Tulach <jtulach@netbeans.org>
     7.7 - * @sine 0.7
     7.8 + * @since 0.7
     7.9   */
    7.10  public abstract class JavaScriptTCK {
    7.11      /** Gives you list of classes included in the TCK. Their test methods
     8.1 --- a/json-tck/src/main/java/org/apidesign/html/json/tck/KnockoutTCK.java	Thu Feb 06 10:16:26 2014 +0100
     8.2 +++ b/json-tck/src/main/java/org/apidesign/html/json/tck/KnockoutTCK.java	Thu Feb 06 10:52:45 2014 +0100
     8.3 @@ -52,6 +52,7 @@
     8.4  import net.java.html.json.tests.Utils;
     8.5  import net.java.html.json.tests.WebSocketTest;
     8.6  import org.openide.util.lookup.ServiceProvider;
     8.7 +import org.apidesign.html.context.spi.Contexts.Builder;
     8.8  
     8.9  /** Entry point for providers of different HTML binding technologies (like
    8.10   * Knockout.js in JavaFX's WebView). Sample usage:
    8.11 @@ -60,7 +61,7 @@
    8.12  public final class MyKnockoutBindingTest extends KnockoutTCK {
    8.13      {@link Override @Override}
    8.14      protected BrwsrCtx createContext() {
    8.15 -        // use {@link ContextBuilder}.{@link ContextBuilder#build() build}();
    8.16 +        // use {@link Builder}.{@link Builder#build() build}();
    8.17      }
    8.18  
    8.19      {@code @Factory} public static Object[] create() {
    8.20 @@ -77,12 +78,14 @@
    8.21      }
    8.22      
    8.23      /** Implement to create new context for the test. 
    8.24 -     * Use {@link ContextBuilder} to implement context for your technology.
    8.25 +     * Use {@link Builder} to set context for your technology up.
    8.26 +     * @return the final context for the test
    8.27       */
    8.28      public abstract BrwsrCtx createContext();
    8.29      
    8.30      /** Create a JSON object as seen by the technology
    8.31       * @param values mapping from names to values of properties
    8.32 +     * @return the JSON object with filled in values
    8.33       */
    8.34      public abstract Object createJSON(Map<String,Object> values);
    8.35  
    8.36 @@ -98,10 +101,11 @@
    8.37       * <code>mimeType</code> and <code>content</code>. The 
    8.38       * content may be processed by the provided <code>parameters</code>.
    8.39       * 
    8.40 -     * @param content
    8.41 -     * @param mimeType
    8.42 -     * @param parameters
    8.43 -     * @return 
    8.44 +     * @param content what should be available on the URL. Can contain <code>$0</code>
    8.45 +     *   <code>$1</code> to reference <code>parameters</code> by their position
    8.46 +     * @param mimeType the type of the resource
    8.47 +     * @param parameters names of parameters as reference by <code>content</code>
    8.48 +     * @return URI the test can connect to to obtain the (processed) content
    8.49       */
    8.50      public abstract URI prepareURL(String content, String mimeType, String[] parameters);
    8.51      
     9.1 --- a/json/src/main/java/org/apidesign/html/json/spi/Technology.java	Thu Feb 06 10:16:26 2014 +0100
     9.2 +++ b/json/src/main/java/org/apidesign/html/json/spi/Technology.java	Thu Feb 06 10:52:45 2014 +0100
     9.3 @@ -121,7 +121,7 @@
     9.4       * method of this interface and it will be called instead of the 
     9.5       * previous two ones.
     9.6       * 
     9.7 -     * @@since 0.6
     9.8 +     * @since 0.6
     9.9       */
    9.10      public static interface BatchInit<D> extends Technology<D> {
    9.11          /** Wrap the given model into redering technology appropriate object 
    10.1 --- a/json/src/main/java/org/apidesign/html/json/spi/Transfer.java	Thu Feb 06 10:16:26 2014 +0100
    10.2 +++ b/json/src/main/java/org/apidesign/html/json/spi/Transfer.java	Thu Feb 06 10:52:45 2014 +0100
    10.3 @@ -44,8 +44,9 @@
    10.4  
    10.5  import java.io.IOException;
    10.6  import java.io.InputStream;
    10.7 +import org.apidesign.html.context.spi.Contexts.Builder;
    10.8  
    10.9 -/** A {@link ContextBuilder service provider interface} responsible for 
   10.10 +/** A {@link Builder service provider interface} responsible for 
   10.11   * conversion of JSON objects to Java ones and vice-versa.
   10.12   *
   10.13   * @author Jaroslav Tulach <jtulach@netbeans.org>
    11.1 --- a/json/src/main/java/org/apidesign/html/json/spi/WSTransfer.java	Thu Feb 06 10:16:26 2014 +0100
    11.2 +++ b/json/src/main/java/org/apidesign/html/json/spi/WSTransfer.java	Thu Feb 06 10:52:45 2014 +0100
    11.3 @@ -43,10 +43,10 @@
    11.4  package org.apidesign.html.json.spi;
    11.5  
    11.6  import net.java.html.BrwsrCtx;
    11.7 -import org.apidesign.html.context.spi.Contexts;
    11.8 +import org.apidesign.html.context.spi.Contexts.Provider;
    11.9  
   11.10  /** Interface for providers of WebSocket protocol. Register into a 
   11.11 - * {@link BrwsrCtx context} in your own {@link Contexts.Provider}
   11.12 + * {@link BrwsrCtx context} in your own {@link Provider}
   11.13   *
   11.14   * @author Jaroslav Tulach <jtulach@netbeans.org>
   11.15   * @param <WebSocket> internal implementation type representing the socket