Fix javadocs

Remove @param tags where such param doesn't exist. That way javadoc tool at least doesn't put this false param name in the list of params. Autogenerated list is better than purely imaginery one.
HannesWell · Jul 1, 2023 · 0f03ddf · 0f03ddf
1 parent 553d671
commit 0f03ddf
Show file tree

Hide file tree

Showing 21 changed files with 2 additions and 132 deletions.
diff --git a/...eclipse.e4.ui.css.core/src/org/eclipse/e4/ui/css/core/css2/CSS2FontPropertiesHelpers.java b/...eclipse.e4.ui.css.core/src/org/eclipse/e4/ui/css/core/css2/CSS2FontPropertiesHelpers.java
@@ -36,9 +36,6 @@ public class CSS2FontPropertiesHelpers {
 
 	/**
 	 * Get {@link CSS2FontProperties} from {@link CSSElementContext} context.
-	 *
-	 * @param control
-	 * @return
 	 */
 	public static CSS2FontProperties getCSS2FontProperties(CSSElementContext context) {
 		// Search into Data of context if CSS2FontProperties exist.

diff --git a/...clipse.e4.ui.css.core/src/org/eclipse/e4/ui/css/core/css2/CSSBorderPropertiesHelpers.java b/...clipse.e4.ui.css.core/src/org/eclipse/e4/ui/css/core/css2/CSSBorderPropertiesHelpers.java
@@ -29,10 +29,6 @@ public class CSSBorderPropertiesHelpers {
 	/**
 	 * Update the <code>property of</code> <code>borderProperties</code> instance
 	 * with the <code>value</code>.
-	 *
-	 * @param border
-	 * @param property
-	 * @param value
 	 */
 	public static void updateCSSProperty(CSSBorderProperties borderProperties, String property, CSSValue value) {
 		switch (property) {

diff --git a/bundles/org.eclipse.e4.ui.css.core/src/org/eclipse/e4/ui/css/core/dom/ElementAdapter.java b/bundles/org.eclipse.e4.ui.css.core/src/org/eclipse/e4/ui/css/core/dom/ElementAdapter.java
@@ -54,8 +54,6 @@ public ElementAdapter(Object nativeWidget, CSSEngine engine) {
 
 	/**
 	 * Add static pseudo instance
-	 *
-	 * @param instance
 	 */
 	public void addStaticPseudoInstance(String pseudoE) {
 		if (staticPseudoInstances == null) {

diff --git a/bundles/org.eclipse.e4.ui.css.core/src/org/eclipse/e4/ui/css/core/engine/CSSEngine.java b/bundles/org.eclipse.e4.ui.css.core/src/org/eclipse/e4/ui/css/core/engine/CSSEngine.java
@@ -120,10 +120,6 @@ public interface CSSEngine {
 
 	/**
 	 * Parse CSSValue from InputStream stream.
-	 *
-	 * @param reader
-	 * @return
-	 * @throws IOException
 	 */
 	CSSValue parsePropertyValue(InputStream stream) throws IOException;
 
@@ -185,11 +181,6 @@ public interface CSSEngine {
 
 	/**
 	 * Check if the <code>selector</code> matches the object <code>node</code>.
-	 *
-	 * @param selector
-	 * @param element
-	 * @param pseudo
-	 * @return
 	 */
 	boolean matches(Selector selector, Object node, String pseudo);
 
@@ -252,11 +243,6 @@ public interface CSSEngine {
 
 	/**
 	 * Parse and apply style declaration from InputSource source.
-	 *
-	 * @param node
-	 * @param source
-	 * @return
-	 * @throws IOException
 	 */
 	CSSStyleDeclaration parseAndApplyStyleDeclaration(Object node, InputSource sourcee) throws IOException;
 
@@ -367,11 +353,6 @@ ICSSPropertyHandler applyCSSProperty(Object node, String property, CSSValue valu
 	/**
 	 * Retrieve String of {@link CSSValue} of the CSS <code>property</code> of
 	 * the <code>node</code>.
-	 *
-	 * @param widget
-	 * @param property
-	 * @param pseudo
-	 * @return
 	 */
 	String retrieveCSSProperty(Object node, String property, String pseudo);
 
@@ -393,9 +374,6 @@ ICSSPropertyHandler applyCSSProperty(Object node, String property, CSSValue valu
 	/**
 	 * Get default {@link CSSStyleDeclaration} of the <code>node</code> for
 	 * pseudo element <code>pseudoE</code> which can be null.
-	 *
-	 * @param element
-	 * @return
 	 */
 	CSSStyleDeclaration getDefaultStyleDeclaration(Object node, String pseudoE);
 

diff --git a/....eclipse.e4.ui.css.core/src/org/eclipse/e4/ui/css/core/impl/engine/AbstractCSSEngine.java b/....eclipse.e4.ui.css.core/src/org/eclipse/e4/ui/css/core/impl/engine/AbstractCSSEngine.java
@@ -822,7 +822,6 @@ protected Collection<ICSSPropertyHandler> getCSSPropertyHandlers(String property
 	/**
 	 * Return the set of property names and handlers for the provided node.
 	 *
-	 * @param node
 	 * @return the property names and handlers
 	 */
 	@Override

diff --git a/bundles/org.eclipse.e4.ui.css.swt/src/org/eclipse/e4/ui/css/swt/dom/WidgetElement.java b/bundles/org.eclipse.e4.ui.css.swt/src/org/eclipse/e4/ui/css/swt/dom/WidgetElement.java
@@ -119,7 +119,7 @@ public static void applyStyles(Widget widget,
 	/**
 	 * Convenience method for setting the CSS engine responsible for a display.
 	 *
-	 * @param widget
+	 * @param display
 	 *            SWT display which is styled by an engine
 	 * @param engine
 	 *            Engine to be associated with the display

diff --git a/...les/org.eclipse.e4.ui.css.swt/src/org/eclipse/e4/ui/css/swt/helpers/CSSSWTFontHelper.java b/...les/org.eclipse.e4.ui.css.swt/src/org/eclipse/e4/ui/css/swt/helpers/CSSSWTFontHelper.java
@@ -51,9 +51,6 @@ public class CSSSWTFontHelper {
 	 * Get CSS2FontProperties from Control stored into Data of Control. If
 	 * CSS2FontProperties doesn't exist, create it from Font of Control and
 	 * store it into Data of Control.
-	 *
-	 * @param control
-	 * @return
 	 */
 	public static CSS2FontProperties getCSS2FontProperties(Widget widget,
 			Font font, CSSElementContext context) {
@@ -104,7 +101,6 @@ public static CSS2FontProperties getCSS2FontProperties(Font font,
 	 * Build CSS2FontProperties from SWT Font.
 	 *
 	 * @param font
-	 * @return
 	 */
 	public static CSS2FontProperties getCSS2FontProperties(Font font) {
 		// Create CSS Font Properties
@@ -132,7 +128,6 @@ public static CSS2FontProperties getCSS2FontProperties(Font font) {
 	 * CSS2FontProperties instance into ClientProperty of JComponent.
 	 *
 	 * @param component
-	 * @return
 	 */
 	public static Font getFont(CSS2FontProperties fontProperties,
 			Control control) {
@@ -151,7 +146,6 @@ public static Font getFont(CSS2FontProperties fontProperties,
 	 *
 	 * @param fontProperties
 	 * @param oldFontData
-	 * @return
 	 */
 	public static FontData getFontData(CSS2FontProperties fontProperties, FontData oldFontData) {
 		FontData newFontData = new FontData();
@@ -234,7 +228,6 @@ private static FontData[] findFontDataByDefinition(CSSPrimitiveValue cssFontFami
 	 *
 	 * @param fontProperties
 	 * @param fontData
-	 * @return
 	 */
 	public static int getSWTStyle(CSS2FontProperties fontProperties,
 			FontData fontData) {
@@ -271,7 +264,6 @@ public static int getSWTStyle(CSS2FontProperties fontProperties,
 	 * Return CSS Value font-family from the widget's font, if it has a font
 	 *
 	 * @param widget
-	 * @return
 	 */
 	public static String getFontFamily(Widget widget) {
 		return getFontFamily(getFont(widget));
@@ -281,7 +273,6 @@ public static String getFontFamily(Widget widget) {
 	 * Return CSS Value font-family from SWT Font
 	 *
 	 * @param font
-	 * @return
 	 */
 	public static String getFontFamily(Font font) {
 		FontData fontData = getFirstFontData(font);
@@ -300,7 +291,6 @@ public static String getFontFamily(FontData fontData) {
 	 * Return CSS Value font-size the widget's font, if it has a font
 	 *
 	 * @param widget
-	 * @return
 	 */
 	public static String getFontSize(Widget widget) {
 		return getFontSize(getFont(widget));
@@ -310,7 +300,6 @@ public static String getFontSize(Widget widget) {
 	 * Return CSS Value font-size from SWT Font
 	 *
 	 * @param font
-	 * @return
 	 */
 	public static String getFontSize(Font font) {
 		FontData fontData = getFirstFontData(font);
@@ -328,7 +317,6 @@ public static String getFontSize(FontData fontData) {
 	 * Return CSS Value font-style from the widget's font, if it has a font
 	 *
 	 * @param widget
-	 * @return
 	 */
 	public static String getFontStyle(Widget widget) {
 		return getFontStyle(getFont(widget));
@@ -338,7 +326,6 @@ public static String getFontStyle(Widget widget) {
 	 * Return CSS Value font-style from SWT Font
 	 *
 	 * @param font
-	 * @return
 	 */
 	public static String getFontStyle(Font font) {
 		FontData fontData = getFirstFontData(font);
@@ -360,19 +347,13 @@ public static boolean isItalic(FontData fontData) {
 
 	/**
 	 * Return CSS Value font-weight from the widget's font, if it has a font
-	 *
-	 * @param widget
-	 * @return
 	 */
 	public static String getFontWeight(Widget widget) {
 		return getFontWeight(getFont(widget));
 	}
 
 	/**
 	 * Return CSS Value font-weight from Control Font
-	 *
-	 * @param font
-	 * @return
 	 */
 	public static String getFontWeight(Font font) {
 		FontData fontData = getFirstFontData(font);
@@ -394,19 +375,13 @@ public static boolean isBold(FontData fontData) {
 
 	/**
 	 * Return CSS Value font-family from Control Font
-	 *
-	 * @param control
-	 * @return
 	 */
 	public static String getFontComposite(Control control) {
 		return getFontComposite(control.getFont());
 	}
 
 	/**
 	 * Return CSS Value font-family from SWT Font
-	 *
-	 * @param font
-	 * @return
 	 */
 	public static String getFontComposite(Font font) {
 		FontData fontData = getFirstFontData(font);
@@ -434,9 +409,6 @@ public static String getFontComposite(FontData fontData) {
 
 	/**
 	 * Return first FontData from Control Font.
-	 *
-	 * @param control
-	 * @return
 	 */
 	public static FontData getFirstFontData(Control control) {
 		Font font = control.getFont();
@@ -449,9 +421,6 @@ public static FontData getFirstFontData(Control control) {
 	/**
 	 *
 	 * Return first FontData from SWT Font.
-	 *
-	 * @param font
-	 * @return
 	 */
 	public static FontData getFirstFontData(Font font) {
 		FontData[] fontDatas = !font.isDisposed() ? font.getFontData() : null;

diff --git a/bundles/org.eclipse.e4.ui.css.swt/src/org/eclipse/e4/ui/css/swt/helpers/SWTStyleHelpers.java b/bundles/org.eclipse.e4.ui.css.swt/src/org/eclipse/e4/ui/css/swt/helpers/SWTStyleHelpers.java
@@ -28,9 +28,6 @@ public class SWTStyleHelpers {
 	/**
 	 * Return SWT style constant from {@link Widget} <code>widget</code> as
 	 * String. Each SWT style are separate with space character.
-	 *
-	 * @param style
-	 * @return
 	 */
 	public static String getSWTWidgetStyleAsString(Widget widget) {
 		if (widget.isDisposed()) {
@@ -44,7 +41,6 @@ public static String getSWTWidgetStyleAsString(Widget widget) {
 	 * are separate with <code>separator</code> String.
 	 *
 	 * @param style
-	 * @return
 	 */
 	public static String getSWTWidgetStyleAsString(int style, String separator) {
 		if (style == 0) {

diff --git a/...les/org.eclipse.e4.ui.progress/src/org/eclipse/e4/ui/progress/internal/AnimationItem.java b/...les/org.eclipse.e4.ui.progress/src/org/eclipse/e4/ui/progress/internal/AnimationItem.java
@@ -54,9 +54,6 @@ public void animationStart() {
 
 	/**
 	 * Create a new instance of the receiver.
-	 *
-	 * @param workbenchWindow
-	 *            the window being created
 	 */
 	public AnimationItem(AnimationManager animationManager) {
 		this.animationManager = animationManager;
@@ -135,11 +132,4 @@ public int getPreferredWidth() {
 	void setAnimationContainer(IAnimationContainer container) {
 		this.animationContainer = container;
 	}
-
-	/**
-	 * @return Returns the window.
-	 */
-//	public WorkbenchWindow getWindow() {
-//		return window;
-//	}
 }
diff --git a/...es/org.eclipse.e4.ui.progress/src/org/eclipse/e4/ui/progress/internal/ProgressRegion.java b/...es/org.eclipse.e4.ui.progress/src/org/eclipse/e4/ui/progress/internal/ProgressRegion.java
@@ -74,9 +74,6 @@ public ProgressRegion() {
 	 *
 	 * @param parent
 	 *            The parent widget of the composite.
-	 * @param window
-	 *            The WorkbenchWindow this is in.
-	 * @return Control
 	 */
 	@PostConstruct
 	public Control createContents(Composite parent) {

diff --git a/...e4.ui.workbench.addons.swt/src/org/eclipse/e4/ui/workbench/addons/dndaddon/DragAgent.java b/...e4.ui.workbench.addons.swt/src/org/eclipse/e4/ui/workbench/addons/dndaddon/DragAgent.java
@@ -80,9 +80,6 @@ public boolean canDrag(DnDInfo info) {
 
 	/**
 	 * Start a drag operation on the given element.
-	 *
-	 * @param element
-	 *            The element to drag
 	 */
 	public void dragStart(DnDInfo info) {
 		// cache a placeholder where the element started (NOTE: this also prevents the parent from

diff --git a/...kbench.renderers.swt/src/org/eclipse/e4/ui/workbench/renderers/swt/TrimmedPartLayout.java b/...kbench.renderers.swt/src/org/eclipse/e4/ui/workbench/renderers/swt/TrimmedPartLayout.java
@@ -92,8 +92,6 @@ public class TrimmedPartLayout extends Layout {
 	/**
 	 * This layout is used to support parts that want trim for their containing
 	 * composites.
-	 *
-	 * @param trimOwner
 	 */
 	public TrimmedPartLayout(Composite parent) {
 		clientArea = new Composite(parent, SWT.NONE);
@@ -181,11 +179,6 @@ protected void layout(Composite composite, boolean flushCache) {
 		}
 	}
 
-	/**
-	 * @param top2
-	 * @param b
-	 * @return
-	 */
 	public Composite getTrimComposite(Composite parent, int side) {
 		switch (side) {
 		case SWT.TOP:

diff --git a/...e.e4.ui.workbench.swt/src/org/eclipse/e4/ui/internal/workbench/swt/CSSRenderingUtils.java b/...e.e4.ui.workbench.swt/src/org/eclipse/e4/ui/internal/workbench/swt/CSSRenderingUtils.java
@@ -218,11 +218,6 @@ public CSSValue getCSSValue(Control styleControl, String className,
 		return styleDeclarations.getPropertyCSSValue(attributeName);
 	}
 
-	/**
-	 * @param string
-	 * @param string2
-	 * @return
-	 */
 	public Image createImage(Control styleControl, String classId,
 			String attName, Integer[] frameInts) {
 		Image image = null;

diff --git a/...e4.ui.workbench.swt/src/org/eclipse/e4/ui/workbench/swt/internal/copy/ShowViewDialog.java b/...e4.ui.workbench.swt/src/org/eclipse/e4/ui/workbench/swt/internal/copy/ShowViewDialog.java
@@ -86,11 +86,6 @@ public class ShowViewDialog extends Dialog implements
 
 	/**
 	 * Constructs a new ShowViewDialog.
-	 *
-	 * @param window
-	 *            the workbench window
-	 * @param viewReg
-	 *            the view registry
 	 */
 	public ShowViewDialog(Shell shell, MApplication application,
 			IEclipseContext context) {

diff --git a/...e4.ui.workbench.swt/src/org/eclipse/e4/ui/workbench/swt/internal/copy/ViewComparator.java b/...e4.ui.workbench.swt/src/org/eclipse/e4/ui/workbench/swt/internal/copy/ViewComparator.java
@@ -26,9 +26,6 @@ public class ViewComparator extends ViewerComparator {
 
 	/**
 	 * ViewSorter constructor comment.
-	 *
-	 * @param reg
-	 *            an IViewRegistry
 	 */
 	public ViewComparator() {
 		super();

diff --git a/...ui.workbench.swt/src/org/eclipse/e4/ui/workbench/swt/internal/copy/ViewLabelProvider.java b/...ui.workbench.swt/src/org/eclipse/e4/ui/workbench/swt/internal/copy/ViewLabelProvider.java
@@ -58,13 +58,6 @@ public class ViewLabelProvider extends ColumnLabelProvider {
 
 	private IEclipseContext context;
 
-	/**
-	 * @param window
-	 *            the workbench window
-	 * @param dimmedForeground
-	 *            the dimmed foreground color to use for views that are already
-	 *            open
-	 */
 	public ViewLabelProvider(IEclipseContext context) {
 		this.context = context;
 	}

diff --git a/bundles/org.eclipse.e4.ui.workbench3/src/org/eclipse/ui/testing/dumps/TimeoutDumpTimer.java b/bundles/org.eclipse.e4.ui.workbench3/src/org/eclipse/ui/testing/dumps/TimeoutDumpTimer.java
@@ -91,7 +91,6 @@ private TimeoutDumpTimer(String timeoutArg, File outputDirectory) {
 	 *
 	 * @param timeoutArg      the value of the -timeout argument from the command
 	 *                        line
-	 * @param outputDirectory where screenshots end up
 	 */
 	public static void startTimeoutDumpTimer(String timeoutArg) {
 		startTimeoutDumpTimer(timeoutArg, null);

diff --git a/...org.eclipse.ui.browser/src/org/eclipse/ui/internal/browser/WebBrowserViewDropAdapter.java b/...org.eclipse.ui.browser/src/org/eclipse/ui/internal/browser/WebBrowserViewDropAdapter.java
@@ -152,8 +152,6 @@ protected boolean performDrop(Object data) {
 	 * Subclasses must implement this method to define which drops make sense.
 	 * </p>
 	 *
-	 * @param target the object that the mouse is currently hovering over, or
-	 *   <code>null</code> if the mouse is hovering over empty space
 	 * @param operation the current drag operation (copy, move, etc.)
 	 * @param transferType the current transfer type
 	 * @return <code>true</code> if the drop is valid, and <code>false</code>