Bug 543933 - Build javadocs with Java 11
Fix javadoc warnings catched by Java 11 tool with XDoclint:html.
Change-Id: I18df76d31c00c0d19776a6c0fe5e627528e75c04
Signed-off-by: Alexander Kurtakov <akurtako@redhat.com>
diff --git a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/RepositoryProvider.java b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/RepositoryProvider.java
index 5e75323..d2f4c70 100644
--- a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/RepositoryProvider.java
+++ b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/RepositoryProvider.java
@@ -520,7 +520,6 @@
* the project or if the project is closed or does not exist. This method should be called if the caller
* is looking for <b>any</b> repository provider. Otherwise call <code>getProvider(project, id)</code>
* to look for a specific repository provider type.
- * </p>
* @param project the project to query for a provider
* @return the repository provider associated with the project
*/
diff --git a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/diff/IDiffTree.java b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/diff/IDiffTree.java
index b8d38ed..9197625 100644
--- a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/diff/IDiffTree.java
+++ b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/diff/IDiffTree.java
@@ -111,17 +111,19 @@
public boolean isEmpty();
/**
- * Return the number of out-of-sync elements in the given set whose synchronization
- * state matches the given mask. A state of 0 assumes a count of all changes.
- * A mask of 0 assumes a direct match of the given state.
+ * Return the number of out-of-sync elements in the given set whose
+ * synchronization state matches the given mask. A state of 0 assumes a count of
+ * all changes. A mask of 0 assumes a direct match of the given state.
* <p>
* For example, this will return the number of outgoing changes in the set:
- * <pre>
- * long outgoing = countFor(IThreeWayDiff.OUTGOING, IThreeWayDiff.DIRECTION_MASK);
- * </pre>
* </p>
+ *
+ * <pre>
+ * long outgoing = countFor(IThreeWayDiff.OUTGOING, IThreeWayDiff.DIRECTION_MASK);
+ * </pre>
+ *
* @param state the sync state
- * @param mask the sync state mask
+ * @param mask the sync state mask
* @return the number of matching resources in the set.
*/
public long countFor(int state, int mask);
diff --git a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/diff/ITwoWayDiff.java b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/diff/ITwoWayDiff.java
index f051afd..0ffff4c5 100644
--- a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/diff/ITwoWayDiff.java
+++ b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/diff/ITwoWayDiff.java
@@ -78,43 +78,45 @@
/**
* Returns flags which describe in more detail how a object has been affected.
* <p>
- * The following codes (bit masks) are used when kind is <code>CHANGE</code>, and
- * also when the object is involved in a move:
+ * The following codes (bit masks) are used when kind is <code>CHANGE</code>,
+ * and also when the object is involved in a move:
+ * </p>
* <ul>
- * <li><code>CONTENT</code> - The bytes contained by the resource have
- * been altered.</li>
- * <li><code>REPLACE</code> - The object
- * was deleted (either by a delete or move), and was subsequently re-created
- * (either by a create, move, or copy).</li>
+ * <li><code>CONTENT</code> - The bytes contained by the resource have been
+ * altered.</li>
+ * <li><code>REPLACE</code> - The object was deleted (either by a delete or
+ * move), and was subsequently re-created (either by a create, move, or
+ * copy).</li>
* </ul>
- * The following code is only used if kind is <code>REMOVE</code>
- * (or <code>CHANGE</code> in conjunction with <code>REPLACE</code>):
+ * The following code is only used if kind is <code>REMOVE</code> (or
+ * <code>CHANGE</code> in conjunction with <code>REPLACE</code>):
* <ul>
- * <li><code>MOVE_TO</code> - The object has moved.
- * <code>getToPath</code> will return the path of where it was moved to.</li>
+ * <li><code>MOVE_TO</code> - The object has moved. <code>getToPath</code> will
+ * return the path of where it was moved to.</li>
* </ul>
- * The following code is only used if kind is <code>ADD</code>
- * (or <code>CHANGE</code> in conjunction with <code>REPLACE</code>):
+ * The following code is only used if kind is <code>ADD</code> (or
+ * <code>CHANGE</code> in conjunction with <code>REPLACE</code>):
* <ul>
- * <li><code>MOVE_FROM</code> - The object has moved.
- * <code>getFromPath</code> will return the path of where it was moved from.</li>
- * <li><code>COPY_FROM</code> - The object has copied.
- * <code>getFromPath</code> will return the path of where it was copied from.</li>
+ * <li><code>MOVE_FROM</code> - The object has moved. <code>getFromPath</code>
+ * will return the path of where it was moved from.</li>
+ * <li><code>COPY_FROM</code> - The object has copied. <code>getFromPath</code>
+ * will return the path of where it was copied from.</li>
* </ul>
- * A simple move operation would result in the following diff information.
- * If a object is moved from A to B (with no other changes to A or B),
- * then A will have kind <code>REMOVE</code>, with flag <code>MOVE_TO</code>,
- * and <code>getToPath</code> on A will return the path for B.
- * B will have kind <code>ADD</code>, with flag <code>MOVE_FROM</code>,
- * and <code>getFromPath</code> on B will return the path for A.
- * B's other flags will describe any other changes to the resource, as compared
- * to its previous location at A.
+ * <p>
+ * A simple move operation would result in the following diff information. If a
+ * object is moved from A to B (with no other changes to A or B), then A will
+ * have kind <code>REMOVE</code>, with flag <code>MOVE_TO</code>, and
+ * <code>getToPath</code> on A will return the path for B. B will have kind
+ * <code>ADD</code>, with flag <code>MOVE_FROM</code>, and
+ * <code>getFromPath</code> on B will return the path for A. B's other flags
+ * will describe any other changes to the resource, as compared to its previous
+ * location at A.
* </p>
* <p>
* Note that the move flags only describe the changes to a single object; they
* don't necessarily imply anything about the parent or children of the object.
- * If the children were moved as a consequence of a subtree move operation,
- * they will have corresponding move flags as well.
+ * If the children were moved as a consequence of a subtree move operation, they
+ * will have corresponding move flags as well.
* </p>
*
* @return the flags
diff --git a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/diff/provider/DiffTree.java b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/diff/provider/DiffTree.java
index e828ab0..6163c84 100644
--- a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/diff/provider/DiffTree.java
+++ b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/diff/provider/DiffTree.java
@@ -190,22 +190,26 @@
/**
* This method is used to obtain a lock on the set which ensures thread safety
- * and batches change notification. If the set is locked by another thread,
- * the calling thread will block until the lock
- * becomes available. This method uses an <code>org.eclipse.core.runtime.jobs.ILock</code>.
+ * and batches change notification. If the set is locked by another thread, the
+ * calling thread will block until the lock becomes available. This method uses
+ * an <code>org.eclipse.core.runtime.jobs.ILock</code>.
* <p>
- * It is important that the lock is released after it is obtained. Calls to <code>endInput</code>
- * should be done in a finally block as illustrated in the following code snippet.
+ * It is important that the lock is released after it is obtained. Calls to
+ * <code>endInput</code> should be done in a finally block as illustrated in the
+ * following code snippet.
+ * </p>
+ *
* <pre>
- * try {
- * set.beginInput();
- * // do stuff
- * } finally {
- * set.endInput(progress);
- * }
+ * try {
+ * set.beginInput();
+ * // do stuff
+ * } finally {
+ * set.endInput(progress);
+ * }
* </pre>
- * </p><p>
- * Calls to <code>beginInput</code> and <code>endInput</code> can be nested and must be matched.
+ * <p>
+ * Calls to <code>beginInput</code> and <code>endInput</code> can be nested and
+ * must be matched.
* </p>
*/
public void beginInput() {
@@ -428,7 +432,6 @@
* Report to any listeners that an error has occurred while populating the
* set. Listeners will be notified that an error occurred and can react
* accordingly.
- * </p>
*
* @param status
* the status that describes the error that occurred.
diff --git a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/synchronize/SyncInfoSet.java b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/synchronize/SyncInfoSet.java
index 6a5cbc6..4c16835 100644
--- a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/synchronize/SyncInfoSet.java
+++ b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/synchronize/SyncInfoSet.java
@@ -133,13 +133,16 @@
/**
* Return the number of out-of-sync resources in the given set whose sync kind
- * matches the given kind and mask (e.g. <code>(SyncInfo#getKind() & mask) == kind</code>).
+ * matches the given kind and mask (e.g.
+ * <code>(SyncInfo#getKind() & mask) == kind</code>).
* <p>
* For example, this will return the number of outgoing changes in the set:
- * <pre>
- * long outgoing = countFor(SyncInfo.OUTGOING, SyncInfo.DIRECTION_MASK);
- * </pre>
* </p>
+ *
+ * <pre>
+ * long outgoing = countFor(SyncInfo.OUTGOING, SyncInfo.DIRECTION_MASK);
+ * </pre>
+ *
* @param kind the sync kind
* @param mask the sync kind mask
* @return the number of matching resources in the set.
@@ -502,22 +505,26 @@
/**
* This method is used to obtain a lock on the set which ensures thread safety
- * and batches change notification. If the set is locked by another thread,
- * the calling thread will block until the lock
- * becomes available. This method uses an <code>org.eclipse.core.runtime.jobs.ILock</code>.
+ * and batches change notification. If the set is locked by another thread, the
+ * calling thread will block until the lock becomes available. This method uses
+ * an <code>org.eclipse.core.runtime.jobs.ILock</code>.
* <p>
- * It is important that the lock is released after it is obtained. Calls to <code>endInput</code>
- * should be done in a finally block as illustrated in the following code snippet.
+ * It is important that the lock is released after it is obtained. Calls to
+ * <code>endInput</code> should be done in a finally block as illustrated in the
+ * following code snippet.
+ * </p>
+ *
* <pre>
- * try {
- * set.beginInput();
- * // do stuff
- * } finally {
- * set.endInput(progress);
- * }
+ * try {
+ * set.beginInput();
+ * // do stuff
+ * } finally {
+ * set.endInput(progress);
+ * }
* </pre>
- * </p><p>
- * Calls to <code>beginInput</code> and <code>endInput</code> can be nested and must be matched.
+ * <p>
+ * Calls to <code>beginInput</code> and <code>endInput</code> can be nested and
+ * must be matched.
* </p>
*/
public void beginInput() {
diff --git a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/synchronize/SyncInfoTree.java b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/synchronize/SyncInfoTree.java
index 74f395a..0a55b35 100644
--- a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/synchronize/SyncInfoTree.java
+++ b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/synchronize/SyncInfoTree.java
@@ -84,21 +84,23 @@
}
/**
- * Return the <code>SyncInfo</code> for each out-of-sync resource in the subtree rooted at the given resource
- * to the depth specified. The depth is one of:
+ * Return the <code>SyncInfo</code> for each out-of-sync resource in the subtree
+ * rooted at the given resource to the depth specified. The depth is one of:
* <ul>
* <li><code>IResource.DEPTH_ZERO</code>: the resource only,
* <li><code>IResource.DEPTH_ONE</code>: the resource or its direct children,
- * <li><code>IResource.DEPTH_INFINITE</code>: the resource and all of it's descendants.
- * <ul>
+ * <li><code>IResource.DEPTH_INFINITE</code>: the resource and all of it's
+ * descendants.
+ * </ul>
* If the given resource is out of sync, it will be included in the result.
* <p>
* The default implementation makes use of <code>getSyncInfo(IResource)</code>,
- * <code>members(IResource)</code> and <code>getSyncInfos()</code>
- * to provide the varying depths. Subclasses may override to optimize.
+ * <code>members(IResource)</code> and <code>getSyncInfos()</code> to provide
+ * the varying depths. Subclasses may override to optimize.
* </p>
+ *
* @param resource the root of the resource subtree
- * @param depth the depth of the subtree
+ * @param depth the depth of the subtree
* @return the <code>SyncInfo</code> for any out-of-sync resources
*/
public synchronized SyncInfo[] getSyncInfos(IResource resource, int depth) {
@@ -261,15 +263,17 @@
}
/**
- * Remove from this set the <code>SyncInfo</code> for the given resource and any of its descendants
- * within the specified depth. The depth is one of:
+ * Remove from this set the <code>SyncInfo</code> for the given resource and any
+ * of its descendants within the specified depth. The depth is one of:
* <ul>
* <li><code>IResource.DEPTH_ZERO</code>: the resource only,
* <li><code>IResource.DEPTH_ONE</code>: the resource or its direct children,
- * <li><code>IResource.DEPTH_INFINITE</code>: the resource and all of it's descendants.
- * <ul>
+ * <li><code>IResource.DEPTH_INFINITE</code>: the resource and all of it's
+ * descendants.
+ * </ul>
+ *
* @param resource the root of the resource subtree
- * @param depth the depth of the subtree
+ * @param depth the depth of the subtree
*/
public void remove(IResource resource, int depth) {
try {
diff --git a/bundles/org.eclipse.team.ui/src/org/eclipse/team/ui/history/IHistoryPage.java b/bundles/org.eclipse.team.ui/src/org/eclipse/team/ui/history/IHistoryPage.java
index 77fd673..160ab3d 100644
--- a/bundles/org.eclipse.team.ui/src/org/eclipse/team/ui/history/IHistoryPage.java
+++ b/bundles/org.eclipse.team.ui/src/org/eclipse/team/ui/history/IHistoryPage.java
@@ -162,12 +162,13 @@
* registered.
* <p>
* The changes supported by the page are as follows:
+ * </p>
* <ul>
* <li><code>P_NAME</code>- indicates the name
* of the page has changed</li>
* <li><code>P_DESCRIPTION</code>- indicates the
* description of the page has changed</li>
- * </ul></p>
+ * </ul>
* <p>
* Clients may define additional properties as required.
* </p>
diff --git a/bundles/org.eclipse.team.ui/src/org/eclipse/team/ui/synchronize/AbstractSynchronizeParticipant.java b/bundles/org.eclipse.team.ui/src/org/eclipse/team/ui/synchronize/AbstractSynchronizeParticipant.java
index ad52baf..753c5bc 100644
--- a/bundles/org.eclipse.team.ui/src/org/eclipse/team/ui/synchronize/AbstractSynchronizeParticipant.java
+++ b/bundles/org.eclipse.team.ui/src/org/eclipse/team/ui/synchronize/AbstractSynchronizeParticipant.java
@@ -274,7 +274,6 @@
* }
* </pre>
* where <code>PARTICIPANT_ID</code> is the id of the participant as defined in the plugin manifest.
- * </p>
* @see org.eclipse.team.ui.synchronize.ISynchronizeParticipant#init(String, org.eclipse.ui.IMemento)
*/
@Override
diff --git a/bundles/org.eclipse.team.ui/src/org/eclipse/team/ui/synchronize/ISynchronizeParticipant.java b/bundles/org.eclipse.team.ui/src/org/eclipse/team/ui/synchronize/ISynchronizeParticipant.java
index ca284f7..577d2f9 100644
--- a/bundles/org.eclipse.team.ui/src/org/eclipse/team/ui/synchronize/ISynchronizeParticipant.java
+++ b/bundles/org.eclipse.team.ui/src/org/eclipse/team/ui/synchronize/ISynchronizeParticipant.java
@@ -191,7 +191,7 @@
* resources associated with a participant. When a participant is added
* to the {@link ISynchronizeManager} this method is called when the
* manager is shutdown or the participant is removed from the manager.
- * </p><p>
+ * <p>
* Within this method a participant may release any resources, fonts, images, etc.
* held by this part. It is also very important to remove all listeners.
* </p><p>
@@ -218,12 +218,13 @@
* registered.
* <p>
* The changes supported by the synchronize view are as follows:
+ * </p>
* <ul>
* <li><code>IBasicPropertyConstants.P_TEXT</code>- indicates the name
* of a synchronize participant has changed</li>
* <li><code>IBasicPropertyConstants.P_IMAGE</code>- indicates the
* image of a synchronize participant has changed</li>
- * </ul></p>
+ * </ul>
* <p>
* Clients may define additional properties as required.
* </p>
