Bug 543933 - Build javadocs with Java 11
Fix javadoc warnings catched by Java 11 tool with XDoclint:html.
Change-Id: Iec68312944a23082f17ac1cdd7c7e8f078c8c396
Signed-off-by: Alexander Kurtakov <akurtako@redhat.com>
diff --git a/bundles/org.eclipse.core.commands/src/org/eclipse/core/commands/operations/IOperationHistory.java b/bundles/org.eclipse.core.commands/src/org/eclipse/core/commands/operations/IOperationHistory.java
index b225c02..0e0ba03 100644
--- a/bundles/org.eclipse.core.commands/src/org/eclipse/core/commands/operations/IOperationHistory.java
+++ b/bundles/org.eclipse.core.commands/src/org/eclipse/core/commands/operations/IOperationHistory.java
@@ -493,46 +493,43 @@
/**
* <p>
* Redo the specified operation. The redo of the operation is subject to
- * approval by any registered {@link IOperationApprover} before it is
- * attempted.
+ * approval by any registered {@link IOperationApprover} before it is attempted.
* </p>
*
- * @param operation
- * the operation to be redone
- * @param monitor
- * the progress monitor to be used for the redo, or code>null</code>
- * if no progress monitor is provided
- * @param info
- * the IAdaptable (or <code>null</code>) provided by the
- * caller in order to supply UI information for prompting the
- * user if necessary. When this parameter is not <code>null</code>,
- * it should minimally contain an adapter for the
- * org.eclipse.swt.widgets.Shell.class.
+ * @param operation the operation to be redone
+ * @param monitor the progress monitor to be used for the redo, or
+ * <code>null</code> if no progress monitor is provided
+ * @param info the IAdaptable (or <code>null</code>) provided by the caller
+ * in order to supply UI information for prompting the user if
+ * necessary. When this parameter is not <code>null</code>, it
+ * should minimally contain an adapter for the
+ * org.eclipse.swt.widgets.Shell.class.
*
* @return the IStatus indicating whether the redo succeeded.
*
- * <p>
- * The severity code in the returned status describes whether the operation
- * succeeded and whether it remains in the history. <code>OK</code>
- * severity indicates that the redo operation was successful, and (since
- * release 3.2), that the operation will be placed in the undo history.
- * (Prior to 3.2, a successfully redone operation would not be placed on the
- * undo history if it could not be undone. Since 3.2, this is relaxed, and
- * all successfully redone operations are placed in the undo history.)
- * Listeners will receive the <code>REDONE</code> notification.
- * </p>
- * <p>
- * Other severity codes (<code>CANCEL</code>, <code>ERROR</code>,
- * <code>INFO</code>, etc.) are not specifically interpreted by the
- * history. The operation will remain in the history and the returned status
- * is simply passed back to the caller. For all severities other than <code>OK</code>,
- * listeners will receive the <code>OPERATION_NOT_OK</code> notification
- * instead of the <code>REDONE</code> notification if the redo was
- * approved and attempted.
- * </p>
+ * <p>
+ * The severity code in the returned status describes whether the
+ * operation succeeded and whether it remains in the history.
+ * <code>OK</code> severity indicates that the redo operation was
+ * successful, and (since release 3.2), that the operation will be
+ * placed in the undo history. (Prior to 3.2, a successfully redone
+ * operation would not be placed on the undo history if it could not be
+ * undone. Since 3.2, this is relaxed, and all successfully redone
+ * operations are placed in the undo history.) Listeners will receive
+ * the <code>REDONE</code> notification.
+ * </p>
+ * <p>
+ * Other severity codes (<code>CANCEL</code>, <code>ERROR</code>,
+ * <code>INFO</code>, etc.) are not specifically interpreted by the
+ * history. The operation will remain in the history and the returned
+ * status is simply passed back to the caller. For all severities other
+ * than <code>OK</code>, listeners will receive the
+ * <code>OPERATION_NOT_OK</code> notification instead of the
+ * <code>REDONE</code> notification if the redo was approved and
+ * attempted.
+ * </p>
*
- * @throws ExecutionException
- * if an exception occurred during redo.
+ * @throws ExecutionException if an exception occurred during redo.
*/
IStatus redoOperation(IUndoableOperation operation,
IProgressMonitor monitor, IAdaptable info)
diff --git a/bundles/org.eclipse.core.databinding.observable/src/org/eclipse/core/databinding/observable/list/MultiList.java b/bundles/org.eclipse.core.databinding.observable/src/org/eclipse/core/databinding/observable/list/MultiList.java
index 2641f38..8fc349b 100644
--- a/bundles/org.eclipse.core.databinding.observable/src/org/eclipse/core/databinding/observable/list/MultiList.java
+++ b/bundles/org.eclipse.core.databinding.observable/src/org/eclipse/core/databinding/observable/list/MultiList.java
@@ -51,9 +51,8 @@
* Constructs a MultiList in the default realm, and backed by the given
* observable lists.
*
- * @param lists
- * the array of observable lists backing this MultiList.
- * @deprecated use MultiList(List<IObservableList<E>>) instead
+ * @param lists the array of observable lists backing this MultiList.
+ * @deprecated use {@link #MultiList(List)} instead
*/
@Deprecated
public MultiList(IObservableList<E>[] lists) {
@@ -73,14 +72,12 @@
}
/**
- * Constructs a MultiList in the default realm backed by the given
- * observable lists.
+ * Constructs a MultiList in the default realm backed by the given observable
+ * lists.
*
- * @param lists
- * the array of observable lists backing this MultiList.
- * @param elementType
- * element type of the constructed list.
- * @deprecated use MultiList(List<IObservableList<E>>, Object) instead
+ * @param lists the array of observable lists backing this MultiList.
+ * @param elementType element type of the constructed list.
+ * @deprecated use {@link #MultiList(List, Object)} instead
*/
@Deprecated
public MultiList(IObservableList<E>[] lists, Object elementType) {
@@ -115,17 +112,13 @@
}
/**
- * Constructs a MultiList belonging to the given realm, and backed by the
- * given observable lists.
+ * Constructs a MultiList belonging to the given realm, and backed by the given
+ * observable lists.
*
- * @param realm
- * the observable's realm
- * @param lists
- * the array of observable lists backing this MultiList
- * @param elementType
- * element type of the constructed list.
- * @deprecated use MultiList(realm, List<IObservableList<E>>, Object)
- * instead
+ * @param realm the observable's realm
+ * @param lists the array of observable lists backing this MultiList
+ * @param elementType element type of the constructed list.
+ * @deprecated use {@link #MultiList(Realm, List, Object)} instead
*/
@Deprecated
public MultiList(Realm realm, IObservableList<E>[] lists, Object elementType) {
diff --git a/bundles/org.eclipse.core.databinding.observable/src/org/eclipse/core/databinding/observable/value/ComputedValue.java b/bundles/org.eclipse.core.databinding.observable/src/org/eclipse/core/databinding/observable/value/ComputedValue.java
index e3b6423..54b098e 100644
--- a/bundles/org.eclipse.core.databinding.observable/src/org/eclipse/core/databinding/observable/value/ComputedValue.java
+++ b/bundles/org.eclipse.core.databinding.observable/src/org/eclipse/core/databinding/observable/value/ComputedValue.java
@@ -87,19 +87,18 @@
/**
* Factory method to create {@link ComputedValue} objects in an easy manner.
- * <br/>
- * <br/>
+ * <br>
+ * <br>
* Example observing the size of an {@link IObservableList}:
*
* <pre>
* IObservableValue<Integer> listSizeObservable = ComputedValue.create(() -> observableList.size());
* </pre>
*
- * @param supplier
- * {@link Supplier}, whose {@link Supplier#get()} method is a
- * TrackedGetter. See
- * {@link ObservableTracker#getterCalled(IObservable)} for
- * details.
+ * @param supplier {@link Supplier}, whose {@link Supplier#get()} method is a
+ * TrackedGetter. See
+ * {@link ObservableTracker#getterCalled(IObservable)} for
+ * details.
* @return {@link ComputedValue} whose value is computed using the given
* {@link Supplier}.
* @since 1.6
diff --git a/bundles/org.eclipse.core.databinding.observable/src/org/eclipse/core/databinding/observable/value/IObservableValue.java b/bundles/org.eclipse.core.databinding.observable/src/org/eclipse/core/databinding/observable/value/IObservableValue.java
index f43028a..abc2408 100644
--- a/bundles/org.eclipse.core.databinding.observable/src/org/eclipse/core/databinding/observable/value/IObservableValue.java
+++ b/bundles/org.eclipse.core.databinding.observable/src/org/eclipse/core/databinding/observable/value/IObservableValue.java
@@ -41,7 +41,7 @@
* The value type of this observable value, or <code>null</code> if this
* observable value is untyped.
*
- * @return the value type, or <code>null</null>
+ * @return the value type, or <code>null</code>
*/
public Object getValueType();
diff --git a/bundles/org.eclipse.core.databinding.property/src/org/eclipse/core/databinding/property/package.html b/bundles/org.eclipse.core.databinding.property/src/org/eclipse/core/databinding/property/package.html
index 6eddb4f..7b12df4 100644
--- a/bundles/org.eclipse.core.databinding.property/src/org/eclipse/core/databinding/property/package.html
+++ b/bundles/org.eclipse.core.databinding.property/src/org/eclipse/core/databinding/property/package.html
@@ -10,9 +10,9 @@
<h2>
Package Specification</h2>
<p>
-This package and its subpackages provide the <tt>IProperty</tt>,
-<tt>IValueProperty</tt>, <tt>IListProperty</tt>, <tt>ISetProperty</tt> and
-<tt>IMapProperty</tt> interfaces, along with classes
+This package and its subpackages provide the <code>IProperty</code>,
+<code>IValueProperty</code>, <code>IListProperty</code>, <code>ISetProperty</code> and
+<code>IMapProperty</code> interfaces, along with classes
which serve as base implementations of each interface.
<p>
Properties are intended to serve as a convenient path to creating observables
@@ -23,8 +23,8 @@
observables correctly can be tricky, so the properties API tries to ease this
burden by providing all the observable implementations. Property implementers
only need to extend one of the provided base classes
-(<tt>SimpleValueProperty</tt>, <tt>SimpleListProperty</tt>,
-<tt>SimpleSetProperty</tt> or <tt>SimpleMapProperty</tt>) and implement a
+(<code>SimpleValueProperty</code>, <code>SimpleListProperty</code>,
+<code>SimpleSetProperty</code> or <code>SimpleMapProperty</code>) and implement a
handful of abstract methods which the observables use to function.
<li>Simplify observation of nested properties. Traditionally observing a
nested property required creating an observable for the first property, then
@@ -34,8 +34,8 @@
</ul>
<p>
A set of delegating properties are also provided
-(<tt>DelegatingValueProperty</tt>, <tt>DelegatingListProperty</tt>,
-<tt>DelegatingSetProperty</tt> and <tt>DelegatingMapProperty</tt>) which
+(<code>DelegatingValueProperty</code>, <code>DelegatingListProperty</code>,
+<code>DelegatingSetProperty</code> and <code>DelegatingMapProperty</code>) which
may be used to implement properties where the property behavior depends on the
type of source object.
</body>
diff --git a/bundles/org.eclipse.core.databinding/src/org/eclipse/core/databinding/package.html b/bundles/org.eclipse.core.databinding/src/org/eclipse/core/databinding/package.html
index 9087bbf..1a6347b 100644
--- a/bundles/org.eclipse.core.databinding/src/org/eclipse/core/databinding/package.html
+++ b/bundles/org.eclipse.core.databinding/src/org/eclipse/core/databinding/package.html
@@ -14,29 +14,29 @@
This package provides classes that can be used to synchronize state between pairs of
observable objects with optional data type conversion and validation.
<p>
-A <tt>DataBindingContext</tt> is used to manage a list of <tt>Bindings</tt>
+A <code>DataBindingContext</code> is used to manage a list of <code>Bindings</code>
with their validation results.
</p>
<p>
-Concrete subclasses of <tt>Binding</tt> synchronize state between two observables,
+Concrete subclasses of <code>Binding</code> synchronize state between two observables,
called the target observable and the model observable. Usually, the binding will
first copy the current state of the model observable to the target observable and
from then on track changes on both sides, reacting to changes on one side by
performing the corresponding change on the other side.
</p>
<p>
-For each binding, two <tt>UpdateValueStrategy</tt> or <tt>UpdateListStrategy</tt> objects (one
+For each binding, two <code>UpdateValueStrategy</code> or <code>UpdateListStrategy</code> objects (one
for each direction) is used to control how the binding should synchronize, and can be used to
specify data type converters and validators.
</p>
<p>
-<tt>AggregateValidationStatus</tt> allows clients to aggregate the current validation
+<code>AggregateValidationStatus</code> allows clients to aggregate the current validation
statuses of a list of bindings, typically obtained from a data binding context.
</p>
<p>
For advanced validation, conversion, or similar requirements that affect the way
-state is copied from one side to the other, subclasses of <tt>UpdateValueStrategy</tt>
-or <tt>UpdateListStrategy</tt> can be created.
+state is copied from one side to the other, subclasses of <code>UpdateValueStrategy</code>
+or <code>UpdateListStrategy</code> can be created.
</p>
</body>
</html>
diff --git a/bundles/org.eclipse.jface/src/org/eclipse/jface/action/Action.java b/bundles/org.eclipse.jface/src/org/eclipse/jface/action/Action.java
index 01d742a..69437fa 100644
--- a/bundles/org.eclipse.jface/src/org/eclipse/jface/action/Action.java
+++ b/bundles/org.eclipse.jface/src/org/eclipse/jface/action/Action.java
@@ -85,11 +85,12 @@
}
/**
- * Maps a standard keyboard key name to an SWT key code. Key names are
- * converted to upper case before comparison. If the key name is a single
- * letter, for example "S", its character code is returned.
+ * Maps a standard keyboard key name to an SWT key code. Key names are converted
+ * to upper case before comparison. If the key name is a single letter, for
+ * example "S", its character code is returned.
* <p>
* The following key names are known (case is ignored):
+ * </p>
* <ul>
* <li><code>"BACKSPACE"</code></li>
* <li><code>"TAB"</code></li>
@@ -107,10 +108,8 @@
* <li><code>"INSERT"</code></li>
* <li><code>"F1"</code>, <code>"F2"</code> through <code>"F12"</code></li>
* </ul>
- * </p>
*
- * @param token
- * the key name
+ * @param token the key name
* @return the SWT key code, <code>-1</code> if no match was found
* @see org.eclipse.swt.SWT
*/
diff --git a/bundles/org.eclipse.jface/src/org/eclipse/jface/viewers/StructuredViewer.java b/bundles/org.eclipse.jface/src/org/eclipse/jface/viewers/StructuredViewer.java
index c1c1e56..29f5aa2 100644
--- a/bundles/org.eclipse.jface/src/org/eclipse/jface/viewers/StructuredViewer.java
+++ b/bundles/org.eclipse.jface/src/org/eclipse/jface/viewers/StructuredViewer.java
@@ -1192,10 +1192,10 @@
/**
* The <code>StructuredViewer</code> implementation of this
- * <code>ContentViewer</code> method calls <code>update</code> if the
- * event specifies that the label of a given element has changed, otherwise
- * it calls super. Subclasses may reimplement or extend.
- * </p>
+ * <code>ContentViewer</code> method calls <code>update</code> if the event
+ * specifies that the label of a given element has changed, otherwise it calls
+ * super. Subclasses may reimplement or extend.
+ *
* @param event the event that generated this update
*/
@Override
@@ -1385,26 +1385,25 @@
}
/**
- * Attempts to preserves the current selection across a run of the given
- * code. This method should not preserve the selection if
- * {link #getPreserveSelection()} returns false.
+ * Attempts to preserves the current selection across a run of the given code.
+ * This method should not preserve the selection if {link
+ * #getPreserveSelection()} returns false.
* <p>
* The default implementation of this method:
+ * </p>
* <ul>
* <li>discovers the old selection (via <code>getSelection</code>)</li>
* <li>runs the given runnable</li>
* <li>attempts to restore the old selection (using
* <code>setSelectionToWidget</code></li>
* <li>rediscovers the resulting selection (via <code>getSelection</code>)</li>
- * <li>calls <code>handleInvalidSelection</code> if the resulting selection
- * is different from the old selection</li>
+ * <li>calls <code>handleInvalidSelection</code> if the resulting selection is
+ * different from the old selection</li>
* </ul>
- * </p>
*
- * @param updateCode
- * the code to run
+ * @param updateCode the code to run
*
- * see #getPreserveSelection()
+ * see #getPreserveSelection()
*/
protected void preservingSelection(Runnable updateCode) {
preservingSelection(updateCode, false);
