modules/javafx.fxml/src/main/java/javafx/fxml/FXML.java

rev 10444 : imported patch doc-8177566-trampoline
rev 10445 : [mq]: doc-v1-8177566-trampoline

@@ -30,24 +30,38 @@
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
 
 /**
  * Annotation that tags a field or method as accessible to markup.
+ * <p><b>Deploying an Application as a Module</b></p>
+ * <p>
  * If the object being annotated is in a named module then it must
  * be reflectively accessible to the {@code javafx.fxml} module.
  * Otherwise, the {@link FXMLLoader} will fail with an
  * {@code InaccessibleObjectException} when it attempts to modify the
  * annotated element.
  * An object is reflectively accessible if the module containing that
  * object {@link Module#isOpen(String,Module) opens} the containing package to
  * at least the
- * {@code javafx.fxml} module, either in its {@code module-info.class} or
- * by calling {@link Module#addOpens}.
- * An object is also reflectively accessible if it is declared as a public
- * member, is in a public class, and the module containing that class
- * {@link Module#isExported(String,Module) exports}
- * the containing package to at least the {@code javafx.fxml} module.
+ * {@code javafx.fxml} module.
+ * </p>
+ * <p>
+ * For example, if the object being annotated is in the {@code com.foo}
+ * package in the {@code foo.app} module, the {@code module-info.java} might
+ * look like this:
+ * </p>
+ *
+<pre>{@code module foo.app {
+    opens com.foo to javafx.fxml;
+}}</pre>
+ *
+ * <p>
+ * Alternatively, an object is reflectively accessible if it is declared
+ * as a public member, is in a public class, and the module containing that
+ * class {@link Module#isExported(String) exports} the containing
+ * package unconditionally.
+ * </p>
  *
  * @since JavaFX 2.0
  */
 @Retention(RetentionPolicy.RUNTIME)
 @Target({ElementType.FIELD, ElementType.METHOD})