diff options
author | Alexander Kurtakov | 2019-04-13 06:30:02 +0000 |
---|---|---|
committer | Alexander Kurtakov | 2019-04-13 09:28:58 +0000 |
commit | 4081e5319ca95c2a724da3fd432e91f4518b16a7 (patch) | |
tree | 8509d97f12cfd7f118b1f1ab03661a53e391bedd | |
parent | 7e78e535caf4f15e637d628cac5cfaabc2c47fae (diff) | |
download | eclipse.platform.team-4081e5319ca95c2a724da3fd432e91f4518b16a7.tar.gz eclipse.platform.team-4081e5319ca95c2a724da3fd432e91f4518b16a7.tar.xz eclipse.platform.team-4081e5319ca95c2a724da3fd432e91f4518b16a7.zip |
Bug 545330 - Problems in javadoc for platform
Fix some javadoc in platform.team.
Change-Id: Iaea2910b26777a73b1eeba526eee762647599f19
Signed-off-by: Alexander Kurtakov <akurtako@redhat.com>
22 files changed, 63 insertions, 59 deletions
diff --git a/bundles/org.eclipse.compare/META-INF/MANIFEST.MF b/bundles/org.eclipse.compare/META-INF/MANIFEST.MF index add50011c..986c0c667 100644 --- a/bundles/org.eclipse.compare/META-INF/MANIFEST.MF +++ b/bundles/org.eclipse.compare/META-INF/MANIFEST.MF @@ -2,7 +2,7 @@ Manifest-Version: 1.0 Bundle-ManifestVersion: 2 Bundle-Name: %pluginName Bundle-SymbolicName: org.eclipse.compare; singleton:=true -Bundle-Version: 3.7.500.qualifier +Bundle-Version: 3.7.600.qualifier Bundle-Activator: org.eclipse.compare.internal.CompareUIPlugin Bundle-Vendor: %providerName Bundle-Localization: plugin diff --git a/bundles/org.eclipse.compare/compare/org/eclipse/compare/SharedDocumentAdapter.java b/bundles/org.eclipse.compare/compare/org/eclipse/compare/SharedDocumentAdapter.java index a288f6b62..b5edfdc60 100644 --- a/bundles/org.eclipse.compare/compare/org/eclipse/compare/SharedDocumentAdapter.java +++ b/bundles/org.eclipse.compare/compare/org/eclipse/compare/SharedDocumentAdapter.java @@ -90,13 +90,13 @@ public abstract class SharedDocumentAdapter implements ISharedDocumentAdapter { /** * A helper method to save a document. * - * @param provider the document provider + * @param provider the document provider * @param documentKey the document key - * @param document the document - * @param overwrite indicates whether overwrite should be performed - * while saving the given element if necessary - * @param monitor a progress monitor - * @throws CoreException + * @param document the document + * @param overwrite indicates whether overwrite should be performed while + * saving the given element if necessary + * @param monitor a progress monitor + * @throws CoreException if document could not be stored to the given element */ protected void saveDocument(IDocumentProvider provider, IEditorInput documentKey, IDocument document, boolean overwrite, diff --git a/bundles/org.eclipse.compare/compare/org/eclipse/compare/contentmergeviewer/ContentMergeViewer.java b/bundles/org.eclipse.compare/compare/org/eclipse/compare/contentmergeviewer/ContentMergeViewer.java index 1d8a071eb..a0b270840 100644 --- a/bundles/org.eclipse.compare/compare/org/eclipse/compare/contentmergeviewer/ContentMergeViewer.java +++ b/bundles/org.eclipse.compare/compare/org/eclipse/compare/contentmergeviewer/ContentMergeViewer.java @@ -1277,7 +1277,7 @@ public abstract class ContentMergeViewer extends ContentViewer } /** - * @param monitor + * @param monitor The progress monitor to report progress. * @noreference This method is not intended to be referenced by clients. */ @Override @@ -1286,7 +1286,7 @@ public abstract class ContentMergeViewer extends ContentViewer } /** - * @param monitor + * @param monitor The progress monitor to report progress. * @noreference This method is not intended to be referenced by clients. */ @Override diff --git a/bundles/org.eclipse.compare/compare/org/eclipse/compare/contentmergeviewer/TextMergeViewer.java b/bundles/org.eclipse.compare/compare/org/eclipse/compare/contentmergeviewer/TextMergeViewer.java index e0ed70dd5..6135f5ba7 100644 --- a/bundles/org.eclipse.compare/compare/org/eclipse/compare/contentmergeviewer/TextMergeViewer.java +++ b/bundles/org.eclipse.compare/compare/org/eclipse/compare/contentmergeviewer/TextMergeViewer.java @@ -1931,7 +1931,6 @@ public class TextMergeViewer extends ContentMergeViewer implements IAdaptable { * Called on the viewer disposal. * Unregisters from the compare configuration. * Clients may extend if they have to do additional cleanup. - * @param event */ @Override protected void handleDispose(DisposeEvent event) { diff --git a/bundles/org.eclipse.compare/compare/org/eclipse/compare/structuremergeviewer/StructureCreator.java b/bundles/org.eclipse.compare/compare/org/eclipse/compare/structuremergeviewer/StructureCreator.java index ce9d9645c..ac4ae690e 100644 --- a/bundles/org.eclipse.compare/compare/org/eclipse/compare/structuremergeviewer/StructureCreator.java +++ b/bundles/org.eclipse.compare/compare/org/eclipse/compare/structuremergeviewer/StructureCreator.java @@ -439,21 +439,19 @@ public abstract class StructureCreator implements IStructureCreator2 { * <code>compareFilters</code> is not empty, the filters are applied to each * line of each node's text representation. * - * @param node1 - * @param contributor1 - * either 'A', 'L', or 'R' for ancestor, left or right - * contributor - * @param node2 - * @param contributor2 - * either 'A', 'L', or 'R' for ancestor, left or right - * contributor - * @param ignoreWhitespace - * if <code>true</code> whitespace characters will be ignored - * when determining equality. Note: Will bypass any custom ignore - * whitespace behaviors contributed through implementations of - * <code>org.eclipse.compare.structuremergeviewer.IStructureCreator.getContents()</code> - * @param compareFilters - * the filters used to customize the comparison of lines of text. + * @param node1 first node + * @param contributor1 either 'A', 'L', or 'R' for ancestor, left or right + * contributor + * @param node2 second node + * @param contributor2 either 'A', 'L', or 'R' for ancestor, left or right + * contributor + * @param ignoreWhitespace if <code>true</code> whitespace characters will be + * ignored when determining equality. Note: Will bypass + * any custom ignore whitespace behaviors contributed + * through implementations of + * <code>org.eclipse.compare.structuremergeviewer.IStructureCreator.getContents()</code> + * @param compareFilters the filters used to customize the comparison of lines + * of text. * @return whether the two nodes are equal for comparison purposes * @noreference This method is not intended to be referenced by clients. * @since 3.6 diff --git a/bundles/org.eclipse.compare/pom.xml b/bundles/org.eclipse.compare/pom.xml index 4570dc39c..dae26a943 100644 --- a/bundles/org.eclipse.compare/pom.xml +++ b/bundles/org.eclipse.compare/pom.xml @@ -19,6 +19,6 @@ </parent> <groupId>org.eclipse.compare</groupId> <artifactId>org.eclipse.compare</artifactId> - <version>3.7.500-SNAPSHOT</version> + <version>3.7.600-SNAPSHOT</version> <packaging>eclipse-plugin</packaging> </project> diff --git a/bundles/org.eclipse.core.net/META-INF/MANIFEST.MF b/bundles/org.eclipse.core.net/META-INF/MANIFEST.MF index 3ac01d200..8cfe03f3e 100644 --- a/bundles/org.eclipse.core.net/META-INF/MANIFEST.MF +++ b/bundles/org.eclipse.core.net/META-INF/MANIFEST.MF @@ -2,7 +2,7 @@ Manifest-Version: 1.0 Bundle-ManifestVersion: 2 Bundle-Name: %PLUGIN_NAME Bundle-SymbolicName: org.eclipse.core.net;singleton:=true -Bundle-Version: 1.3.400.qualifier +Bundle-Version: 1.3.500.qualifier Bundle-Activator: org.eclipse.core.internal.net.Activator Bundle-Vendor: %PLUGIN_PROVIDER Bundle-Localization: plugin diff --git a/bundles/org.eclipse.core.net/pom.xml b/bundles/org.eclipse.core.net/pom.xml index 3ae07e2f8..712b4d565 100644 --- a/bundles/org.eclipse.core.net/pom.xml +++ b/bundles/org.eclipse.core.net/pom.xml @@ -19,6 +19,6 @@ </parent> <groupId>org.eclipse.core</groupId> <artifactId>org.eclipse.core.net</artifactId> - <version>1.3.400-SNAPSHOT</version> + <version>1.3.500-SNAPSHOT</version> <packaging>eclipse-plugin</packaging> </project> diff --git a/bundles/org.eclipse.core.net/src/org/eclipse/core/net/proxy/IProxyService.java b/bundles/org.eclipse.core.net/src/org/eclipse/core/net/proxy/IProxyService.java index ae93d939c..66f76cced 100644 --- a/bundles/org.eclipse.core.net/src/org/eclipse/core/net/proxy/IProxyService.java +++ b/bundles/org.eclipse.core.net/src/org/eclipse/core/net/proxy/IProxyService.java @@ -72,7 +72,7 @@ public interface IProxyService { * Sets whether system proxies should be used, when the proxy support is * enabled. * - * @param enabled + * @param enabled whether system proxies should be used * @since 1.1 */ void setSystemProxiesEnabled(boolean enabled); diff --git a/bundles/org.eclipse.jsch.core/META-INF/MANIFEST.MF b/bundles/org.eclipse.jsch.core/META-INF/MANIFEST.MF index 46d3aefee..c1f9eced4 100644 --- a/bundles/org.eclipse.jsch.core/META-INF/MANIFEST.MF +++ b/bundles/org.eclipse.jsch.core/META-INF/MANIFEST.MF @@ -2,7 +2,7 @@ Manifest-Version: 1.0 Bundle-ManifestVersion: 2 Bundle-Name: %pluginName Bundle-SymbolicName: org.eclipse.jsch.core;singleton:=true -Bundle-Version: 1.3.400.qualifier +Bundle-Version: 1.3.500.qualifier Bundle-Activator: org.eclipse.jsch.internal.core.JSchCorePlugin Bundle-Vendor: %providerName Bundle-Localization: plugin diff --git a/bundles/org.eclipse.jsch.core/pom.xml b/bundles/org.eclipse.jsch.core/pom.xml index 290fce68c..bb9ace711 100644 --- a/bundles/org.eclipse.jsch.core/pom.xml +++ b/bundles/org.eclipse.jsch.core/pom.xml @@ -19,6 +19,6 @@ </parent> <groupId>org.eclipse.jsch</groupId> <artifactId>org.eclipse.jsch.core</artifactId> - <version>1.3.400-SNAPSHOT</version> + <version>1.3.500-SNAPSHOT</version> <packaging>eclipse-plugin</packaging> </project> diff --git a/bundles/org.eclipse.jsch.core/src/org/eclipse/jsch/core/IJSchLocation.java b/bundles/org.eclipse.jsch.core/src/org/eclipse/jsch/core/IJSchLocation.java index 1b60765d3..222719df4 100644 --- a/bundles/org.eclipse.jsch.core/src/org/eclipse/jsch/core/IJSchLocation.java +++ b/bundles/org.eclipse.jsch.core/src/org/eclipse/jsch/core/IJSchLocation.java @@ -72,13 +72,13 @@ public interface IJSchLocation{ /** * Sets the comment for this location. This comment will be displayed * in prompting for the password. - * @param comment + * @param comment Comment to be displayed in password prompt. */ public void setComment(String comment); /** * Return the comment - * @return comment + * @return Comment to be displayed in password prompt. */ public String getComment(); diff --git a/bundles/org.eclipse.jsch.core/src/org/eclipse/jsch/core/IPasswordStore.java b/bundles/org.eclipse.jsch.core/src/org/eclipse/jsch/core/IPasswordStore.java index 3816e7f09..3ff76bada 100644 --- a/bundles/org.eclipse.jsch.core/src/org/eclipse/jsch/core/IPasswordStore.java +++ b/bundles/org.eclipse.jsch.core/src/org/eclipse/jsch/core/IPasswordStore.java @@ -23,20 +23,21 @@ package org.eclipse.jsch.core; public interface IPasswordStore{ /** * The cached password should be flushed. - * @param location + * @param location location string helper */ public void clear(IJSchLocation location); /** * This method will check if the password is cached or not. - * @param location + * @param location location string helper * @return whether the password is cached. */ public boolean isCached(IJSchLocation location); - /* + /** * The new password "location.getPassword()" will be * cached. + * @param location location string helper */ public void update(IJSchLocation location); } diff --git a/bundles/org.eclipse.team.core/META-INF/MANIFEST.MF b/bundles/org.eclipse.team.core/META-INF/MANIFEST.MF index 36687f63e..d5385738e 100644 --- a/bundles/org.eclipse.team.core/META-INF/MANIFEST.MF +++ b/bundles/org.eclipse.team.core/META-INF/MANIFEST.MF @@ -2,7 +2,7 @@ Manifest-Version: 1.0 Bundle-ManifestVersion: 2 Bundle-Name: %pluginName Bundle-SymbolicName: org.eclipse.team.core; singleton:=true -Bundle-Version: 3.8.500.qualifier +Bundle-Version: 3.8.600.qualifier Bundle-Activator: org.eclipse.team.internal.core.TeamPlugin Bundle-Vendor: %providerName Bundle-Localization: plugin diff --git a/bundles/org.eclipse.team.core/pom.xml b/bundles/org.eclipse.team.core/pom.xml index 5d0f570d0..1fb446d90 100644 --- a/bundles/org.eclipse.team.core/pom.xml +++ b/bundles/org.eclipse.team.core/pom.xml @@ -19,6 +19,6 @@ </parent> <groupId>org.eclipse.team</groupId> <artifactId>org.eclipse.team.core</artifactId> - <version>3.8.500-SNAPSHOT</version> + <version>3.8.600-SNAPSHOT</version> <packaging>eclipse-plugin</packaging> </project> diff --git a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/mapping/provider/MergeContext.java b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/mapping/provider/MergeContext.java index f11d1c0a1..f30286846 100644 --- a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/mapping/provider/MergeContext.java +++ b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/mapping/provider/MergeContext.java @@ -73,9 +73,12 @@ import org.eclipse.team.internal.core.mapping.SyncInfoToDiffConverter; public abstract class MergeContext extends SynchronizationContext implements IMergeContext { /** - * Create a merge context. - * @param type - */ + * Create a merge context. + * + * @param manager the manager that defines the scope of the synchronization + * @param type the type of synchronization (ONE_WAY or TWO_WAY) + * @param deltaTree the sync info tree that contains all out-of-sync resources + */ protected MergeContext(ISynchronizationScopeManager manager, int type, IResourceDiffTree deltaTree) { super(manager, type, deltaTree); } diff --git a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/subscribers/ISubscriberChangeEvent.java b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/subscribers/ISubscriberChangeEvent.java index 86aa725ab..37db51a58 100644 --- a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/subscribers/ISubscriberChangeEvent.java +++ b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/subscribers/ISubscriberChangeEvent.java @@ -50,15 +50,16 @@ public interface ISubscriberChangeEvent { public static final int ROOT_REMOVED = 0x4; /** - * Return the flags that describe the type of change. - * The returned value should be ANDed with the change type - * flags to determine whether the change event is of - * a particular type. For example, + * Return the flags that describe the type of change. The returned value should + * be ANDed with the change type flags to determine whether the change event is + * of a particular type. For example, + * * <pre> - * if (event.getFlags() & ISubscriberChangeEvent.SYNC_CHANGED) { - * // the sync info for the resource has changed - * } + * if (event.getFlags() & ISubscriberChangeEvent.SYNC_CHANGED) { + * // the sync info for the resource has changed + * } * </pre> + * * @return the flags that describe the type of change */ public abstract int getFlags(); 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 4c168352b..cd6b35f63 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 @@ -134,7 +134,7 @@ public class SyncInfoSet { /** * 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>). + * <code>(SyncInfo#getKind() & mask) == kind</code>). * <p> * For example, this will return the number of outgoing changes in the set: * </p> @@ -513,7 +513,7 @@ public class SyncInfoSet { * <code>endInput</code> should be done in a finally block as illustrated in the * following code snippet. * </p> - * + * * <pre> * try { * set.beginInput(); diff --git a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/variants/ThreeWayResourceComparator.java b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/variants/ThreeWayResourceComparator.java index ab0464955..0cb9013cb 100644 --- a/bundles/org.eclipse.team.core/src/org/eclipse/team/core/variants/ThreeWayResourceComparator.java +++ b/bundles/org.eclipse.team.core/src/org/eclipse/team/core/variants/ThreeWayResourceComparator.java @@ -31,9 +31,11 @@ public class ThreeWayResourceComparator implements IResourceVariantComparator { private ThreeWaySynchronizer synchronizer; /** - * Create a three-way resource comparator that uses the <code>ThreeWaySynchronizer</code> - * to compare a local resource to a resource variant. - * @param synchronizer + * Create a three-way resource comparator that uses the + * <code>ThreeWaySynchronizer</code> to compare a local resource to a resource + * variant. + * + * @param synchronizer The synchronizer to use. */ public ThreeWayResourceComparator(ThreeWaySynchronizer synchronizer) { this.synchronizer = synchronizer; 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 ffc5aed18..095e9caf0 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 @@ -52,7 +52,7 @@ public interface ISynchronizePage { * * @param configuration the synchronize page configuration * @param key the property key - * @param newValue + * @param newValue new value for the key * @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/ISynchronizeScope.java b/bundles/org.eclipse.team.ui/src/org/eclipse/team/ui/synchronize/ISynchronizeScope.java index 2b2527343..6e625c3b3 100644 --- a/bundles/org.eclipse.team.ui/src/org/eclipse/team/ui/synchronize/ISynchronizeScope.java +++ b/bundles/org.eclipse.team.ui/src/org/eclipse/team/ui/synchronize/ISynchronizeScope.java @@ -58,7 +58,7 @@ public interface ISynchronizeScope { * Add a property change listener that will get invoked when a * property of the receiver changes. * - * @param listener + * @param listener The listener to add. */ public void addPropertyChangeListener(IPropertyChangeListener listener); @@ -66,7 +66,7 @@ public interface ISynchronizeScope { * Remove a property change listener. Removing an unregistered listener * has no effect. * - * @param listener + * @param listener The listener to remove. */ public void removePropertyChangeListener(IPropertyChangeListener listener); 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 f01431ae1..2d653c03a 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 @@ -171,11 +171,11 @@ public abstract class SubscriberParticipant extends AbstractSynchronizeParticipa * Refresh this participants synchronization state and displays the result in a model dialog. * @param shell * - * @param resources + * @param resources the resources to be refreshed. * @param jobName - * @param taskName + * @param taskName the task name to be shown to the user * @param configuration - * @param site + * @param site the site in which to run the refresh */ public final void refreshInDialog(Shell shell, IResource[] resources, String jobName, String taskName, ISynchronizePageConfiguration configuration, IWorkbenchSite site) { IRefreshSubscriberListener listener = new RefreshUserNotificationPolicyInModalDialog(shell, taskName, configuration, this); |