From 48cc0f3973579ee6c5893b27e484afc3c87692ec Mon Sep 17 00:00:00 2001 From: =?utf8?q?Leif=20=C3=85strand?= Date: Wed, 27 Jun 2012 17:12:49 +0300 Subject: [PATCH] Javadocs for @StyleSheet and @JavaScript (#9044) --- src/com/vaadin/annotations/JavaScript.java | 16 ++++++++++++++++ src/com/vaadin/annotations/StyleSheet.java | 16 ++++++++++++++++ 2 files changed, 32 insertions(+) diff --git a/src/com/vaadin/annotations/JavaScript.java b/src/com/vaadin/annotations/JavaScript.java index 8e0bc09958..3abe7467ba 100644 --- a/src/com/vaadin/annotations/JavaScript.java +++ b/src/com/vaadin/annotations/JavaScript.java @@ -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(); } diff --git a/src/com/vaadin/annotations/StyleSheet.java b/src/com/vaadin/annotations/StyleSheet.java index 40f75511dd..7056853ff4 100644 --- a/src/com/vaadin/annotations/StyleSheet.java +++ b/src/com/vaadin/annotations/StyleSheet.java @@ -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(); } -- 2.39.5