summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorArtur <artur@vaadin.com>2017-01-25 15:52:11 +0200
committerDenis <denis@vaadin.com>2017-01-25 15:52:11 +0200
commit0b67c1c9c93d6db3dabf52fc4e7d43f8edabb31f (patch)
treec39638d946b8395d5c430cd70c55db0abe53838e
parent23139cf0196e3120535452e7197627be4fb41fec (diff)
downloadvaadin-framework-0b67c1c9c93d6db3dabf52fc4e7d43f8edabb31f.tar.gz
vaadin-framework-0b67c1c9c93d6db3dabf52fc4e7d43f8edabb31f.zip
Update @HtmlImport javadoc to match implementation (#8331)
-rw-r--r--server/src/main/java/com/vaadin/annotations/HtmlImport.java15
1 files changed, 8 insertions, 7 deletions
diff --git a/server/src/main/java/com/vaadin/annotations/HtmlImport.java b/server/src/main/java/com/vaadin/annotations/HtmlImport.java
index f0c52ff171..f815134dbb 100644
--- a/server/src/main/java/com/vaadin/annotations/HtmlImport.java
+++ b/server/src/main/java/com/vaadin/annotations/HtmlImport.java
@@ -34,16 +34,17 @@ import com.vaadin.server.ClientConnector;
* There is no automatic loading of any polyfill.
* <p>
* <ul>
- * <li>Relative URLs are interpreted as relative to the {@code VAADIN} folder,
- * i.e. {@literal bower_components/paper-slider/paper-slider.html} is equal to
- * {@literal vaadin://bower_components/paper-slider/paper-slider.html}.
+ * <li>Relative URLs are mapped to APP/PUBLISHED/[url] which are by default
+ * served from the classpath relative to the class where the annotation is
+ * defined.
* <li>Absolute URLs including protocol and host are used as is on the
* client-side.
* </ul>
- * Note that it is a good idea to use relative URLs and place all HTML imports
- * in the same folder. Polymer elements rely on importing dependencies using
- * relative paths {@literal ../../other-element/other-element.html}, which will
- * not work if they are installed in different locations.
+ * Note that it is a good idea to use URLs starting with {@literal vaadin://}
+ * and place all HTML imports inside {@literal VAADIN/bower_components}. Polymer
+ * elements rely on importing dependencies using relative paths
+ * {@literal ../../other-element/other-element.html}, which will not work if
+ * they are installed in different locations.
* <p>
* HTML imports are added to the page after any {@code @JavaScript} dependencies
* added at the same time.