various javadoc fixes

reduce ecj warnings in workspace

Author: EcljpseB0T

bundles/org.eclipse.e4.ui.workbench.renderers.swt/src/org/eclipse/e4/ui/workbench/renderers/swt/MenuManagerShowProcessor.java

@@ -116,8 +116,7 @@ public void menuAboutToHide(IMenuManager manager) {
 	}
 
 	/**
-	 * HashMap key for storage of {@link MDynamicMenuContribution} elements used
-	 * in {@link #processDynamicElements(MMenu, MenuManager)}
+	 * HashMap key for storage of {@link MDynamicMenuContribution} elements
 	 */
 	protected static final String DYNAMIC_ELEMENT_STORAGE_KEY = MenuManagerShowProcessor.class
 			.getSimpleName() + ".dynamicElements"; //$NON-NLS-1$

bundles/org.eclipse.e4.ui.workbench.renderers.swt/src/org/eclipse/e4/ui/workbench/renderers/swt/ToolControlRenderer.java

@@ -75,7 +75,7 @@ public class ToolControlRenderer extends SWTPartRenderer {
 	/**
 	 * The state ID for a toggle state understood by the system.
 	 *
-	 * @see RegistryToggleState.STATE_ID
+	 * see org.eclipse.ui.handlers.RegistryToggleState.STATE_ID
 	 */
 	public static final String STATE_ID = "org.eclipse.ui.commands.toggleState"; //$NON-NLS-1$
 

bundles/org.eclipse.e4.ui.workbench/src/org/eclipse/e4/ui/internal/workbench/URIHelper.java

@@ -111,7 +111,7 @@ static public String EMFtoPlatform(org.eclipse.emf.common.util.URI uri) {
 	 * @param uri
 	 *            a possible Platform URI
 	 * @return true if the given string is not {@code null} and starts with
-	 *         {@value #PLATFORM_SCHEMA}; false otherwise
+	 *         {@code "platform:/"}; false otherwise
 	 */
 	public static boolean isPlatformURI(String uri) {
 		return uri != null && uri.startsWith(PLATFORM_SCHEMA);
@@ -120,10 +120,9 @@ public static boolean isPlatformURI(String uri) {
 	/**
 	 * Helper method which checks if given String represents a Bundleclass URI.
 	 *
-	 * @param uri
-	 *            a possible Bundleclass URI
+	 * @param uri a possible Bundleclass URI
 	 * @return true if the given string is not {@code null} and starts with
-	 *         {@value #BUNDLECLASS_SCHEMA}; false otherwise
+	 *         {@code "bundleclass://"}. false otherwise
 	 */
 	public static boolean isBundleClassUri(String uri) {
 		if (uri != null && uri.startsWith(BUNDLECLASS_SCHEMA)) {

bundles/org.eclipse.jface.text/src/org/eclipse/jface/text/TextViewer.java

@@ -1082,7 +1082,7 @@ private static final class ColumnPosition extends Position {
 	private final class ViewerState {
 		/** The position tracking the selection. */
 		private Position[] fSelections;
-		/** <code>true</code> if {@link #fSelection} was originally backwards. */
+		/** <code>true</code> if {@link #fSelections} was originally backwards. */
 		private boolean fReverseSelection;
 		/** <code>true</code> if the selection has been updated while in redraw(off) mode. */
 		private boolean fSelectionSet;
@@ -1091,7 +1091,7 @@ private final class ViewerState {
 		/** The pixel offset of the stable line measured from the client area. */
 		private int fStablePixel;
 
-		/** The position updater for {@link #fSelection} and {@link #fStableLine}. */
+		/** The position updater for {@link #fSelections} and {@link #fStableLine}. */
 		private IPositionUpdater fUpdater;
 		/** The document that the position updater and the positions are registered with. */
 		private IDocument fUpdaterDocument;

bundles/org.eclipse.ui.ide/src/org/eclipse/ui/ide/IDE.java

@@ -219,7 +219,6 @@ public interface Preferences {
 		 * </p>
 		 *
 		 * @see org.eclipse.ui.IWorkbenchPreferenceConstants#OPEN_PERSPECTIVE_WINDOW
-		 * @see org.eclipse.ui.IWorkbenchPreferenceConstants#OPEN_PERSPECTIVE_PAGE
 		 * @see org.eclipse.ui.IWorkbenchPreferenceConstants#OPEN_PERSPECTIVE_REPLACE
 		 * @see org.eclipse.ui.IWorkbenchPreferenceConstants#NO_NEW_PERSPECTIVE
 		 */

bundles/org.eclipse.ui.ide/src/org/eclipse/ui/internal/views/markers/GroupFilterConfigurationArea.java

@@ -16,11 +16,6 @@
 
 import org.eclipse.ui.views.markers.FilterConfigurationArea;
 
-/**
- * GroupFilterConfigurationArea is the FilterConfigurationArea for the special case
- * group level settings for a {@link MarkerFieldFilterGroup}
- * @since 3.4
- */
 abstract class GroupFilterConfigurationArea extends FilterConfigurationArea {
 
 	/**

bundles/org.eclipse.ui.navigator/src/org/eclipse/ui/navigator/CommonNavigator.java

@@ -134,7 +134,7 @@ public class CommonNavigator extends ViewPart implements ISetSelectionTarget, IS
 
 	/**
 	 * <p>
-	 * Used to track changes to the {@link #isLinkingEnabled}&nbsp;property.
+	 * Used to track changes to {@link #isLinkingEnabled()}.
 	 * </p>
 	 *
 	 * Make sure this does not conflict with anything in IWorkbenchPartConstants.

bundles/org.eclipse.ui.navigator/src/org/eclipse/ui/navigator/INavigatorContentService.java

@@ -20,7 +20,7 @@
 import org.eclipse.jface.viewers.ILabelProvider;
 import org.eclipse.jface.viewers.IStructuredContentProvider;
 import org.eclipse.jface.viewers.ITreeContentProvider;
-import org.eclipse.jface.viewers.ViewerSorter;
+import org.eclipse.jface.viewers.ViewerComparator;
 import org.eclipse.ui.IMemento;
 import org.eclipse.ui.ISaveablesSource;
 
@@ -379,14 +379,13 @@ INavigatorContentDescriptor[] bindExtensions(String[] extensionIds,
 	INavigatorFilterService getFilterService();
 
 	/**
-	 * The sorter service provides the appropriate sorter based on the current
-	 * items being sorted. By default, the CommonViewer uses
-	 * {@link CommonViewerSorter} which delegates to this service. Clients do
-	 * not need to provide their own {@link ViewerSorter} unless they wish to
-	 * override this functionality.
+	 * The sorter service provides the appropriate sorter based on the current items
+	 * being sorted. By default, the CommonViewer uses {@link CommonViewerSorter}
+	 * which delegates to this service. Clients do not need to provide their own
+	 * {@link ViewerComparator} unless they wish to override this functionality.
 	 *
 	 * @return An {@link INavigatorSorterService} that can provide
-	 *         {@link ViewerSorter} based on the context of the parent.
+	 *         {@link ViewerComparator} based on the context of the parent.
 	 */
 	INavigatorSorterService getSorterService();
 

bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/BasicWorkingSetElementAdapter.java

@@ -87,7 +87,6 @@ private static class Type {
 	 * @see org.eclipse.ui.IWorkingSetElementAdapter#adaptElements(org.eclipse.ui.IWorkingSet,
 	 *      org.eclipse.core.runtime.IAdaptable[])
 	 * @see org.eclipse.core.runtime.IAdapterManager#getAdapter(Object, String)
-	 * @see org.osgi.service.packageadmin.PackageAdmin#getExportedPackage(String)
 	 */
 	@Override
 	public IAdaptable[] adaptElements(IWorkingSet ws, IAdaptable[] elements) {

bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/activities/ITriggerPointManager.java

@@ -30,9 +30,7 @@
 public interface ITriggerPointManager {
 
 	/**
-	 * Constant representing the id of an unknown trigger point. Used by clients of
-	 * {@link WorkbenchActivityHelper#allowUseOf(Object)} for trigger point
-	 * determination logic.
+	 * Constant representing the id of an unknown trigger point.
 	 */
 	String UNKNOWN_TRIGGER_POINT_ID = "org.eclipse.ui.internal.UnknownTriggerPoint"; //$NON-NLS-1$
 

bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/activities/WorkbenchActivityHelper.java

@@ -68,7 +68,7 @@ public static IIdentifier getIdentifier(IPluginContribution contribution) {
 	 *         enablement.
 	 * @see #allowUseOf(ITriggerPoint, Object)
 	 */
-	@Deprecated
+	@Deprecated(forRemoval = true, since = "2024-03")
 	public static boolean allowUseOf(Object object) {
 		return allowUseOf(PlatformUI.getWorkbench().getActivitySupport().getTriggerPointManager()
 				.getTriggerPoint(ITriggerPointManager.UNKNOWN_TRIGGER_POINT_ID), object);

bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/commands/AbstractHandler.java

@@ -40,7 +40,7 @@
  * @noreference This class is scheduled for deletion.
  * @noextend This class is not intended to be extended by clients.
  */
-@Deprecated
+@Deprecated(forRemoval = true, since = "2024-03")
 @SuppressWarnings({ "unchecked" })
 public abstract class AbstractHandler extends org.eclipse.core.commands.AbstractHandler implements IHandler {
 

bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/internal/WorkbenchPage.java

@@ -5501,10 +5501,11 @@ public void resetToolBarLayout() {
 	}
 
 	/**
-	 * Call {@link #firePartDeactivated(MPart)} if the passed part is the currently
-	 * active part according to the part service. This method should only be called
-	 * in the case of workbench shutdown, where E4 does not fire deactivate
-	 * listeners on the active part.
+	 * Fires
+	 * {@link org.eclipse.ui.IPartListener2#partDeactivated(IWorkbenchPartReference)}
+	 * if the passed part is the currently active part according to the part
+	 * service. This method should only be called in the case of workbench shutdown,
+	 * where E4 does not fire deactivate listeners on the active part.
 	 */
 	public void firePartDeactivatedIfActive(MPart part) {
 		if (partService.getActivePart() == part) {

bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/internal/about/AboutUtils.java

@@ -21,6 +21,7 @@
 import java.net.URL;
 import java.util.ArrayList;
 import java.util.StringTokenizer;
+import org.eclipse.core.runtime.FileLocator;
 import org.eclipse.core.runtime.IPath;
 import org.eclipse.core.runtime.IStatus;
 import org.eclipse.core.runtime.Platform;
@@ -108,15 +109,15 @@ else if (nextWhitespace != -1)
 	 * to a resource within a bundle, then a temp copy of the file will be extracted
 	 * and opened.
 	 *
-	 * @see Platform#asLocalURL(URL)
+	 * @see FileLocator#toFileURL(URL)
 	 *
 	 * @param url The target url to be displayed, null will be safely ignored
 	 * @return true if the url was successfully displayed and false otherwise
 	 */
-	public static boolean openBrowser(Shell shell, URL url) {
+	public static boolean openBrowser(@SuppressWarnings("unused") Shell shell, URL url) {
 		if (url != null) {
 			try {
-				url = Platform.asLocalURL(url);
+				url = FileLocator.toFileURL(url);
 			} catch (IOException e) {
 				return false;
 			}

bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/internal/dialogs/cpd/ItemDetailToolTip.java

@@ -59,8 +59,7 @@
 
 /**
  * A tooltip with useful information based on the type of ContributionItem the
- * cursor hovers over in a Tree. In addition to the content provided by the
- * {@link NameAndDescriptionToolTip} this includes action set information and
+ * cursor hovers over in a Tree. This adds action set information and
  * key binding data.
  *
  * @since 3.5

bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/internal/handlers/LegacyHandlerProxy.java

@@ -80,9 +80,6 @@ public void dispose() {
 		}
 	}
 
-	/**
-	 * @see IHandler#execute(Map)
-	 */
 	@Override
 	public Object execute(Map parameters) throws ExecutionException {
 		if (loadHandler()) {
@@ -92,9 +89,6 @@ public Object execute(Map parameters) throws ExecutionException {
 		return null;
 	}
 
-	/**
-	 * @see IHandler#getAttributeValuesByName()
-	 */
 	@Override
 	public Map getAttributeValuesByName() {
 		if (loadHandler()) {

bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/internal/keys/SchemeLegacyWrapper.java

@@ -21,7 +21,7 @@
 
 /**
  * A wrapper around the new {@link Scheme} class, providing supported for the
- * old {@link IKeyConfiguration} interface.
+ * old {@code IKeyConfiguration} interface.
  *
  * @since 3.1
  */

bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/internal/registry/IWorkbenchRegistryConstants.java

@@ -810,30 +810,6 @@ public interface IWorkbenchRegistryConstants {
 	 */
 	String EXTENSION_VIEW_ACTIONS = PlatformUI.PLUGIN_ID + '.' + PL_VIEW_ACTIONS;
 
-	/**
-	 * The constant for the position attribute corresponding to
-	 * {@link SOrder#POSITION_AFTER}.
-	 */
-	String POSITION_AFTER = "after"; //$NON-NLS-1$
-
-	/**
-	 * The constant for the position attribute corresponding to
-	 * {@link SOrder#POSITION_BEFORE}.
-	 */
-	String POSITION_BEFORE = "before"; //$NON-NLS-1$
-
-	/**
-	 * The constant for the position attribute corresponding to
-	 * {@link SOrder#POSITION_END}.
-	 */
-	String POSITION_END = "end"; //$NON-NLS-1$
-
-	/**
-	 * The constant for the position attribute corresponding to
-	 * {@link SOrder#POSITION_START}.
-	 */
-	String POSITION_START = "start"; //$NON-NLS-1$
-
 	/**
 	 * The action style for drop-down menus.
 	 */

bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/internal/themes/ColorsAndFontsPreferencePage.java

@@ -514,7 +514,6 @@ private boolean isDefault(IThemeElementDefinition def) {
 		 * Returns the DEFINITION_NOT_AVAIL_COLOR color when definition is not present
 		 * in the current theme or null when it is available
 		 *
-		 * @param def the definition
 		 * @return the DEFINITION_NOT_AVAIL_COLOR color or null
 		 */
 		@Override