]> source.dussan.org Git - vaadin-framework.git/commitdiff
Javadocs for @StyleSheet and @JavaScript (#9044)
authorLeif Åstrand <leif@vaadin.com>
Wed, 27 Jun 2012 14:12:49 +0000 (17:12 +0300)
committerLeif Åstrand <leif@vaadin.com>
Wed, 27 Jun 2012 14:12:49 +0000 (17:12 +0300)
src/com/vaadin/annotations/JavaScript.java
src/com/vaadin/annotations/StyleSheet.java

index 8e0bc09958dcaafcfe10c73e2026f604d1bb97d3..3abe7467ba53268f1d1e1ef1e59a2b888aba590e 100644 (file)
@@ -9,8 +9,24 @@ import java.lang.annotation.Retention;
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
 
+import com.vaadin.terminal.gwt.server.ClientConnector;
+
+/**
+ * If this annotation is present on a {@link ClientConnector} class, the
+ * framework ensures the referenced JavaScript files are loaded before the
+ * corresponding client-side connector is initialized.
+ * 
+ * @author Vaadin Ltd
+ * @version @VERSION@
+ * @since 7.0.0
+ */
 @Retention(RetentionPolicy.RUNTIME)
 @Target(ElementType.TYPE)
 public @interface JavaScript {
+    /**
+     * JavaScript files to load before initializing the client-side connector.
+     * 
+     * @return an array of JavaScript file urls
+     */
     public String[] value();
 }
index 40f75511dd08d7ef230c234489eab343454a6cd4..7056853ff4c879ac1c898ef9214a0aa5fcb7baf4 100644 (file)
@@ -9,8 +9,24 @@ import java.lang.annotation.Retention;
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
 
+import com.vaadin.terminal.gwt.server.ClientConnector;
+
+/**
+ * If this annotation is present on a {@link ClientConnector} class, the
+ * framework ensures the referenced style sheets are loaded before the
+ * corresponding client-side connector is initialized.
+ * 
+ * @author Vaadin Ltd
+ * @version @VERSION@
+ * @since 7.0.0
+ */
 @Retention(RetentionPolicy.RUNTIME)
 @Target(ElementType.TYPE)
 public @interface StyleSheet {
+    /**
+     * Style sheets to load before initializing the client-side connector.
+     * 
+     * @return an array of style sheet urls
+     */
     public String[] value();
 }