[10.0.x] NO-ISSUE: Fix Dashbuilder javadocs (#2572)

packages/dashbuilder/appformer/uberfire-api/src/main/java/org/uberfire/debug/Debug.java

@@ -87,8 +87,7 @@ public static String objectId(Object o) {
      * <li>the first letter of each component of the package name
      * <li>a dot
      * <li>the class name. If the class is an inner class, the name is of the form Outer$Inner
-     * <ol>
-     * <p>
+     * </ol>
      * For classes in the default package, items 1 and 2 are omitted.
      * @param c the class whose name to abbreviate. Can be null, but will result in a null return value.
      * @return the abbreviated FQCN as described, or null if the input is null.

packages/dashbuilder/appformer/uberfire-api/src/main/java/org/uberfire/mvp/PlaceRequest.java

@@ -65,7 +65,7 @@ PlaceRequest addParameter(final String name,
     void setUpdateLocationBar(boolean updateLocationBar);
 
     /**
-     * Invokes {@link #toString()} but exported to JavaScript so it can be invoked from different scripts.
+     * Invokes toString() but exported to JavaScript so it can be invoked from different scripts.
      */
     default String asString() {
         return this.toString();

packages/dashbuilder/appformer/uberfire-api/src/main/java/org/uberfire/workbench/model/CustomPanelDefinition.java

@@ -25,12 +25,11 @@
 import jsinterop.annotations.JsIgnore;
 import jsinterop.annotations.JsType;
 import org.jboss.errai.common.client.dom.HTMLElement;
-import org.uberfire.mvp.PlaceRequest;
 
 /**
  * A custom {@link PanelDefinition} that is associated with a HasWidgets
- * or HTMLElement container. See {@link PlaceManager#goTo(PlaceRequest, HasWidgets)}
- * and {@link PlaceManager#goTo(PlaceRequest, HTMLElement)}
+ * or HTMLElement container. See PlaceManager#goTo(PlaceRequest, HasWidgets)
+ * and PlaceManager#goTo(PlaceRequest, HTMLElement)
  */
 @JsType
 public interface CustomPanelDefinition extends PanelDefinition {

packages/dashbuilder/appformer/uberfire-api/src/main/java/org/uberfire/workbench/model/PanelDefinition.java

@@ -61,7 +61,6 @@ public interface PanelDefinition {
      * Specifies content that should be put in this panel's main display area when it is materialized. The content to
      * add is specified by a PartDefinition, at the core of which is a {@link PlaceRequest} that identifies a
      * WorkbenchActivity (either a screen or an editor).
-     * <p>
      * If the given part already belongs to an existing panel, it will be removed from that panel by a call to
      * removePart(part).
      * @param part The Part to add. Must not be null. The part's place must specify a WorkbenchActivity bean.
@@ -70,9 +69,8 @@ public interface PanelDefinition {
 
     /**
      * Specifies content that should be put in this panel's main display area when it is materialized.
-     * <p>
      * This is a convenience method equivalent to
-     * <tt>addPart(new&nbsp;PartDefinitionImpl(DefaultPlaceRequest.parse(partSpec)))</tt>.
+     * <code>addPart(new&nbsp;PartDefinitionImpl(DefaultPlaceRequest.parse(partSpec)))</code>.
      * @param partSpec An PlaceRequest ID with optional parameters, encoded as specified in
      * {@link DefaultPlaceRequest#parse(CharSequence)}. Must not be null. The place ID must specify a
      * WorkbenchActivity bean (either a screen or an editor).
@@ -183,7 +181,7 @@ public void appendChild(
 
     /**
      * Set the height of this panel in pixels using a primitive int to make this method exportable to JS.
-     * @param width The width to set.
+     * @param height The height to set.
      */
     default void setHeight(int height) {
         setHeight(Integer.valueOf(height));
@@ -315,7 +313,7 @@ default int getMinWidthAsInt() {
     void setContextDisplayMode(final ContextDisplayMode contextDisplayMode);
 
     /**
-     * Invokes {@link #toString()} but exported to JavaScript so it can be invoked from different scripts.
+     * Invokes toString() but exported to JavaScript so it can be invoked from different scripts.
      */
     default String asString() {
         return this.toString();

packages/dashbuilder/appformer/uberfire-api/src/main/java/org/uberfire/workbench/model/PartDefinition.java

@@ -49,7 +49,7 @@ public interface PartDefinition {
     void setContextDisplayMode(final ContextDisplayMode contextDisplayMode);
 
     /**
-     * Invokes {@link #toString()} but exported to JavaScript so it can be invoked from different scripts.
+     * Invokes toString() but exported to JavaScript so it can be invoked from different scripts.
      */
     default String asString() {
         return this.toString();

packages/dashbuilder/appformer/uberfire-client-api/src/main/java/org/uberfire/client/annotations/WorkbenchPanel.java

@@ -27,7 +27,7 @@
 /**
  * Specifies an UberFire workbench panel within a templated perspective.
  * <p>
- * <h3>Prerequisites</h3>
+ * <strong>Prerequisites</strong>
  * This annotation can only be used within a class annotated with {@link WorkbenchPerspective}, and it must target a
  * field that implements the GWT HasWidgets interface. Further, the class this annotation is used in must not have a
  * method annotated with {@link Perspective}. See {@link WorkbenchPerspective} for details.

packages/dashbuilder/appformer/uberfire-client-api/src/main/java/org/uberfire/client/annotations/WorkbenchPerspective.java

@@ -35,16 +35,16 @@
  * programmatically build a {@link PerspectiveDefinition} object, or declare panel structure and content using Errai UI
  * templates. Note that you cannot mix the two approaches.
  * <p>
- * <h3>Programmatic Perspective Definition</h3>
+ * <strong>Programmatic Perspective Definition</strong>
  * To define the perspective layout programmatically, create a zero-argument method annotated with {@code @Perspective}
  * that returns a {@link PerspectiveDefinition}.
  * <p>
- * <h3>Templated Perspective Definition</h3>
+ * <strong>Templated Perspective Definition</strong>
  * To declare perspective layout using templates, make the class an Errai UI templated component, and then add the
  * {@link WorkbenchPanel} annotation to one or more of its {@code @DataField} widgets. This designates them as panel
  * containers and allows you to specify which parts should be added to them when the perspective launches.
  * <p>
- * <h3>Perspective Lifecycle</h3>
+ * <strong>Perspective Lifecycle</strong>
  * WorkbenchPerspectives receive the standard set of lifecycle calls for a Workbench component:
  * <ul>
  * <li>{@code @OnStartup}</li>

packages/dashbuilder/appformer/uberfire-client-api/src/main/java/org/uberfire/client/annotations/WorkbenchPopup.java

@@ -42,11 +42,10 @@
  * In this latter case the {@code @WorkbenchPopup} need not extend
  * {@code com.google.gwt.user.client.ui.PopupPanel}.
  * </p>
- * <p>
  * WorkbechPopups can receive the following life-cycle calls:
  * <ul>
  * <li>{@code @OnOpen}</li>
- * </p>
+ * </ul>
  */
 @Inherited
 @Retention(RetentionPolicy.RUNTIME)

packages/dashbuilder/appformer/uberfire-extensions/uberfire-widgets/uberfire-widgets-commons/src/main/java/org/uberfire/ext/widgets/common/client/common/popups/BaseModal.java

@@ -44,7 +44,7 @@
 /**
  * Base class for modal popup implementations. Setting the following properties by default:
  * <ul>
- * <li>setBackdrop( {@link BackdropType#STATIC} );</li>
+ * <li>setBackdrop( BackdropType#STATIC );</li>
  * <li>setKeyboard( true );</li>
  * <li>setAnimation( true );</li>
  * <li>setDynamicSafe( true );</li>

packages/dashbuilder/appformer/uberfire-extensions/uberfire-widgets/uberfire-widgets-commons/src/main/java/org/uberfire/ext/widgets/common/client/tables/TitledTextCell.java

@@ -47,7 +47,7 @@ public TitledTextCell() {
     /**
      * Constructs a TextCell that uses the provided {@link SafeHtmlRenderer} to
      * render its text.
-     * @param renderer a {@link SafeHtmlRenderer SafeHtmlRenderer<String>} instance
+     * @param renderer a {@link SafeHtmlRenderer} instance
      */
     public TitledTextCell(final SafeHtmlRenderer<TitledText> renderer) {
         super(renderer);

packages/dashbuilder/appformer/uberfire-workbench/uberfire-workbench-client-views-patternfly/src/main/java/org/uberfire/client/views/pfly/tab/TabPanelWithDropdowns.java

@@ -273,7 +273,7 @@ void resizeTabContent() {
      * Adds a new tab to this panel that doesn't have any contents itself, but can contain multiple items that appear in
      * a dropdown menu when the tab is clicked. This dropdown menu is initially empty. Items can be added and removed
      * using the {@link DropDownTab#addItem(String, Widget)} and
-     * {@link DropDownTab#removeItem(String, Widget)} methods.
+     * DropDownTab#removeItem(String, Widget) methods.
      * @param label The text that should appear on the dropdown tab.
      * @return the container for the items that appear when the tab is clicked.
      */
@@ -298,7 +298,7 @@ public DropDownTab addDropdownTab(String label) {
     /**
      * Adds a pre-made dropdown tab to this tab panel. This can be used for re-attaching a dropdown tab that was
      * previously added with {@link #addDropdownTab(String)} and then removed.
-     * @param tab the tab to add back
+     * @param contents contents
      */
     public void addDropdownTab(DropDownTab contents) {
         AnchorListItem tab = contents.owningTab;

packages/dashbuilder/appformer/uberfire-workbench/uberfire-workbench-client/src/main/java/org/uberfire/client/mvp/AbstractActivity.java

@@ -41,7 +41,7 @@ public abstract class AbstractActivity implements Activity {
     }
 
     /**
-     * Tracks start/shutdown lifecycle. Subclasses should always call <tt>super.onStartup()</tt> in methods that
+     * Tracks start/shutdown lifecycle. Subclasses should always call <code>super.onStartup()</code> in methods that
      * override this one.
      */
     @Override
@@ -51,7 +51,7 @@ public void onStartup(PlaceRequest place) {
     }
 
     /**
-     * Tracks open/closed lifecycle. Subclasses should always call <tt>super.onOpen()</tt> in methods that override this
+     * Tracks open/closed lifecycle. Subclasses should always call <code>super.onOpen()</code> in methods that override this
      * one.
      */
     @Override
@@ -67,7 +67,7 @@ public void onOpen() {
     }
 
     /**
-     * Tracks open/closed lifecycle. Subclasses should always call <tt>super.onClose()</tt> in methods that override
+     * Tracks open/closed lifecycle. Subclasses should always call <code>super.onClose()</code> in methods that override
      * this one.
      */
     @Override
@@ -83,7 +83,7 @@ public void onClose() {
     }
 
     /**
-     * Tracks start/shutdown lifecycle. Subclasses should always call <tt>super.onShutdown()</tt> in methods that
+     * Tracks start/shutdown lifecycle. Subclasses should always call <code>super.onShutdown()</code> in methods that
      * override this one.
      */
     @Override

packages/dashbuilder/appformer/uberfire-workbench/uberfire-workbench-client/src/main/java/org/uberfire/client/mvp/Activity.java

@@ -31,15 +31,15 @@
  * see the subinterfaces for specific activity types that do get implemented.
  * <p>
  * Also, implementations of this interface and its subinterfaces are typically not written by hand; instead, they are
- * generated from classes annotated with {@link WorkbenchScreen}, {@link WorkbenchEditor}, {@link WorkbenchPopup}, and
+ * generated from classes annotated with {@link WorkbenchScreen}, {@link WorkbenchPopup}, and
  * others by an UberFire annotation processor.
- * <p>
+ * </p>
  * Developers of UberFire applications will not typically come into direct contact with things that implement Activity
  * or its subinterfaces; instead, they will work with a {@link PlaceManager} to manipulate activities at arm's length.
  * <p>
  * If you do need to get your hands on a particular {@code Activity} instance, do so using an {@link ActivityManager}.
- * <p>
- * <h3>Activity Lifecycle</h3>
+ * </p>
+ * <strong>Activity Lifecycle</strong>
  * Activities have the following lifecycle, which is normally driven by an {@link ActivityManager}:
  * <ol>
  * <li>The activity starts off in the <i>uninitialized</i> state.
@@ -56,7 +56,7 @@
  * <p>
  * An activity will never receive a call to {@link #onStartup(PlaceRequest)} when it is started or open, but it may be
  * restarted (perhaps with a different PlaceRequest) after a call to {@link #onShutdown()}.
- * <p>
+ * </p>
  * An activity will never receive a call to {@link #onOpen()} when it is uninitialized or open, but it may be reopened after a call
  * to {@link #onClose()}.
  * @see PlaceManager

packages/dashbuilder/appformer/uberfire-workbench/uberfire-workbench-client/src/main/java/org/uberfire/client/mvp/ActivityManager.java

@@ -53,7 +53,7 @@ public interface ActivityManager {
      * certain path, the returned set can contain any number of activities.
      * @param placeRequest the PlaceRequest to resolve activities for. Although null is permitted for convenience, it always
      * resolves to the empty set.
-     * @param secure flag indicating if calls to the {@link AuthorizationManager} service are required in order to
+     * @param secure flag indicating if calls to the AuthorizationManager service are required in order to
      * determine which activities are available.
      * @return an unmodifiable set of activities that can handle the given PlaceRequest. Never null, but can be empty.
      * To prevent memory leaks, pass Activity in the returned set to {@link #destroyActivity(Activity)} when you
@@ -81,7 +81,7 @@ Set<Activity> getActivities(final PlaceRequest placeRequest,
     /**
      * Finds an activity that can handle the given PlaceRequest, creating and starting a new one if necessary.
      * @param placeRequest the place the resolved activity should handle
-     * @param secure flag indicating if calls to the {@link AuthorizationManager} service are required in order to
+     * @param secure flag indicating if calls to the AuthorizationManager service are required in order to
      * determine if the resulting activity is available.
      * @return an activity that can handle the request, or null if no known activity can handle it. If the return value
      * is non-null, it will be an activity in the <i>started</i> or <i>open</i> state.
@@ -102,7 +102,7 @@ <T extends Activity> T getActivity(final Class<T> clazz,
      * to use {@link #getActivities(PlaceRequest, boolean)} and cast its return value explicitly.
      * @param clazz the type of activity that you expect to find.
      * @param placeRequest the place the resolved activity should handle
-     * @param secure flag indicating if calls to the {@link AuthorizationManager} service are required in order to
+     * @param secure flag indicating if calls to the AuthorizationManager service are required in order to
      * determine if the resulting activity is available.
      * @return an activity that can handle the request, or null if no known activity can handle it. If the return value
      * is non-null, it will be an activity in the <i>started</i> or <i>open</i> state.

packages/dashbuilder/appformer/uberfire-workbench/uberfire-workbench-client/src/main/java/org/uberfire/client/mvp/PerspectiveManager.java

@@ -36,7 +36,6 @@
  * perspective, and switching between perspectives. This includes a sequence of asynchronous operations such as fetching
  * any stored definition the current user has for the new perspective, and saving the definition when the user has
  * modified it (for example, by dragging and dropping components, launching new activities, and so on).
- * <p/>
  * Structurally, the PerspectiveManager performs actions at the request of the {@link PlaceManager}, and it accomplishes
  * these actions by delegating to the {@link PanelManager} and {@link WorkbenchServicesProxy}.
  */
@@ -67,7 +66,6 @@ public interface PerspectiveManager {
     /**
      * This method should only be invoked by PlaceManager. To launch a perspective within an UberFire app, pass a
      * PlaceRequest for that perspective to {@link PlaceManager#goTo(org.uberfire.mvp.PlaceRequest)}.
-     * <p/>
      * Closes all current panels in the PanelManager (they must have already had their parts removed), then builds up
      * the new panel arrangement based on the {@link PerspectiveDefinition} associated with the given perspective
      * activity. If the given perspective is transient, its default perspective definition will always be used.
@@ -76,7 +74,6 @@ public interface PerspectiveManager {
      * @param placeRequest the placeRequest that originated the perspective to switch to. Must not be null.
      * @param perspective the perspective to switch to. Must not be null.
      * @param doWhenFinished The command to execute once the new perspective's panels have been created. Must not be null.
-     * <p/>
      * When the callback is invoked, the panels will be set up in their correct positions, but no parts will
      * have been added.
      */

packages/dashbuilder/appformer/uberfire-workbench/uberfire-workbench-client/src/main/java/org/uberfire/client/mvp/PlaceManager.java

@@ -37,8 +37,8 @@
 /**
  * A Workbench-centric abstraction over the browser's history mechanism. Allows the application to initiate navigation
  * to any displayable thing: a {@link WorkbenchPerspective}, a {@link WorkbenchScreen}, a {@link WorkbenchPopup}, a
- * a {@link WorkbenchPart} within a screen or editor, or the editor associated with a VFS file
- * located at a particular {@link Path}.
+ * a WorkbenchPart within a screen or editor, or the editor associated with a VFS file
+ * located at a particular Path.
  */
 @JsType
 public interface PlaceManager {
@@ -61,7 +61,7 @@ void goTo(final PlaceRequest place,
 
     /**
      * Finds the <i>currently open</i> activity that handles the given PlaceRequest by ID. No attempt is made to match
-     * by path, but see {@link ActivityManagerImpl#resolveExistingParts(PlaceRequest)} for a variant that does.
+     * by path, but see ActivityManagerImpl#resolveExistingParts(PlaceRequest) for a variant that does.
      *
      * @param place the PlaceRequest whose activity to search for
      * @return the activity that currently exists in service of the given PlaceRequest's ID. Null if no current activity

packages/dashbuilder/appformer/uberfire-workbench/uberfire-workbench-client/src/main/java/org/uberfire/client/mvp/PlaceManagerImpl.java

@@ -283,7 +283,7 @@ private boolean closePlaces(final Collection<PlaceRequest> placeRequests) {
     /**
      * Resolves the given place request into an Activity instance, if one can be found. If not, this method substitutes
      * special "not found" or "too many" place requests when the resolution doesn't work.
-     * <p/>
+     * </p>
      * The behaviour of this method is affected by the boolean-valued
      * {@code org.uberfire.client.mvp.PlaceManagerImpl.ignoreUnkownPlaces} property in {@link UberfirePreferences}.
      * @param place A non-null place request that could have originated from within application code, from within the

packages/dashbuilder/appformer/uberfire-workbench/uberfire-workbench-client/src/main/java/org/uberfire/client/workbench/AlternativeLayout.java

@@ -32,7 +32,7 @@
 
 /**
  * Part of the worbench layout SPI. Used to declare {@link org.uberfire.client.workbench.WorkbenchLayout}
- * implementations, that should be used as an alternative to the default {@link org.uberfire.client.workbench.WorkbenchLayoutImpl}.<p/>
+ * implementations, that should be used as an alternative to the default {@link org.uberfire.client.workbench.WorkbenchLayoutImpl}.
  * The actual discovery mechenism resides with {@link org.uberfire.client.workbench.LayoutSelection}
  */
 @Qualifier

packages/dashbuilder/appformer/uberfire-workbench/uberfire-workbench-client/src/main/java/org/uberfire/client/workbench/BeanFactory.java

@@ -35,11 +35,9 @@ public interface BeanFactory {
 
     /**
      * Creates a new part presenter/view pair with the given properties.
-     * @param menus The menus to associate with the new part. Null means no menus.
      * @param title The title to associate with the new part that the containing panel may display
      * @param titleDecoration The title decoration that a panel may choose to display beside the part's title. Null is permitted,
      * and means no title decoration.
-     * <p>
      * NOTE: presently, none of the built-in panel types display a part's title decoration.
      * @param definition Defines all other aspects of the part to create. Must not be null.
      * @param partType The new part type.
@@ -72,10 +70,10 @@ public WorkbenchPanelPresenter newRootPanel(PerspectiveActivity activity,
     public CompassDropController newDropController(final WorkbenchPanelView<?> view);
 
     /**
-     * Destroys the entire graph of beans that were created and returned via a call to any of the <tt>newXXX()</tt>
+     * Destroys the entire graph of beans that were created and returned via a call to any of the <code>newXXX()</code>
      * methods in this class. For example, passing a {@link WorkbenchPartPresenter} instance in will result in the
      * destruction of that presenter, its view, and all other dependent beans injected into that graph of objects.
-     * @param o a bean which was returned from one of the <tt>newXXX()</tt> methods in this class and which has not
+     * @param o a bean which was returned from one of the <code>newXXX()</code> methods in this class and which has not
      * been destroyed yet.
      */
     public void destroy(final Object o);