1.1 --- a/json/src/main/java/net/java/html/json/Model.java Tue Aug 26 17:37:11 2014 +0200
1.2 +++ b/json/src/main/java/net/java/html/json/Model.java Tue Aug 26 17:37:43 2014 +0200
1.3 @@ -142,9 +142,12 @@
1.4 @Retention(RetentionPolicy.SOURCE)
1.5 @Target(ElementType.TYPE)
1.6 public @interface Model {
1.7 - /** Name of the model class */
1.8 + /** Name of the model class.
1.9 + * @return valid Java identifier to use as a name of the model class
1.10 + */
1.11 String className();
1.12 /** List of properties in the model.
1.13 + * @return array of property definitions
1.14 */
1.15 Property[] properties();
1.16 }
2.1 --- a/json/src/main/java/net/java/html/json/Models.java Tue Aug 26 17:37:11 2014 +0200
2.2 +++ b/json/src/main/java/net/java/html/json/Models.java Tue Aug 26 17:37:43 2014 +0200
2.3 @@ -84,10 +84,12 @@
2.4
2.5 /** Generic method to parse content of a model class from a stream.
2.6 *
2.7 + * @param <M> type of the <code>model</code> class
2.8 * @param c context of the technology to use for reading
2.9 * @param model the model class generated by {@link Model} annotation
2.10 * @param is input stream with data
2.11 * @return new instance of the model class
2.12 + * @throws java.io.IOException throw when reading from <code>is</code> faces problems
2.13 * @since 0.2
2.14 */
2.15 public static <M> M parse(BrwsrCtx c, Class<M> model, InputStream is) throws IOException {
3.1 --- a/json/src/main/java/org/apidesign/html/json/spi/Proto.java Tue Aug 26 17:37:11 2014 +0200
3.2 +++ b/json/src/main/java/org/apidesign/html/json/spi/Proto.java Tue Aug 26 17:37:43 2014 +0200
3.3 @@ -280,6 +280,15 @@
3.4 /** Initializes asynchronous JSON connection to specified URL. Delegates
3.5 * to {@link #loadJSON(int, java.lang.String, java.lang.String, java.lang.String, java.lang.Object, java.lang.Object...) }
3.6 * with no extra parameters.
3.7 + *
3.8 + * @param index the callback index to be used when a reply is received
3.9 + * to call {@link Type#onMessage(java.lang.Object, int, int, java.lang.Object)}.
3.10 + *
3.11 + * @param urlBefore the part of the URL before JSON-P callback parameter
3.12 + * @param urlAfter the rest of the URL or <code>null</code> if no JSON-P is used
3.13 + * @param method method to use for connection to the server
3.14 + * @param data string, number or a {@link Model} generated class to send to
3.15 + * the server when doing a query
3.16 */
3.17 public void loadJSON(final int index,
3.18 String urlBefore, String urlAfter, String method,
4.1 --- a/json/src/main/java/org/apidesign/html/json/spi/Technology.java Tue Aug 26 17:37:11 2014 +0200
4.2 +++ b/json/src/main/java/org/apidesign/html/json/spi/Technology.java Tue Aug 26 17:37:43 2014 +0200
4.3 @@ -63,6 +63,7 @@
4.4 public Data wrapModel(Object model);
4.5
4.6 /** Converts an element potentially representing a model into the model.
4.7 + * @param <M> the type of the <code>modelClass</code>
4.8 * @param modelClass expected class to convert the data to
4.9 * @param data the current data provided from the browser
4.10 * @return the instance of modelClass somehow extracted from the data, may return <code>null</code>
5.1 --- a/sound/src/main/java/org/apidesign/html/sound/spi/AudioEnvironment.java Tue Aug 26 17:37:11 2014 +0200
5.2 +++ b/sound/src/main/java/org/apidesign/html/sound/spi/AudioEnvironment.java Tue Aug 26 17:37:43 2014 +0200
5.3 @@ -87,7 +87,7 @@
5.4
5.5 /** Checks whether given audio is supported
5.6 *
5.7 - * @param a
5.8 + * @param a the internal representation of the audio as created by {@link #create(java.lang.String)} method.
5.9 * @return <code>true</code> or <code>false</code>
5.10 */
5.11 public boolean isSupported(Audio a);