diff options
author | Alexander Kurtakov | 2019-02-15 10:18:29 +0000 |
---|---|---|
committer | Alexander Kurtakov | 2019-02-15 12:55:18 +0000 |
commit | 734d10b4a5cbf57135bfa680d905d5bf3b976373 (patch) | |
tree | 3700089409f3f683dac0f35636d15730041742b6 | |
parent | d77d64a0697a313ae4934c2b7f8ec72ef6cc25c7 (diff) | |
download | eclipse.platform.team-734d10b4a5cbf57135bfa680d905d5bf3b976373.tar.gz eclipse.platform.team-734d10b4a5cbf57135bfa680d905d5bf3b976373.tar.xz eclipse.platform.team-734d10b4a5cbf57135bfa680d905d5bf3b976373.zip |
Bug 543933 - Build javadocs with Java 11
Fix javadoc warnings catched by Java 11 tool. (take 2)
Change-Id: Ic592eb6ef82b3439c43644170200671756e0b06c
Signed-off-by: Alexander Kurtakov <akurtako@redhat.com>
13 files changed, 103 insertions, 98 deletions
diff --git a/bundles/org.eclipse.compare/compare/org/eclipse/compare/structuremergeviewer/package.html b/bundles/org.eclipse.compare/compare/org/eclipse/compare/structuremergeviewer/package.html index 60257a4d8..e4aca5bf8 100644 --- a/bundles/org.eclipse.compare/compare/org/eclipse/compare/structuremergeviewer/package.html +++ b/bundles/org.eclipse.compare/compare/org/eclipse/compare/structuremergeviewer/package.html @@ -71,9 +71,6 @@ input elements to compare. Then it uses a <b>IStructureCreator</b> to extract a tree of <b>IStructureComparator</b> and <b>IStreamContentAccessor</b> from them. These trees are then compared with the differencing engine and the result is displayed in the tree viewer. -<p> - - </body> </html> diff --git a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/IFileContentManager.java b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/IFileContentManager.java index 11bab8726..e8c63f69c 100644 --- a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/IFileContentManager.java +++ b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/IFileContentManager.java @@ -25,15 +25,13 @@ import org.eclipse.core.resources.IStorage; * point or via this interface. * * For methods that determine the content type for a given file, the following - * rules apply: <li> + * rules apply: * <ul> - * Mappings for the entire file name take precedence over mappings for the file - * extension only. - * </ul> - * <ul> - * User-defined mappings take precedence over plugin-contributed mappings - * </ul> + * <li>Mappings for the entire file name take precedence over mappings for the + * file extension only.</li> + * <li>User-defined mappings take precedence over plugin-contributed mappings * </li> + * </ul> * * If a mapping is added for a name or an extension that already has a mapping * which has been contributed by a plugin, it overrides the one contributed by 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 409429dce..5e75323f3 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 @@ -61,14 +61,15 @@ import org.eclipse.team.internal.core.TeamPlugin; * project that is associated with a repository provider. The lifecycle of these * instances is is similar to that of the platform's 'nature' mechanism. * <p> - * To create a repository provider and have it registered with the platform, a client - * must minimally: + * To create a repository provider and have it registered with the platform, a + * client must minimally: + * </p> * <ol> - * <li>extend <code>RepositoryProvider</code> - * <li>define a repository extension in <code>plugin.xml</code>. - * Here is an example extension point definition: + * <li>extend <code>RepositoryProvider</code> + * <li>define a repository extension in <code>plugin.xml</code>. Here is an + * example extension point definition: * - * <code> + * <code> * <br><extension point="org.eclipse.team.core.repository"> * <br> <repository * <br> class="org.eclipse.myprovider.MyRepositoryProvider" @@ -76,11 +77,13 @@ import org.eclipse.team.internal.core.TeamPlugin; * <br> </repository> * <br></extension> * </code> - * </ol></p> + * </ol> * <p> - * Once a repository provider is registered with Team, then you - * can associate a repository provider with a project by invoking <code>RepositoryProvider.map()</code>. + * Once a repository provider is registered with Team, then you can associate a + * repository provider with a project by invoking + * <code>RepositoryProvider.map()</code>. * </p> + * * @see RepositoryProvider#map(IProject, String) * * @since 2.0 diff --git a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/RepositoryProviderType.java b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/RepositoryProviderType.java index 24e7f5035..219100a99 100644 --- a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/RepositoryProviderType.java +++ b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/RepositoryProviderType.java @@ -31,20 +31,21 @@ import org.eclipse.team.internal.core.DefaultProjectSetCapability; import org.eclipse.team.internal.core.TeamPlugin; /** - * This class represents things you can ask/do with a type of provider. This - * is in the absence of a project, as opposed to RepositoryProvider which - * requires a concrete project in order to be instantiated. + * This class represents things you can ask/do with a type of provider. This is + * in the absence of a project, as opposed to RepositoryProvider which requires + * a concrete project in order to be instantiated. * <p> - * A repository provider type class is associated with it's provider ID along with it's - * corresponding repository provider class. To add a - * repository provider type and have it registered with the platform, a client - * must minimally: + * A repository provider type class is associated with it's provider ID along + * with it's corresponding repository provider class. To add a repository + * provider type and have it registered with the platform, a client must + * minimally: + * </p> * <ol> - * <li>extend <code>RepositoryProviderType</code> - * <li>add the typeClass field to the repository extension in <code>plugin.xml</code>. - * Here is an example extension point definition: + * <li>extend <code>RepositoryProviderType</code> + * <li>add the typeClass field to the repository extension in + * <code>plugin.xml</code>. Here is an example extension point definition: * - * <code> + * <code> * <br><extension point="org.eclipse.team.core.repository"> * <br> <repository * <br> class="org.eclipse.myprovider.MyRepositoryProvider" @@ -53,11 +54,12 @@ import org.eclipse.team.internal.core.TeamPlugin; * <br> </repository> * <br></extension> * </code> - * </ol></p> + * </ol> * * <p> - * Once a repository provider type is registered with Team, then you - * can access the singleton instance of the class by invoking <code>RepositoryProviderType.getProviderType()</code>. + * Once a repository provider type is registered with Team, then you can access + * the singleton instance of the class by invoking + * <code>RepositoryProviderType.getProviderType()</code>. * </p> * * @see RepositoryProviderType#getProviderType(String) diff --git a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/diff/IDiffVisitor.java b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/diff/IDiffVisitor.java index ab6f71e1c..d365953d7 100644 --- a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/diff/IDiffVisitor.java +++ b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/diff/IDiffVisitor.java @@ -17,6 +17,8 @@ package org.eclipse.team.core.diff; * An objects that visits diffs in a diff tree. * <p> * Usage: + * </p> + * * <pre> * class Visitor implements IDiffVisitor { * public boolean visit(IDiffNode diff) { @@ -37,10 +39,10 @@ package org.eclipse.team.core.diff; * IDiffTree tree = ...; * tree.accept(new Visitor()); * </pre> - * </p> * <p> * Clients may implement this interface. * </p> + * * @see IDiffTree#accept(org.eclipse.core.runtime.IPath, IDiffVisitor, int) * * @since 3.2 diff --git a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/mapping/IMergeContext.java b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/mapping/IMergeContext.java index 71624ef64..f3040790b 100644 --- a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/mapping/IMergeContext.java +++ b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/mapping/IMergeContext.java @@ -34,19 +34,19 @@ import org.eclipse.team.core.mapping.provider.MergeContext; * Provides the context for an <code>IResourceMappingMerger</code> or a model * specific synchronization view that supports merging. * <p> - * <a name="async">The diff tree associated with this context may be updated - * asynchronously in response to calls to any method of this context (e.g. merge - * and markAsMerged methods) that may result in changes in the synchronization - * state of resources. It may also get updated as a result of changes triggered - * from other sources. Hence, the callback from the diff tree to report changes - * may occur in the same thread as the method call or asynchronously in a - * separate thread, regardless of who triggered the refresh. Clients of this - * method (and any other asynchronous method on this context) may determine if - * all changes have been collected using {@link IJobManager#find(Object)} using - * this context as the <code>family</code> argument in order to determine if - * there are any jobs running that are populating the diff tree. Clients may - * also call {@link IJobManager#join(Object, IProgressMonitor)} if they wish to - * wait until all background handlers related to this context are finished. + * The diff tree associated with this context may be updated asynchronously in + * response to calls to any method of this context (e.g. merge and markAsMerged + * methods) that may result in changes in the synchronization state of + * resources. It may also get updated as a result of changes triggered from + * other sources. Hence, the callback from the diff tree to report changes may + * occur in the same thread as the method call or asynchronously in a separate + * thread, regardless of who triggered the refresh. Clients of this method (and + * any other asynchronous method on this context) may determine if all changes + * have been collected using {@link IJobManager#find(Object)} using this context + * as the <code>family</code> argument in order to determine if there are any + * jobs running that are populating the diff tree. Clients may also call + * {@link IJobManager#join(Object, IProgressMonitor)} if they wish to wait until + * all background handlers related to this context are finished. * </p> * * @see IResourceMappingMerger diff --git a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/mapping/ISynchronizationContext.java b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/mapping/ISynchronizationContext.java index 6be277da9..34185a815 100644 --- a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/mapping/ISynchronizationContext.java +++ b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/mapping/ISynchronizationContext.java @@ -42,17 +42,17 @@ import org.eclipse.team.core.mapping.provider.SynchronizationContext; * both sources in order to guarantee that they update any dependent state * appropriately. * <p> - * <a name="async">The diff tree associated with this context may be updated - * asynchronously in response to calls to any method of this context (e.g. - * refresh methods) that may result in changes in the synchronization state of - * resources. It may also get updated as a result of changes triggered from - * other sources. Hence, the callback from the diff tree to report changes may - * occur in the same thread as the method call or asynchronously in a separate - * thread, regardless of who triggered the refresh. Clients of this method (and - * any other asynchronous method on this context) may determine if all changes - * have been collected using {@link IJobManager#find(Object)} using this context - * as the <code>family</code> argument in order to determine if there are any - * jobs running that are populating the diff tree. Clients may also call + * The diff tree associated with this context may be updated asynchronously in + * response to calls to any method of this context (e.g. refresh methods) that + * may result in changes in the synchronization state of resources. It may also + * get updated as a result of changes triggered from other sources. Hence, the + * callback from the diff tree to report changes may occur in the same thread as + * the method call or asynchronously in a separate thread, regardless of who + * triggered the refresh. Clients of this method (and any other asynchronous + * method on this context) may determine if all changes have been collected + * using {@link IJobManager#find(Object)} using this context as the + * <code>family</code> argument in order to determine if there are any jobs + * running that are populating the diff tree. Clients may also call * {@link IJobManager#join(Object, IProgressMonitor)} if they wish to wait until * all background handlers related to this context are finished. * </p> diff --git a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/mapping/provider/ResourceDiff.java b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/mapping/provider/ResourceDiff.java index 3b2683737..7fbbf5735 100644 --- a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/mapping/provider/ResourceDiff.java +++ b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/mapping/provider/ResourceDiff.java @@ -48,11 +48,12 @@ public class ResourceDiff extends TwoWayDiff implements IResourceDiff { } /** - * Convenience constructor for creating a simple folder diff - * that consists of a resource and a kind only. It is equivalent to - * <code>ResourceDiff(resource, kind, 0, null, null)<code> + * Convenience constructor for creating a simple folder diff that consists of a + * resource and a kind only. It is equivalent to + * <code>ResourceDiff(resource, kind, 0, null, null)</code> + * * @param resource a resource - * @param kind the kind of change (ADDED, REMOVED or CHANGED) + * @param kind the kind of change (ADDED, REMOVED or CHANGED) */ public ResourceDiff(IResource resource, int kind) { this(resource, kind, 0, null, null); diff --git a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/synchronize/SyncInfo.java b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/synchronize/SyncInfo.java index 11e21ee6b..91103b8c6 100644 --- a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/synchronize/SyncInfo.java +++ b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/synchronize/SyncInfo.java @@ -24,44 +24,46 @@ import org.eclipse.team.core.variants.IResourceVariantComparator; import org.eclipse.team.internal.core.Messages; /** - * Describes the synchronization of a <b>local</b> resource - * relative to a <b>remote</b> resource variant. There are two - * types of comparison: two-way and three-way. - * The {@link IResourceVariantComparator} is used to decide which + * Describes the synchronization of a <b>local</b> resource relative to a + * <b>remote</b> resource variant. There are two types of comparison: two-way + * and three-way. The {@link IResourceVariantComparator} is used to decide which * comparison type to use. - * </p> * <p> - * For two-way comparisons, a <code>SyncInfo</code> node has a change - * type. This will be one of <code>IN-SYNC</code>, <code>ADDITION</code>, - * <code>DELETION</code> or <code>CHANGE</code> determined in the following manner. + * For two-way comparisons, a <code>SyncInfo</code> node has a change type. This + * will be one of <code>IN-SYNC</code>, <code>ADDITION</code>, + * <code>DELETION</code> or <code>CHANGE</code> determined in the following + * manner. + * </p> * <ul> - * <li>A resource is considered an <code>ADDITION</code> if it exists locally and there is no remote. - * <li>A resource is considered an <code>DELETION</code> if it does not exists locally and there is remote. - * <li>A resource is considered a <code>CHANGE</code> if both the local and remote exist but the - * comparator indicates that they differ. The comparator may be comparing contents or - * timestamps or some other resource state. + * <li>A resource is considered an <code>ADDITION</code> if it exists locally + * and there is no remote. + * <li>A resource is considered an <code>DELETION</code> if it does not exists + * locally and there is remote. + * <li>A resource is considered a <code>CHANGE</code> if both the local and + * remote exist but the comparator indicates that they differ. The comparator + * may be comparing contents or timestamps or some other resource state. * <li>A resource is considered <code>IN_SYNC</code> in all other cases. * </ul> - * </p><p> - * For three-way comparisons, the sync info node has a direction as well as a change - * type. The direction is one of <code>INCOMING</code>, <code>OUTGOING</code> or <code>CONFLICTING</code>. The comparison - * of the local and remote resources with a <b>base</b> resource is used to determine + * <p> + * For three-way comparisons, the sync info node has a direction as well as a + * change type. The direction is one of <code>INCOMING</code>, + * <code>OUTGOING</code> or <code>CONFLICTING</code>. The comparison of the + * local and remote resources with a <b>base</b> resource is used to determine * the direction of the change. + * </p> * <ul> - * <li>Differences between the base and local resources - * are classified as <b>outgoing changes</b>; if there is - * a difference, the local resource is considered the - * <b>outgoing resource</b>. - * <li>Differences between the base and remote resources - * are classified as <b>incoming changes</b>; if there is - * a difference, the remote resource is considered the - * <b>incoming resource</b>. - * <li>If there are both incoming and outgoing changes, the resource - * is considered a <b>conflicting change</b>. + * <li>Differences between the base and local resources are classified as + * <b>outgoing changes</b>; if there is a difference, the local resource is + * considered the <b>outgoing resource</b>. + * <li>Differences between the base and remote resources are classified as + * <b>incoming changes</b>; if there is a difference, the remote resource is + * considered the <b>incoming resource</b>. + * <li>If there are both incoming and outgoing changes, the resource is + * considered a <b>conflicting change</b>. * </ul> - * Again, the comparison of resources is done using the variant comparator provided - * when the sync info was created. - * </p> + * Again, the comparison of resources is done using the variant comparator + * provided when the sync info was created. + * * @since 3.0 */ public class SyncInfo implements IAdaptable { diff --git a/bundles/org.eclipse.team.ui/src/org/eclipse/team/ui/synchronize/ISynchronizePage.java b/bundles/org.eclipse.team.ui/src/org/eclipse/team/ui/synchronize/ISynchronizePage.java index 6cecb615e..ffc5aed18 100644 --- a/bundles/org.eclipse.team.ui/src/org/eclipse/team/ui/synchronize/ISynchronizePage.java +++ b/bundles/org.eclipse.team.ui/src/org/eclipse/team/ui/synchronize/ISynchronizePage.java @@ -53,7 +53,7 @@ public interface ISynchronizePage { * @param configuration the synchronize page configuration * @param key the property key * @param newValue - * @return <code>true<code> if the property change should continue to be + * @return <code>true</code> if the property change should continue to be * fired to other listeners or <code>false</code> to veto the property change * notification. */ 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 c8ed07717..ca284f7e6 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 @@ -46,7 +46,7 @@ import org.eclipse.ui.part.IPageBookViewPage; * enabled <code>synchronizeWizards</code> it will also appear in the global synchronize action * toolbar. * <p> - * A participant is added to the workbench as follows: + * A participant is added to the workbench as follows:</p> * <ul> * <li>A <code>synchronizeParticipant</code> extension is contributed to * the team registry. This extension defines the participant id, name, icon, type, and @@ -56,7 +56,7 @@ import org.eclipse.ui.part.IPageBookViewPage; * synchronize manager. It then appears in the synchronize view. * <li>A synchronization can be persistent and thus re-initialized at startup. * <li>A pinned participant will only be removed from the synchronize manager if it is un-pinned. - * </ul></p> + * </ul> * <p> * Once a participant is added to the synchronize manager its lifecycle will be managed. On shutdown if * the participant is persistable, the participant will be asked to persist state via diff --git a/bundles/org.eclipse.team.ui/src/org/eclipse/team/ui/synchronize/SubscriberParticipant.java b/bundles/org.eclipse.team.ui/src/org/eclipse/team/ui/synchronize/SubscriberParticipant.java index c341417d4..f01431ae1 100644 --- a/bundles/org.eclipse.team.ui/src/org/eclipse/team/ui/synchronize/SubscriberParticipant.java +++ b/bundles/org.eclipse.team.ui/src/org/eclipse/team/ui/synchronize/SubscriberParticipant.java @@ -59,13 +59,13 @@ import org.eclipse.ui.progress.IProgressConstants2; * The subscriber can be configured to be synchronized in the background based on a schedule. This * effectively refreshes the subscriber and updates the dynamic sync set. * </p><p> - * Subclasses will typically want to override the following methods: + * Subclasses will typically want to override the following methods:</p> * <ul> * <li>initializeConfiguration: participants can add toolbar actions, configure the context menu, decorator. * <li>saveState and init: persist settings between sessions. * </ul> * This class is intended to be subclassed. - * </p> + * <br><br> * @since 3.0 */ public abstract class SubscriberParticipant extends AbstractSynchronizeParticipant implements IPropertyChangeListener { diff --git a/bundles/org.eclipse.team.ui/src/org/eclipse/team/ui/synchronize/SynchronizePageActionGroup.java b/bundles/org.eclipse.team.ui/src/org/eclipse/team/ui/synchronize/SynchronizePageActionGroup.java index 19bc50cbb..db5754927 100644 --- a/bundles/org.eclipse.team.ui/src/org/eclipse/team/ui/synchronize/SynchronizePageActionGroup.java +++ b/bundles/org.eclipse.team.ui/src/org/eclipse/team/ui/synchronize/SynchronizePageActionGroup.java @@ -43,6 +43,7 @@ import org.eclipse.ui.actions.ActionGroup; * configuration has been created by the page but before the page is created. * <p> * The life cycle of an action group is: + * </p> * <ul> * <li>the <code>initialize(ISynchronizePageConfiguration}</code> method is * invoked before the methods to populate menus. This is done to give clients @@ -67,7 +68,6 @@ import org.eclipse.ui.actions.ActionGroup; * a chance to adjust the input to actions that operate on all visible elements. * <li>The <code>dispose()</code> method is called when the page is disposed. * </ul> - * </p> * @since 3.0 */ public abstract class SynchronizePageActionGroup extends ActionGroup { |