aboutsummaryrefslogtreecommitdiffstats
path: root/server/src/main/java
diff options
context:
space:
mode:
authoranssit <anssit@vaadin.com>2017-03-10 10:50:18 +0200
committerHenri Sara <henri.sara@gmail.com>2017-03-10 10:50:18 +0200
commitf4e437bbb439ef6e51ccda2fc1dbeb9268f43b8a (patch)
treee30b019cbc995bead756320374c1ccc248ad1134 /server/src/main/java
parent3dba4924ebf93b9f73b906cfdf45819643a2218f (diff)
downloadvaadin-framework-f4e437bbb439ef6e51ccda2fc1dbeb9268f43b8a.tar.gz
vaadin-framework-f4e437bbb439ef6e51ccda2fc1dbeb9268f43b8a.zip
Update JavaDoc for @DesignRoot. (#8805)
Emphasise that both location and filename for the design file can be specified in the value parameter.
Diffstat (limited to 'server/src/main/java')
-rw-r--r--server/src/main/java/com/vaadin/annotations/DesignRoot.java9
1 files changed, 5 insertions, 4 deletions
diff --git a/server/src/main/java/com/vaadin/annotations/DesignRoot.java b/server/src/main/java/com/vaadin/annotations/DesignRoot.java
index 4199309d49..c3d25b78b6 100644
--- a/server/src/main/java/com/vaadin/annotations/DesignRoot.java
+++ b/server/src/main/java/com/vaadin/annotations/DesignRoot.java
@@ -26,10 +26,11 @@ import com.vaadin.ui.declarative.Design;
* Marks the component as the root of a design (html) file.
* <p>
* Used together with {@link Design#read(com.vaadin.ui.Component)} to be able
- * the load the design without further configuration. The design is loaded from
- * the same package as the annotated class and by default the design filename is
- * derived from the class name. Using the {@link #value()} parameter you can
- * specify another design file name.
+ * the load the design without further configuration. By default, the design
+ * is loaded from the same package as the annotated class and the design
+ * filename is derived from the class name. You can override the default
+ * behaviour by using the {@link #value()} parameter in order to load the
+ * design from a different package or with a non-default filename.
*
* @since 7.4
* @author Vaadin Ltd