Bug 275738 - Lots of javadoc warnings in PDE (o.e.pde.ui)

removes javadoc method comments which: 
- are completely empty or 
- which are effectively empty (contains only @parameter/@return without
description 

removes also @parameter comments for parameters which are not anymore
existing (is code warning) 

done for files where were some javadoc code warning

Change-Id: I3f6952cdb4f637c3ebb6c89a2512ddfd88836d4c
Signed-off-by: Martin Karpisek <martin.karpisek@gmail.com>

20 files changed, 5 insertions, 82 deletions

diff --git a/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/editor/PDEFormEditor.java b/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/editor/PDEFormEditor.java
index d05e17bbca..ec77d03526 100644
--- a/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/editor/PDEFormEditor.java
+++ b/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/editor/PDEFormEditor.java
@@ -97,8 +97,6 @@ public abstract class PDEFormEditor extends FormEditor implements IInputContextL
 		/**
 		 * Removes this selection changed listener from the given selection
 		 * provider.
-		 *
-		 * @param selectionProviderstyle
 		 */
 		public void uninstall(ISelectionProvider selectionProvider) {
 			if (selectionProvider == null) {
diff --git a/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/editor/PDESourcePage.java b/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/editor/PDESourcePage.java
index b772537f5f..562e2a338c 100644
--- a/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/editor/PDESourcePage.java
+++ b/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/editor/PDESourcePage.java
@@ -95,8 +95,6 @@ public abstract class PDESourcePage extends TextEditor implements IFormPage, IGo
 		/**
 		 * Removes this selection changed listener from the given selection
 		 * provider.
-		 *
-		 * @param selectionProviderstyle
 		 */
 		public void uninstall(ISelectionProvider selectionProvider) {
 			if (selectionProvider != null) {
@@ -565,7 +563,6 @@ public abstract class PDESourcePage extends TextEditor implements IFormPage, IGo
 	/**
 	 * Triggered by toggling the 'Link with Editor' button in the outline
 	 * view
-	 * @param offset
 	 */
 	public void synchronizeOutlinePage() {
 		// Get the current position of the cursor in this page
diff --git a/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/editor/actions/OpenSchemaAction.java b/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/editor/actions/OpenSchemaAction.java
index e3475b2a2b..4478f43425 100644
--- a/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/editor/actions/OpenSchemaAction.java
+++ b/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/editor/actions/OpenSchemaAction.java
@@ -48,9 +48,6 @@ public class OpenSchemaAction extends Action {
 		initialize();
 	}
 
-	/**
-	 *
-	 */
 	private void initialize() {
 		setImageDescriptor(PDEPluginImages.DESC_SCHEMA_OBJ);
 		setText(PDEUIMessages.HyperlinkActionOpenSchema);
@@ -58,9 +55,6 @@ public class OpenSchemaAction extends Action {
 		setEnabled(false);
 	}
 
-	/**
-	 * @param schema
-	 */
 	public void setInput(ISchema schema) {
 		// Ensure schema is defined
 		if (schema == null) {
@@ -71,9 +65,6 @@ public class OpenSchemaAction extends Action {
 		fSchema = schema;
 	}
 
-	/**
-	 * @param point
-	 */
 	public void setInput(IPluginExtensionPoint point) {
 		// Ensure the point is defined
 		if (point == null) {
@@ -91,9 +82,6 @@ public class OpenSchemaAction extends Action {
 		fSchema = findSchema(point);
 	}
 
-	/**
-	 * @param fullPointID
-	 */
 	public void setInput(String fullPointID) {
 		// Ensure point ID is defined
 		if (fullPointID == null) {
@@ -113,9 +101,6 @@ public class OpenSchemaAction extends Action {
 		fSchema = findSchema(point);
 	}
 
-	/**
-	 * @param extension
-	 */
 	public void setInput(IPluginExtension extension) {
 		// Ensure the extension is defined
 		if (extension == null) {
@@ -154,9 +139,6 @@ public class OpenSchemaAction extends Action {
 		return schema;
 	}
 
-	/**
-	 * @param fullPointID
-	 */
 	private void displayErrorDialog() {
 		String title = PDEUIMessages.OpenSchemaAction_titleExtensionPointSchema;
 		String message = NLS.bind(PDEUIMessages.OpenSchemaAction_errorMsgSchemaNotFound, fFullPointID);
@@ -186,9 +168,6 @@ public class OpenSchemaAction extends Action {
 		}
 	}
 
-	/**
-	 * @param path
-	 */
 	private void openSchemaFile(URL url) {
 		try {
 			// Convert url to an encoded URI, then try to get a local file out of it
@@ -221,9 +200,6 @@ public class OpenSchemaAction extends Action {
 		}
 	}
 
-	/**
-	 * @param path
-	 */
 	private void openSchemaJar(URL url) {
 		try {
 			// The url is unencoded, so we can treat it like a path, splitting it based on the jar suffix '!'
diff --git a/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/editor/feature/LicenseFeatureSection.java b/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/editor/feature/LicenseFeatureSection.java
index 376dd2e82e..e43edc3175 100644
--- a/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/editor/feature/LicenseFeatureSection.java
+++ b/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/editor/feature/LicenseFeatureSection.java
@@ -70,7 +70,6 @@ public class LicenseFeatureSection extends PDESection {
 	/**
 	 * Creates the UI in the given section using the provided toolkit
 	 * @param toolkit
-	 * @param parent
 	 */
 	@Override
 	public void createClient(Section section, FormToolkit toolkit) {
diff --git a/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/editor/plugin/ManifestHyperlinkDetector.java b/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/editor/plugin/ManifestHyperlinkDetector.java
index 3b2fb6645b..0337c40e48 100644
--- a/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/editor/plugin/ManifestHyperlinkDetector.java
+++ b/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/editor/plugin/ManifestHyperlinkDetector.java
@@ -25,9 +25,6 @@ import org.eclipse.pde.internal.ui.editor.text.*;
 
 public class ManifestHyperlinkDetector extends PDEHyperlinkDetector {
 
-	/**
-	 * @param editor the editor in which to detect the hyperlink
-	 */
 	public ManifestHyperlinkDetector(PDESourcePage page) {
 		super(page);
 	}
diff --git a/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/editor/product/LicensingPage.java b/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/editor/product/LicensingPage.java
index fa94eeb8be..1d3e508953 100644
--- a/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/editor/product/LicensingPage.java
+++ b/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/editor/product/LicensingPage.java
@@ -23,10 +23,6 @@ public class LicensingPage extends PDEFormPage {
 
 	public static final String PAGE_ID = "licensing"; //$NON-NLS-1$
 
-	/**
-	 * @param productEditor
-	 * @param useFeatures
-	 */
 	public LicensingPage(ProductEditor editor) {
 		super(editor, PAGE_ID, PDEUIMessages.LicensingPage_title);
 	}
diff --git a/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/editor/product/ProductInfoSection.java b/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/editor/product/ProductInfoSection.java
index e51fd4c68a..d66ea34685 100644
--- a/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/editor/product/ProductInfoSection.java
+++ b/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/editor/product/ProductInfoSection.java
@@ -376,9 +376,6 @@ public class ProductInfoSection extends PDESection implements IRegistryChangeLis
 		((ProductEditor) getPage().getEditor()).updateConfigurationPage();
 	}
 
-	/**
-	 * @param productId
-	 */
 	private void refreshProductCombo(String productID) {
 		if (productID == null) {
 			productID = ""; //$NON-NLS-1$
diff --git a/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/editor/site/MirrorsSection.java b/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/editor/site/MirrorsSection.java
index c54304150e..3daf19dda9 100644
--- a/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/editor/site/MirrorsSection.java
+++ b/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/editor/site/MirrorsSection.java
@@ -23,9 +23,6 @@ import org.eclipse.swt.layout.GridData;
 import org.eclipse.swt.widgets.Composite;
 import org.eclipse.ui.forms.widgets.*;
 
-/**
- *
- */
 public class MirrorsSection extends PDESection {
 	private FormEntry fMirrorsURLEntry;
 
@@ -124,9 +121,6 @@ public class MirrorsSection extends PDESection {
 		super.cancelEdit();
 	}
 
-	/**
-	 * @see org.eclipse.update.ui.forms.internal.FormSection#canPaste(Clipboard)
-	 */
 	@Override
 	public boolean canPaste(Clipboard clipboard) {
 		TransferData[] types = clipboard.getAvailableTypes();
diff --git a/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/parts/PDESourceViewer.java b/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/parts/PDESourceViewer.java
index bb1c0732fd..017d3dcc07 100644
--- a/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/parts/PDESourceViewer.java
+++ b/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/parts/PDESourceViewer.java
@@ -160,7 +160,6 @@ public class PDESourceViewer {
 	 * The menu set on the underlying styled text widget of the source viewer
 	 * needs to be set to null before being diposed; otherwise, the menu will
 	 * be disposed along with the widget.
-	 * @param viewer
 	 */
 	public void unsetMenu() {
 		if (fViewer == null) {
@@ -177,9 +176,6 @@ public class PDESourceViewer {
 
 	/**
 	 * Utility method used to tie global actions into source viewers.
-	 *
-	 * @param actionId
-	 * @param viewer
 	 */
 	public boolean doGlobalAction(String actionId) {
 		// Ensure the viewer was created
diff --git a/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/preferences/PDECompilersConfigurationBlock.java b/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/preferences/PDECompilersConfigurationBlock.java
index fc743511dd..90823d5a94 100644
--- a/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/preferences/PDECompilersConfigurationBlock.java
+++ b/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/preferences/PDECompilersConfigurationBlock.java
@@ -329,11 +329,6 @@ public class PDECompilersConfigurationBlock extends ConfigurationBlock {
 		}
 	};
 
-	/**
-	 * Constructor
-	 * @param project
-	 * @param container
-	 */
 	public PDECompilersConfigurationBlock(IProject project, IWorkbenchPreferenceContainer container) {
 		fProject = project;
 		if (fProject != null) {
@@ -361,7 +356,6 @@ public class PDECompilersConfigurationBlock extends ConfigurationBlock {
 
 	/**
 	 * returns if this block has fProject specific settings
-	 * @param fProject
 	 * @return true if there are fProject specific settings, false otherwise
 	 */
 	public boolean hasProjectSpecificSettings(IProject project) {
diff --git a/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/shared/target/PreviewContainerPage.java b/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/shared/target/PreviewContainerPage.java
index bc6b274d64..15d59dd4f3 100644
--- a/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/shared/target/PreviewContainerPage.java
+++ b/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/shared/target/PreviewContainerPage.java
@@ -57,7 +57,6 @@ public class PreviewContainerPage extends WizardPage {
 
 	/**
 	 * Refreshes the contents of the preview table, possible resolving the container
-	 * @param resolve whether the current container should be resolved if it hasn't been already
 	 */
 	protected void setInput(final ITargetLocation container) {
 		if (container == null) {
diff --git a/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/util/PDEModelUtility.java b/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/util/PDEModelUtility.java
index dca95bb7c0..04bfb3b27b 100644
--- a/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/util/PDEModelUtility.java
+++ b/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/util/PDEModelUtility.java
@@ -261,7 +261,6 @@ public class PDEModelUtility {
 	 * (not a BundleModel - which can be retreived from the BundlePluginModel)
 	 * @param modification
 	 * @param monitor
-	 * @throws CoreException
 	 */
 	public static void modifyModel(final ModelModification modification, final IProgressMonitor monitor) {
 		// ModelModification was not supplied with the right files
diff --git a/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/wizards/RequiredPluginsContainerPage.java b/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/wizards/RequiredPluginsContainerPage.java
index a62d0a7f4b..d282a4de34 100644
--- a/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/wizards/RequiredPluginsContainerPage.java
+++ b/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/wizards/RequiredPluginsContainerPage.java
@@ -142,7 +142,6 @@ public class RequiredPluginsContainerPage extends WizardPage implements IClasspa
 
 	/**
 	 * Insert the method's description here.
-	 * @see WizardPage#finish
 	 */
 	@Override
 	public boolean finish() {
@@ -151,7 +150,6 @@ public class RequiredPluginsContainerPage extends WizardPage implements IClasspa
 
 	/**
 	 * Insert the method's description here.
-	 * @see WizardPage#getSelection
 	 */
 	@Override
 	public IClasspathEntry getSelection() {
@@ -165,7 +163,6 @@ public class RequiredPluginsContainerPage extends WizardPage implements IClasspa
 
 	/**
 	 * Insert the method's description here.
-	 * @see WizardPage#setSelection
 	 */
 	@Override
 	public void setSelection(IClasspathEntry containerEntry) {
diff --git a/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/wizards/feature/OpenProjectWizardAction.java b/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/wizards/feature/OpenProjectWizardAction.java
index eb264d0a28..7002e4298f 100644
--- a/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/wizards/feature/OpenProjectWizardAction.java
+++ b/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/wizards/feature/OpenProjectWizardAction.java
@@ -25,9 +25,6 @@ import org.eclipse.ui.cheatsheets.ICheatSheetAction;
 import org.eclipse.ui.cheatsheets.ICheatSheetManager;
 
 public class OpenProjectWizardAction extends Action implements ICheatSheetAction {
-	/**
-	 * @param text
-	 */
 	public OpenProjectWizardAction() {
 		super(PDEUIMessages.Actions_Feature_OpenProjectWizardAction);
 	}
diff --git a/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/wizards/imports/PluginImportOperation.java b/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/wizards/imports/PluginImportOperation.java
index a032378269..f41d5260c8 100644
--- a/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/wizards/imports/PluginImportOperation.java
+++ b/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/wizards/imports/PluginImportOperation.java
@@ -96,8 +96,6 @@ public class PluginImportOperation extends WorkspaceJob {
 	 * Constructor
 	 * @param models models of plug-ins to import
 	 * @param importType one of three types specified by constants, binary, binary with links, source
-	 * @param replaceQuery defines what to do if the project already exists in the workspace
-	 * @param executionQuery defines what to do if the project requires an unsupported execution environment
 	 * @param forceAutobuild whether to force a build after the import
 	 */
 	public PluginImportOperation(IPluginModelBase[] models, int importType, boolean forceAutobuild) {
@@ -443,7 +441,6 @@ public class PluginImportOperation extends WorkspaceJob {
 	 * environment is supported and also checks if the project already exists and
 	 * needs to be replaced.
 	 * @param model model representing the plugin to import
-	 * @param instructions instructions for how to import from repository
 	 * @param monitor progress monitor
 	 * @throws CoreException if a problem occurs while importing a plugin
 	 */
@@ -1333,7 +1330,9 @@ public class PluginImportOperation extends WorkspaceJob {
 	/**
 	 * Sets the import descriptions to use when importing from a repository.
 	 *
-	 * @param descriptions map of {@link IBundleImporter} to arrays of {@link BundleImportDescription}.
+	 * @param descriptions
+	 *            map of {@link IBundleImporter} to arrays of
+	 *            {@link ScmUrlImportDescription}.
 	 */
 	public void setImportDescriptions(Map<IBundleImporter, ScmUrlImportDescription[]> descriptions) {
 		fImportDescriptions = descriptions;
diff --git a/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/wizards/plugin/NewProjectCreationOperation.java b/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/wizards/plugin/NewProjectCreationOperation.java
index 7f8dc5ab31..6012d4cfe0 100644
--- a/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/wizards/plugin/NewProjectCreationOperation.java
+++ b/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/wizards/plugin/NewProjectCreationOperation.java
@@ -545,7 +545,6 @@ public class NewProjectCreationOperation extends WorkspaceModifyOperation {
 
 	/**
 	 * Add the API analysis nature to the project
-	 * @param add
 	 */
 	private void addApiAnalysisNature() {
 		try {
diff --git a/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/wizards/plugin/OpenProjectWizardAction.java b/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/wizards/plugin/OpenProjectWizardAction.java
index 2af70fa210..4ab430f595 100644
--- a/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/wizards/plugin/OpenProjectWizardAction.java
+++ b/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/wizards/plugin/OpenProjectWizardAction.java
@@ -24,9 +24,6 @@ import org.eclipse.ui.cheatsheets.ICheatSheetAction;
 import org.eclipse.ui.cheatsheets.ICheatSheetManager;
 
 public class OpenProjectWizardAction extends Action implements ICheatSheetAction {
-	/**
-	 * @param text
-	 */
 	public OpenProjectWizardAction() {
 		super("OpenProject"); //$NON-NLS-1$
 	}
diff --git a/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/wizards/site/OpenProjectWizardAction.java b/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/wizards/site/OpenProjectWizardAction.java
index b1a5e391fc..2c92d5663b 100644
--- a/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/wizards/site/OpenProjectWizardAction.java
+++ b/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/wizards/site/OpenProjectWizardAction.java
@@ -25,9 +25,6 @@ import org.eclipse.ui.cheatsheets.ICheatSheetAction;
 import org.eclipse.ui.cheatsheets.ICheatSheetManager;
 
 public class OpenProjectWizardAction extends Action implements ICheatSheetAction {
-	/**
-	 * @param text
-	 */
 	public OpenProjectWizardAction() {
 		super(PDEUIMessages.Actions_Site_OpenProjectWizardAction);
 	}
diff --git a/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/wizards/target/MoveTargetDefinitionPage.java b/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/wizards/target/MoveTargetDefinitionPage.java
index b706efd49c..554187e85b 100644
--- a/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/wizards/target/MoveTargetDefinitionPage.java
+++ b/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/wizards/target/MoveTargetDefinitionPage.java
@@ -46,7 +46,8 @@ public class MoveTargetDefinitionPage extends PDEWizardNewFileCreationPage {
 	/**
 	 * The list of filenames that are not allowed
 	 *
-	 * @param fFilterList <code>Collection</code> of filenames as <code>IPath</code>
+	 * @param filterFileList
+	 *            <code>Collection</code> of filenames as <code>IPath</code>
 	 */
 	protected void setFilter(Collection<?> filterFileList) {
 		fFilterList = filterFileList;
diff --git a/ui/org.eclipse.pde.ui/src_samples/org/eclipse/pde/internal/ui/samples/ProjectNamesPage.java b/ui/org.eclipse.pde.ui/src_samples/org/eclipse/pde/internal/ui/samples/ProjectNamesPage.java
index 313eabc1dd..c7c439a9e1 100644
--- a/ui/org.eclipse.pde.ui/src_samples/org/eclipse/pde/internal/ui/samples/ProjectNamesPage.java
+++ b/ui/org.eclipse.pde.ui/src_samples/org/eclipse/pde/internal/ui/samples/ProjectNamesPage.java
@@ -26,16 +26,10 @@ import org.eclipse.swt.layout.GridLayout;
 import org.eclipse.swt.widgets.*;
 import org.eclipse.ui.PlatformUI;
 
-/**
- *
- */
 public class ProjectNamesPage extends WizardPage {
 	private SampleWizard wizard;
 	private Composite container;
 
-	/**
-	 * @param pageName
-	 */
 	public ProjectNamesPage(SampleWizard wizard) {
 		super("projects"); //$NON-NLS-1$
 		this.wizard = wizard;