[ofbiz-framework] branch trunk updated: Fixes a JavaDoc issue

[jl...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

jleroux pushed a commit to branch trunk
in repository https://gitbox.apache.org/repos/asf/ofbiz-framework.git


The following commit(s) were added to refs/heads/trunk by this push:
     new ee8bd3f  Fixes a JavaDoc issue
ee8bd3f is described below

commit ee8bd3f5d4ec10d325993a35172001b5cee3136d
Author: Jacques Le Roux <ja...@les7arts.com>
AuthorDate: Thu Sep 24 10:32:06 2020 +0200

    Fixes a JavaDoc issue
---
 .../org/apache/ofbiz/widget/model/ModelMenu.java   | 32 ++++++++--------------
 1 file changed, 12 insertions(+), 20 deletions(-)

diff --git a/framework/widget/src/main/java/org/apache/ofbiz/widget/model/ModelMenu.java b/framework/widget/src/main/java/org/apache/ofbiz/widget/model/ModelMenu.java
index 3d9520d..bf919a5 100644
--- a/framework/widget/src/main/java/org/apache/ofbiz/widget/model/ModelMenu.java
+++ b/framework/widget/src/main/java/org/apache/ofbiz/widget/model/ModelMenu.java
@@ -35,9 +35,7 @@ import org.apache.ofbiz.widget.renderer.VisualTheme;
 import org.w3c.dom.Element;
 
 /**
- * Models the &lt;menu&gt; element.
- *
- * @see <code>widget-menu.xsd</code>
+ * Models the &lt;menu&gt; element. see widget-menu.xsd
  */
 @SuppressWarnings("serial")
 public class ModelMenu extends ModelWidget {
@@ -670,21 +668,16 @@ public class ModelMenu extends ModelWidget {
     }
 
     /**
-     * Renders this menu to a String, i.e. in a text format, as defined with the
-     * MenuStringRenderer implementation.
+     * Renders this menu to a String, i.e. in a text format, as defined with the MenuStringRenderer implementation.
      * @param writer The Writer that the menu text will be written to
-     * @param context Map containing the menu context; the following are
-     *   reserved words in this context: parameters (Map), isError (Boolean),
-     *   itemIndex (Integer, for lists only, otherwise null), menuName
-     *   (String, optional alternate name for menu, defaults to the
-     *   value of the name attribute)
-     * @param menuStringRenderer An implementation of the MenuStringRenderer
-     *   interface that is responsible for the actual text generation for
-     *   different menu elements; implementing you own makes it possible to
-     *   use the same menu definitions for many types of menu UIs
-     */
-    public void renderMenuString(Appendable writer, Map<String, Object> context, MenuStringRenderer menuStringRenderer)
-            throws IOException {
+     * @param context Map containing the menu context; the following are reserved words in this context: parameters (Map), isError (Boolean),
+     * itemIndex (Integer, for lists only, otherwise null), menuName (String, optional alternate name for menu, defaults to the value of the name
+     * attribute)
+     * @param menuStringRenderer An implementation of the MenuStringRenderer interface that is responsible for the actual text generation for
+     * different menu elements; implementing you own makes it possible to use the same menu definitions for many types of menu UIs
+     * @throws IOException the io exception
+     */
+    public void renderMenuString(Appendable writer, Map<String, Object> context, MenuStringRenderer menuStringRenderer) throws IOException {
         AbstractModelAction.runSubActions(this.actions, context);
         if ("simple".equals(this.type)) {
             this.renderSimpleMenuString(writer, context, menuStringRenderer);
@@ -701,8 +694,7 @@ public class ModelMenu extends ModelWidget {
      * @param menuStringRenderer the menu string renderer
      * @throws IOException the io exception
      */
-    public void renderSimpleMenuString(Appendable writer, Map<String, Object> context, MenuStringRenderer menuStringRenderer)
-            throws IOException {
+    public void renderSimpleMenuString(Appendable writer, Map<String, Object> context, MenuStringRenderer menuStringRenderer) throws IOException {
         // render menu open
         menuStringRenderer.renderMenuOpen(writer, context, this);
 
@@ -727,4 +719,4 @@ public class ModelMenu extends ModelWidget {
     public void runActions(Map<String, Object> context) {
         AbstractModelAction.runSubActions(this.actions, context);
     }
-}
\ No newline at end of file
+}