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: Idac0f5b36253f85b03088f91d4b5c44d34c73d7e
Signed-off-by: Martin Karpisek <martin.karpisek@gmail.com>

16 files changed, 7 insertions, 82 deletions

diff --git a/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/correction/java/JavaResolutionFactory.java b/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/correction/java/JavaResolutionFactory.java
index 4522312849..2ab1a53a64 100644
--- a/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/correction/java/JavaResolutionFactory.java
+++ b/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/correction/java/JavaResolutionFactory.java
@@ -312,7 +312,8 @@ public class JavaResolutionFactory {
 	 * @param desc an ExportPackageDescription from the bundle that is to be added as a Require-Bundle dependency
 	 * @param type the type of the proposal to be returned
 	 * @param relevance the relevance of the new proposal
-	 * @see TYPE_JAVA_COMPLETION , TYPE_CLASSPATH_FIX
+	 * @see JavaResolutionFactory#TYPE_JAVA_COMPLETION
+	 * @see JavaResolutionFactory#TYPE_CLASSPATH_FIX
 	 */
 	public static final Object createRequireBundleProposal(IProject project, ExportPackageDescription desc, int type, int relevance) {
 		if (desc.getSupplier() == null)
@@ -328,7 +329,8 @@ public class JavaResolutionFactory {
 	 * @param desc an ExportPackageDescription which represents the package to be added
 	 * @param type the type of the proposal to be returned
 	 * @param relevance the relevance of the new proposal
-	 * @see TYPE_JAVA_COMPLETION , TYPE_CLASSPATH_FIX
+	 * @see JavaResolutionFactory#TYPE_JAVA_COMPLETION
+	 * @see JavaResolutionFactory#TYPE_CLASSPATH_FIX
 	 */
 	public static final Object createImportPackageProposal(IProject project, ExportPackageDescription desc, int type, int relevance) {
 		AbstractManifestChange change = new ImportPackageManifestChange(project, desc);
@@ -346,7 +348,8 @@ public class JavaResolutionFactory {
 	 * @param pkg an IPackageFragment which represents the package to be added
 	 * @param type the type of the proposal to be returned
 	 * @param relevance the relevance of the new proposal
-	 * @see TYPE_JAVA_COMPLETION , TYPE_CLASSPATH_FIX
+	 * @see JavaResolutionFactory#TYPE_JAVA_COMPLETION
+	 * @see JavaResolutionFactory#TYPE_CLASSPATH_FIX
 	 */
 	public static final Object createExportPackageProposal(IProject project, IPackageFragment pkg, int type, int relevance) {
 		AbstractManifestChange change = new ExportPackageChange(project, pkg);
diff --git a/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/dialogs/FeatureSelectionDialog.java b/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/dialogs/FeatureSelectionDialog.java
index 7fa3a3366d..ed8c841454 100755
--- a/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/dialogs/FeatureSelectionDialog.java
+++ b/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/dialogs/FeatureSelectionDialog.java
@@ -135,10 +135,6 @@ public class FeatureSelectionDialog extends FilteredItemsSelectionDialog {
 
 	}
 
-	/**
-	 * @param parent
-	 * @param renderer
-	 */
 	public FeatureSelectionDialog(Shell parent, IFeatureModel[] models, boolean multiSelect) {
 		super(parent, multiSelect);
 		setTitle(PDEUIMessages.FeatureSelectionDialog_title);
diff --git a/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/editor/build/BuildHyperlinkDetector.java b/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/editor/build/BuildHyperlinkDetector.java
index 4c3ed1ba9b..656f628876 100644
--- a/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/editor/build/BuildHyperlinkDetector.java
+++ b/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/editor/build/BuildHyperlinkDetector.java
@@ -25,9 +25,6 @@ public class BuildHyperlinkDetector implements IHyperlinkDetector {
 
 	private PDESourcePage fSourcePage;
 
-	/**
-	 * @param editor the editor in which to detect the hyperlink
-	 */
 	public BuildHyperlinkDetector(PDESourcePage page) {
 		fSourcePage = page;
 	}
diff --git a/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/editor/category/CategorySection.java b/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/editor/category/CategorySection.java
index 8f5493f907..992a4e5f33 100644
--- a/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/editor/category/CategorySection.java
+++ b/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/editor/category/CategorySection.java
@@ -945,7 +945,6 @@ public class CategorySection extends TreeSection implements IFeatureModelListene
 	 *
 	 * @param candidates
 	 *            Array of IFeatureModel
-	 * @param monitor
 	 * @throws CoreException
 	 */
 	public void doAdd(Object[] candidates) throws CoreException {
@@ -989,7 +988,6 @@ public class CategorySection extends TreeSection implements IFeatureModelListene
 	 *
 	 * @param candidates
 	 *            Array of IPluginModelBase
-	 * @param monitor
 	 * @throws CoreException
 	 */
 	public void doAddBundles(Object[] candidates) throws CoreException {
diff --git a/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/editor/category/DownloadStatsSection.java b/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/editor/category/DownloadStatsSection.java
index f7318fb5a0..57b6dfea47 100644
--- a/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/editor/category/DownloadStatsSection.java
+++ b/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/editor/category/DownloadStatsSection.java
@@ -369,7 +369,6 @@ public class DownloadStatsSection extends TableSection {
 	 *
 	 * @param candidates
 	 *            Array of IFeatureModel
-	 * @param monitor
 	 * @throws CoreException
 	 */
 	public void doAddFeatures(Object[] candidates) throws CoreException {
@@ -392,7 +391,6 @@ public class DownloadStatsSection extends TableSection {
 	 *
 	 * @param candidates
 	 *            Array of IPluginModelBase
-	 * @param monitor
 	 * @throws CoreException
 	 */
 	public void doAddBundles(Object[] candidates) throws CoreException {
diff --git a/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/editor/context/InputContext.java b/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/editor/context/InputContext.java
index 6bc945a859..a13e9eca3c 100644
--- a/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/editor/context/InputContext.java
+++ b/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/editor/context/InputContext.java
@@ -425,19 +425,12 @@ public abstract class InputContext {
 		return System.getProperty("line.separator"); //$NON-NLS-1$
 	}
 
-	/**
-	 * @param input
-	 * @throws CoreException
-	 */
 	private void updateInput(IEditorInput newInput) throws CoreException {
 		deinitializeDocumentProvider();
 		fEditorInput = newInput;
 		initializeDocumentProvider();
 	}
 
-	/**
-	 *
-	 */
 	private void deinitializeDocumentProvider() {
 		IAnnotationModel amodel = fDocumentProvider.getAnnotationModel(fEditorInput);
 		if (amodel != null) {
@@ -447,9 +440,6 @@ public abstract class InputContext {
 		fDocumentProvider.disconnect(fEditorInput);
 	}
 
-	/**
-	 * @throws CoreException
-	 */
 	private void initializeDocumentProvider() throws CoreException {
 		fDocumentProvider.connect(fEditorInput);
 		IAnnotationModel amodel = fDocumentProvider.getAnnotationModel(fEditorInput);
@@ -459,9 +449,6 @@ public abstract class InputContext {
 		fDocumentProvider.addElementStateListener(fElementListener);
 	}
 
-	/**
-	 * @param monitor
-	 */
 	public void doSaveAs(IProgressMonitor monitor) throws Exception {
 		// Get the editor shell
 		Shell shell = getEditor().getSite().getShell();
@@ -489,14 +476,6 @@ public abstract class InputContext {
 		}
 	}
 
-	/**
-	 * @param monitor
-	 * @param path
-	 * @throws Exception
-	 * @throws CoreException
-	 * @throws InterruptedException
-	 * @throws InvocationTargetException
-	 */
 	private void handleSaveAs(IProgressMonitor monitor, IPath path) throws Exception, CoreException, InterruptedException, InvocationTargetException {
 		// Ensure a new location was selected
 		if (path == null) {
diff --git a/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/editor/feature/FeatureSpecSection.java b/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/editor/feature/FeatureSpecSection.java
index 6f349a0525..35baa55f32 100644
--- a/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/editor/feature/FeatureSpecSection.java
+++ b/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/editor/feature/FeatureSpecSection.java
@@ -548,9 +548,6 @@ public class FeatureSpecSection 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/editor/plugin/BundleHyperlinkDetector.java b/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/editor/plugin/BundleHyperlinkDetector.java
index 2c210019d9..df278d6291 100644
--- a/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/editor/plugin/BundleHyperlinkDetector.java
+++ b/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/editor/plugin/BundleHyperlinkDetector.java
@@ -24,9 +24,6 @@ public class BundleHyperlinkDetector implements IHyperlinkDetector {
 
 	private PDESourcePage fSourcePage;
 
-	/**
-	 * @param editor the editor in which to detect the hyperlink
-	 */
 	public BundleHyperlinkDetector(PDESourcePage page) {
 		fSourcePage = page;
 	}
diff --git a/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/editor/plugin/ExtensionDetails.java b/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/editor/plugin/ExtensionDetails.java
index 6bbff029c9..ce26df7664 100644
--- a/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/editor/plugin/ExtensionDetails.java
+++ b/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/editor/plugin/ExtensionDetails.java
@@ -45,9 +45,6 @@ public class ExtensionDetails extends AbstractPluginElementDetails {
 
 	private static final String RTEXT_DATA = PDEUIMessages.ExtensionDetails_extensionPointLinks;
 
-	/**
-	 * @param masterSection
-	 */
 	public ExtensionDetails(PDESection masterSection) {
 		super(masterSection);
 	}
@@ -121,10 +118,6 @@ public class ExtensionDetails extends AbstractPluginElementDetails {
 		markDetailsPart(section);
 	}
 
-	/**
-	 * @param toolkit
-	 * @param client
-	 */
 	private void createNameEntryField(FormToolkit toolkit, Composite client) {
 		name = new FormEntry(client, toolkit, PDEUIMessages.ExtensionDetails_name, null, false);
 		name.setFormEntryListener(new FormEntryAdapter(this) {
@@ -140,10 +133,6 @@ public class ExtensionDetails extends AbstractPluginElementDetails {
 		});
 	}
 
-	/**
-	 * @param toolkit
-	 * @param client
-	 */
 	private void createIDEntryField(FormToolkit toolkit, Composite client) {
 		id = new FormEntry(client, toolkit, PDEUIMessages.ExtensionDetails_id, null, false);
 		id.setFormEntryListener(new FormEntryAdapter(this) {
@@ -181,8 +170,6 @@ public class ExtensionDetails extends AbstractPluginElementDetails {
 
 	/**
 	 * Denote a field as required by updating their label
-	 * @param attributeName
-	 * @param field
 	 */
 	private boolean isFieldRequired(String attributeName) {
 		// Ensure we have input
@@ -215,10 +202,6 @@ public class ExtensionDetails extends AbstractPluginElementDetails {
 		return false;
 	}
 
-	/**
-	 * @param field
-	 * @param required
-	 */
 	private void updateLabel(boolean required, FormEntry field, String label) {
 		// Get the label
 		Control control = field.getLabel();
diff --git a/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/editor/plugin/ExtensionsPage.java b/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/editor/plugin/ExtensionsPage.java
index b937e453cb..b6b9837cb2 100644
--- a/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/editor/plugin/ExtensionsPage.java
+++ b/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/editor/plugin/ExtensionsPage.java
@@ -106,11 +106,6 @@ public class ExtensionsPage extends PDEFormPage {
 		}
 	}
 
-	/**
-	 * @param editor
-	 * @param id
-	 * @param title
-	 */
 	public ExtensionsPage(FormEditor editor) {
 		super(editor, PAGE_ID, PDEUIMessages.ExtensionsPage_tabName);
 		fBlock = new ExtensionsBlock();
diff --git a/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/editor/product/ConfigurationPage.java b/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/editor/product/ConfigurationPage.java
index d2e4b1f4e6..5fd6d65013 100644
--- a/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/editor/product/ConfigurationPage.java
+++ b/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/editor/product/ConfigurationPage.java
@@ -33,10 +33,6 @@ import org.eclipse.ui.forms.widgets.ScrolledForm;
 public class ConfigurationPage extends PDEFormPage {
 	public static final String PLUGIN_ID = "plugin-configuration"; //$NON-NLS-1$
 
-	/**
-	 * @param productEditor
-	 * @param useFeatures
-	 */
 	public ConfigurationPage(ProductEditor editor, boolean useFeatures) {
 		super(editor, PLUGIN_ID, PDEUIMessages.ConfigurationPageMock_pageTitle);
 	}
diff --git a/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/editor/site/CategorySection.java b/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/editor/site/CategorySection.java
index b74966c0dc..74861c814e 100644
--- a/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/editor/site/CategorySection.java
+++ b/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/editor/site/CategorySection.java
@@ -717,7 +717,6 @@ public class CategorySection extends TreeSection implements IFeatureModelListene
 	 *
 	 * @param candidates
 	 *            Array of IFeatureModel
-	 * @param monitor
 	 * @throws CoreException
 	 */
 	public void doAdd(Object[] candidates) throws CoreException {
diff --git a/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/parts/FormEntry.java b/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/parts/FormEntry.java
index 39b94150d2..4e5efe80b3 100644
--- a/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/parts/FormEntry.java
+++ b/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/parts/FormEntry.java
@@ -69,13 +69,6 @@ public class FormEntry {
 
 	/**
 	 * Create all the controls in the provided parent.
-	 *
-	 * @param parent
-	 * @param toolkit
-	 * @param labelText
-	 * @param span
-	 * @param browseText
-	 * @param linkLabel
 	 */
 	private void createControl(Composite parent, FormToolkit toolkit, String labelText, int style, String browseText, boolean linkLabel, int indent, int tcolspan) {
 		if (linkLabel) {
diff --git a/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/shared/target/AddFeatureContainersPage.java b/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/shared/target/AddFeatureContainersPage.java
index 9899d65176..4d8a027844 100644
--- a/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/shared/target/AddFeatureContainersPage.java
+++ b/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/shared/target/AddFeatureContainersPage.java
@@ -201,7 +201,7 @@ public class AddFeatureContainersPage extends EditDirectoryContainerPage {
 	}
 
 	/**
-	 * This wizard will be returning multiple containers, not just one so we can't just use {@link #getTargetLocation()}
+	 * This wizard will be returning multiple containers, not just one.
 	 * @return array of containers created by this wizard
 	 * @throws CoreException if there was a problem acquiring the target service
 	 */
diff --git a/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/shared/target/EditIUContainerPage.java b/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/shared/target/EditIUContainerPage.java
index b2cdb40086..54fa1adf83 100644
--- a/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/shared/target/EditIUContainerPage.java
+++ b/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/shared/target/EditIUContainerPage.java
@@ -122,7 +122,6 @@ public class EditIUContainerPage extends WizardPage implements IEditBundleContai
 	/**
 	 * Constructor for editing an existing container
 	 * @param container the container to edit
-	 * @param profile profile from the parent target, used to setup the p2 UI
 	 */
 	protected EditIUContainerPage(IUBundleContainer container, ITargetDefinition definition) {
 		this(definition);
diff --git a/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/wizards/extension/ExtensionEditorSelectionPage.java b/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/wizards/extension/ExtensionEditorSelectionPage.java
index 738e43aab6..ac1e477c36 100644
--- a/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/wizards/extension/ExtensionEditorSelectionPage.java
+++ b/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/wizards/extension/ExtensionEditorSelectionPage.java
@@ -29,11 +29,6 @@ public class ExtensionEditorSelectionPage extends WizardListSelectionPage {
 	private IPluginBase fPluginBase;
 	private IStructuredSelection fSelection;
 
-	/**
-	 * @param categories
-	 * @param baseCategory
-	 * @param message
-	 */
 	public ExtensionEditorSelectionPage(ElementList wizards) {
 		super(wizards, PDEUIMessages.ExtensionEditorSelectionPage_message);
 		setTitle(PDEUIMessages.ExtensionEditorSelectionPage_title);