Describe how paths are resolved in javadoc (#9048)

diff --git a/src/com/vaadin/annotations/JavaScript.java b/src/com/vaadin/annotations/JavaScript.java
index 065c37b78d3889330f126951057ed48b395d320c..f97457c1cd9f9048875d25891c573e7496c1c70b 100644 (file)
--- a/src/com/vaadin/annotations/JavaScript.java
+++ b/src/com/vaadin/annotations/JavaScript.java
@@ -15,6 +15,16 @@ 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 init
  * method for the corresponding client-side connector is invoked.
+ * <p>
+ * Absolute URLs including protocol and host are used as is on the client-side.
+ * Relative urls are mapped to APP/CONNECTOR/[url] which are by default served
+ * from the classpath relative to the class where the annotation is defined.
+ * <p>
+ * Example: {@code @JavaScript( "http://host.com/file1.js", "file2.js"})} on
+ * the class com.example.MyConnector would load the file
+ * http://host.com/file1.js as is and file2.js from /com/example/file2.js on the
+ * server's classpath using the ClassLoader that was used to load
+ * com.example.MyConnector.
  * 
  * @author Vaadin Ltd
  * @version @VERSION@

diff --git a/src/com/vaadin/annotations/StyleSheet.java b/src/com/vaadin/annotations/StyleSheet.java
index f8bf6354741e30af80e11e0186647edb1bdb9ade..d082cb8d307b6e448e14b24601c127a553eb9c76 100644 (file)
--- a/src/com/vaadin/annotations/StyleSheet.java
+++ b/src/com/vaadin/annotations/StyleSheet.java
@@ -15,6 +15,12 @@ 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 init
  * method for the corresponding client-side connector is invoked.
+ * <p>
+ * Example: {@code @StyleSheet( "http://host.com/file1.css", "file2.css"})} on
+ * the class com.example.MyConnector would load the file
+ * http://host.com/file1.css as is and file2.css from /com/example/file2.css on
+ * the server's classpath using the ClassLoader that was used to load
+ * com.example.MyConnector.
  * 
  * @author Vaadin Ltd
  * @version @VERSION@