diff options
author | Signed-off-by: Martin Karpisek | 2016-11-25 20:43:28 +0000 |
---|---|---|
committer | Lars Vogel | 2016-11-28 09:48:29 +0000 |
commit | 706ca2b1fd145f596ee3e0fc5025bf99a6f92bf3 (patch) | |
tree | f0c103a3f700820763594610e1bc0bf9117ead60 | |
parent | 139a090fbf9a13c421011b8da0dc55f7026db85e (diff) | |
download | eclipse.pde.ui-706ca2b1fd145f596ee3e0fc5025bf99a6f92bf3.tar.gz eclipse.pde.ui-706ca2b1fd145f596ee3e0fc5025bf99a6f92bf3.tar.xz eclipse.pde.ui-706ca2b1fd145f596ee3e0fc5025bf99a6f92bf3.zip |
Bug 275738 - Lots of javadoc warnings in PDE (o.e.pde.ua.ui)
Split Martins work to allow me to review parts of it in a reasonable
session
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: I848e5a2783808dc127e2e0d40504b14d1df634ea
Signed-off-by: Martin Karpisek <martin.karpisek@gmail.com>
19 files changed, 3 insertions, 413 deletions
diff --git a/ua/org.eclipse.pde.ua.ui/src/org/eclipse/pde/internal/ua/ui/editor/cheatsheet/CSAbstractDetails.java b/ua/org.eclipse.pde.ua.ui/src/org/eclipse/pde/internal/ua/ui/editor/cheatsheet/CSAbstractDetails.java index c52b169aa4..6f69bb7bad 100755 --- a/ua/org.eclipse.pde.ua.ui/src/org/eclipse/pde/internal/ua/ui/editor/cheatsheet/CSAbstractDetails.java +++ b/ua/org.eclipse.pde.ua.ui/src/org/eclipse/pde/internal/ua/ui/editor/cheatsheet/CSAbstractDetails.java @@ -47,26 +47,14 @@ public abstract class CSAbstractDetails extends PDEDetails implements ICSDetails hookListeners(); } - /** - * @param parent - */ private void configureParentLayout(Composite parent) { parent.setLayout(FormLayoutFactory.createDetailsGridLayout(false, 1)); } - /** - * @param parent - */ public abstract void createDetails(Composite parent); - /** - * - */ public abstract void updateFields(); - /** - * - */ public abstract void hookListeners(); /* (non-Javadoc) @@ -113,31 +101,18 @@ public abstract class CSAbstractDetails extends PDEDetails implements ICSDetails // NO-OP } - /** - * @return - */ public boolean isEditableElement() { return fMasterSection.isEditable(); } - /** - * @return - */ public FormToolkit getToolkit() { return getManagedForm().getToolkit(); } - /** - * @return - */ public ICSMaster getMasterSection() { return fMasterSection; } - /** - * @param selection - * @return - */ protected Object getFirstSelectedObject(ISelection selection) { // Get the structured selection (obtained from the master tree viewer) IStructuredSelection structuredSel = ((IStructuredSelection) selection); diff --git a/ua/org.eclipse.pde.ua.ui/src/org/eclipse/pde/internal/ua/ui/editor/cheatsheet/ICSMaster.java b/ua/org.eclipse.pde.ua.ui/src/org/eclipse/pde/internal/ua/ui/editor/cheatsheet/ICSMaster.java index e31d601dc9..ba514a0ef5 100755 --- a/ua/org.eclipse.pde.ua.ui/src/org/eclipse/pde/internal/ua/ui/editor/cheatsheet/ICSMaster.java +++ b/ua/org.eclipse.pde.ua.ui/src/org/eclipse/pde/internal/ua/ui/editor/cheatsheet/ICSMaster.java @@ -18,14 +18,8 @@ import org.eclipse.ui.forms.widgets.Section; */ public interface ICSMaster { - /** - * - */ public void updateButtons(); - /** - * @return - */ public boolean isEditable(); /** @@ -35,15 +29,8 @@ public interface ICSMaster { */ public void fireSelection(); - /** - * @return - */ public Section getSection(); - /** - * @param object - * @return - */ public boolean setFormInput(Object object); } diff --git a/ua/org.eclipse.pde.ua.ui/src/org/eclipse/pde/internal/ua/ui/editor/cheatsheet/simple/SimpleCSBlock.java b/ua/org.eclipse.pde.ua.ui/src/org/eclipse/pde/internal/ua/ui/editor/cheatsheet/simple/SimpleCSBlock.java index bd18c3cda2..13c32cb7f3 100755 --- a/ua/org.eclipse.pde.ua.ui/src/org/eclipse/pde/internal/ua/ui/editor/cheatsheet/simple/SimpleCSBlock.java +++ b/ua/org.eclipse.pde.ua.ui/src/org/eclipse/pde/internal/ua/ui/editor/cheatsheet/simple/SimpleCSBlock.java @@ -48,9 +48,6 @@ public class SimpleCSBlock extends PDEMasterDetailsBlock implements IDetailsPage private SimpleCSIntroDetails fIntroDetails; - /** - * @param page - */ public SimpleCSBlock(PDEFormPage page) { super(page); } @@ -130,16 +127,10 @@ public class SimpleCSBlock extends PDEMasterDetailsBlock implements IDetailsPage //} } - /** - * @return - */ public ICSMaster getMastersSection() { return fMasterSection; } - /** - * @return - */ public ISelection getSelection() { if (fMasterSection != null) { return fMasterSection.getSelection(); diff --git a/ua/org.eclipse.pde.ua.ui/src/org/eclipse/pde/internal/ua/ui/editor/cheatsheet/simple/SimpleCSCommandManager.java b/ua/org.eclipse.pde.ua.ui/src/org/eclipse/pde/internal/ua/ui/editor/cheatsheet/simple/SimpleCSCommandManager.java index 94286ef9a6..f4c4c9ad95 100755 --- a/ua/org.eclipse.pde.ua.ui/src/org/eclipse/pde/internal/ua/ui/editor/cheatsheet/simple/SimpleCSCommandManager.java +++ b/ua/org.eclipse.pde.ua.ui/src/org/eclipse/pde/internal/ua/ui/editor/cheatsheet/simple/SimpleCSCommandManager.java @@ -32,32 +32,20 @@ public class SimpleCSCommandManager { private boolean fBlockEvents; - /** - * - */ private SimpleCSCommandManager() { fCommandMap = Collections.synchronizedMap(new HashMap()); fBlockEvents = false; fListeners = null; } - /** - * @param block - */ public void setBlockEvents(boolean block) { fBlockEvents = block; } - /** - * @return - */ public boolean getBlockEvents() { return fBlockEvents; } - /** - * @return - */ public static SimpleCSCommandManager Instance() { if (fPinstance == null) { fPinstance = new SimpleCSCommandManager(); @@ -65,11 +53,6 @@ public class SimpleCSCommandManager { return fPinstance; } - /** - * @param key - * @param value - * @return - */ public synchronized boolean put(String key, String value) { // Do not add the key-value pair if it is already in the map if (fCommandMap.containsKey(key)) { @@ -90,39 +73,22 @@ public class SimpleCSCommandManager { return true; } - /** - * @param key - * @return - */ public String get(String key) { return (String) fCommandMap.get(key); } - /** - * @param key - * @return - */ public boolean hasKey(String key) { return fCommandMap.containsKey(key); } - /** - * @return - */ public Set getKeys() { return fCommandMap.keySet(); } - /** - * @return - */ public int getSize() { return fCommandMap.size(); } - /** - * @param listener - */ public void addCommandKeyListener(ISimpleCSCommandKeyListener listener) { if (fListeners == null) { fListeners = new ListenerList(); @@ -130,9 +96,6 @@ public class SimpleCSCommandManager { fListeners.add(listener); } - /** - * @param listener - */ public void removeCommandKeyListener(ISimpleCSCommandKeyListener listener) { if (fListeners == null) { return; @@ -140,10 +103,6 @@ public class SimpleCSCommandManager { fListeners.remove(listener); } - /** - * @param key - * @param value - */ private void fireNewCommandKeyEvent(String key, String value) { // Do not fire the event if there are no listeners or we are blocking // events diff --git a/ua/org.eclipse.pde.ua.ui/src/org/eclipse/pde/internal/ua/ui/editor/cheatsheet/simple/SimpleCSDefinitionPage.java b/ua/org.eclipse.pde.ua.ui/src/org/eclipse/pde/internal/ua/ui/editor/cheatsheet/simple/SimpleCSDefinitionPage.java index fbd89c0468..afbfd3c250 100755 --- a/ua/org.eclipse.pde.ua.ui/src/org/eclipse/pde/internal/ua/ui/editor/cheatsheet/simple/SimpleCSDefinitionPage.java +++ b/ua/org.eclipse.pde.ua.ui/src/org/eclipse/pde/internal/ua/ui/editor/cheatsheet/simple/SimpleCSDefinitionPage.java @@ -46,9 +46,6 @@ public class SimpleCSDefinitionPage extends PDEFormPage implements private SimpleCSBlock fBlock;
private boolean fStale;
- /**
- * @param editor
- */
public SimpleCSDefinitionPage(FormEditor editor) {
super(editor, PAGE_ID, SimpleMessages.SimpleCSDefinitionPage_title);
fBlock = new SimpleCSBlock(this);
@@ -166,16 +163,10 @@ public class SimpleCSDefinitionPage extends PDEFormPage implements fBlock.modelChanged(event);
}
- /**
- * @return
- */
public ISelection getSelection() {
return fBlock.getSelection();
}
- /**
- * @return
- */
public PDEMasterDetailsBlock getBlock() {
return fBlock;
}
diff --git a/ua/org.eclipse.pde.ua.ui/src/org/eclipse/pde/internal/ua/ui/editor/cheatsheet/simple/SimpleCSEditorContributor.java b/ua/org.eclipse.pde.ua.ui/src/org/eclipse/pde/internal/ua/ui/editor/cheatsheet/simple/SimpleCSEditorContributor.java index 5a430fd57c..ce8fdb00dd 100755 --- a/ua/org.eclipse.pde.ua.ui/src/org/eclipse/pde/internal/ua/ui/editor/cheatsheet/simple/SimpleCSEditorContributor.java +++ b/ua/org.eclipse.pde.ua.ui/src/org/eclipse/pde/internal/ua/ui/editor/cheatsheet/simple/SimpleCSEditorContributor.java @@ -25,9 +25,6 @@ public class SimpleCSEditorContributor extends PDEFormTextEditorContributor { private SimpleCSPreviewAction fPreviewAction; - /** - * @param menuName - */ public SimpleCSEditorContributor() { super("&Simple Cheat Sheet"); //$NON-NLS-1$ fPreviewAction = null; @@ -58,9 +55,6 @@ public class SimpleCSEditorContributor extends PDEFormTextEditorContributor { super.contextMenuAboutToShow(manager, addClipboard); } - /** - * @return - */ public SimpleCSPreviewAction getPreviewAction() { return fPreviewAction; } diff --git a/ua/org.eclipse.pde.ua.ui/src/org/eclipse/pde/internal/ua/ui/editor/cheatsheet/simple/SimpleCSMasterTreeSection.java b/ua/org.eclipse.pde.ua.ui/src/org/eclipse/pde/internal/ua/ui/editor/cheatsheet/simple/SimpleCSMasterTreeSection.java index 990b77d909..2e9695dee9 100755 --- a/ua/org.eclipse.pde.ua.ui/src/org/eclipse/pde/internal/ua/ui/editor/cheatsheet/simple/SimpleCSMasterTreeSection.java +++ b/ua/org.eclipse.pde.ua.ui/src/org/eclipse/pde/internal/ua/ui/editor/cheatsheet/simple/SimpleCSMasterTreeSection.java @@ -80,12 +80,6 @@ public class SimpleCSMasterTreeSection extends TreeSection implements ICSMaster private ControlDecoration fSubStepInfoDecoration; - /** - * @param formPage - * @param parent - * @param style - * @param buttonLabels - */ public SimpleCSMasterTreeSection(PDEFormPage formPage, Composite parent) { super(formPage, parent, Section.DESCRIPTION, new String[] { SimpleMessages.SimpleCSMasterTreeSection_addStep, @@ -127,10 +121,6 @@ public class SimpleCSMasterTreeSection extends TreeSection implements ICSMaster createSectionToolbar(section, toolkit); } - /** - * @param section - * @param toolkit - */ private void createSectionToolbar(Section section, FormToolkit toolkit) { ToolBarManager toolBarManager = new ToolBarManager(SWT.FLAT); @@ -149,9 +139,6 @@ public class SimpleCSMasterTreeSection extends TreeSection implements ICSMaster section.setTextClient(toolbar); } - /** - * - */ private void initializeTreeViewer() { ISelection selection = fTreeViewer.getSelection(); if (fModel == null) { @@ -181,10 +168,6 @@ public class SimpleCSMasterTreeSection extends TreeSection implements ICSMaster fTreeViewer.setSelection(selection, true); } - /** - * @param container - * @param toolkit - */ private void createTree(Composite container, FormToolkit toolkit) { TreePart treePart = getTreePart(); createViewerPartControl(container, SWT.SINGLE, 2, toolkit); @@ -282,12 +265,6 @@ public class SimpleCSMasterTreeSection extends TreeSection implements ICSMaster return false; } - /** - * @param targetCheatSheet - * @param sourceItem - * @param targetLocation - * @return - */ private boolean canDropMove(ISimpleCS targetCheatSheet, ISimpleCSItem sourceItem, int targetLocation) { if (targetLocation == ViewerDropAdapter.LOCATION_BEFORE) { @@ -304,12 +281,6 @@ public class SimpleCSMasterTreeSection extends TreeSection implements ICSMaster return false; } - /** - * @param targetItem - * @param sourceItem - * @param targetLocation - * @return - */ private boolean canDropMove(ISimpleCSItem targetItem, ISimpleCSItem sourceItem, int targetLocation) { ISimpleCS parent = targetItem.getSimpleCS(); @@ -341,12 +312,6 @@ public class SimpleCSMasterTreeSection extends TreeSection implements ICSMaster return false; } - /** - * @param targetIntro - * @param sourceItem - * @param targetLocation - * @return - */ private boolean canDropMove(ISimpleCSIntro targetIntro, ISimpleCSItem sourceItem, int targetLocation) { ISimpleCS parent = targetIntro.getSimpleCS(); @@ -374,12 +339,6 @@ public class SimpleCSMasterTreeSection extends TreeSection implements ICSMaster return false; } - /** - * @param targetItem - * @param sourceSubItem - * @param targetLocation - * @return - */ private boolean canDropMove(ISimpleCSItem targetItem, ISimpleCSSubItem sourceSubItem, int targetLocation) { if (targetLocation == ViewerDropAdapter.LOCATION_BEFORE) { @@ -404,12 +363,6 @@ public class SimpleCSMasterTreeSection extends TreeSection implements ICSMaster return false; } - /** - * @param targetSubItem - * @param sourceSubItem - * @param targetLocation - * @return - */ private boolean canDropMove(ISimpleCSSubItem targetSubItem, ISimpleCSSubItem sourceSubItem, int targetLocation) { ISimpleCSItem parent = (ISimpleCSItem) targetSubItem.getParent(); @@ -494,11 +447,6 @@ public class SimpleCSMasterTreeSection extends TreeSection implements ICSMaster } } - /** - * @param targetCheatSheet - * @param sourceItem - * @param targetLocation - */ private void doDropMove(ISimpleCS targetCheatSheet, ISimpleCSItem sourceItem, int targetLocation) { if (targetLocation == ViewerDropAdapter.LOCATION_BEFORE) { @@ -517,11 +465,6 @@ public class SimpleCSMasterTreeSection extends TreeSection implements ICSMaster } } - /** - * @param targetItem - * @param sourceItem - * @param targetLocation - */ private void doDropMove(ISimpleCSItem targetItem, ISimpleCSItem sourceItem, int targetLocation) { ISimpleCS parent = targetItem.getSimpleCS(); @@ -566,11 +509,6 @@ public class SimpleCSMasterTreeSection extends TreeSection implements ICSMaster } } - /** - * @param targetIntro - * @param sourceItem - * @param targetLocation - */ private void doDropMove(ISimpleCSIntro targetIntro, ISimpleCSItem sourceItem, int targetLocation) { ISimpleCS parent = targetIntro.getSimpleCS(); @@ -601,11 +539,6 @@ public class SimpleCSMasterTreeSection extends TreeSection implements ICSMaster } } - /** - * @param targetItem - * @param sourceSubItem - * @param targetLocation - */ private void doDropMove(ISimpleCSItem targetItem, ISimpleCSSubItem sourceSubItem, int targetLocation) { if (targetLocation == ViewerDropAdapter.LOCATION_BEFORE) { @@ -646,11 +579,6 @@ public class SimpleCSMasterTreeSection extends TreeSection implements ICSMaster } } - /** - * @param targetSubItem - * @param sourceSubItem - * @param targetLocation - */ private void doDropMove(ISimpleCSSubItem targetSubItem, ISimpleCSSubItem sourceSubItem, int targetLocation) { ISimpleCSItem parent = (ISimpleCSItem) targetSubItem.getParent(); @@ -738,9 +666,6 @@ public class SimpleCSMasterTreeSection extends TreeSection implements ICSMaster .getPrimaryContext().flushEditorInput(); } - /** - * - */ private void createSubStepInfoDecoration() { // Button button = getStructuredViewerPart().getButton( @@ -754,11 +679,6 @@ public class SimpleCSMasterTreeSection extends TreeSection implements ICSMaster .getImage()); } - /** - * @param show - * @param itemHasNoExecutable - * @param itemIsNotOptional - */ private void updateSubStepInfoDecoration(boolean show, boolean itemHasNoExecutable, boolean itemIsNotOptional) { // @@ -777,9 +697,6 @@ public class SimpleCSMasterTreeSection extends TreeSection implements ICSMaster fSubStepInfoDecoration.setShowHover(show); } - /** - * - */ private void createTreeListeners() { // Create listener for the outline view 'link with editor' toggle // button @@ -787,9 +704,6 @@ public class SimpleCSMasterTreeSection extends TreeSection implements ICSMaster .addPostSelectionChangedListener(getPage().getPDEEditor().new PDEFormEditorChangeListener()); } - /** - * @return - */ public ISelection getSelection() { return fTreeViewer.getSelection(); } @@ -838,9 +752,6 @@ public class SimpleCSMasterTreeSection extends TreeSection implements ICSMaster updateButtons(); } - /** - * - */ public void updateButtons() { if (!fModel.isEditable()) { return; @@ -945,9 +856,6 @@ public class SimpleCSMasterTreeSection extends TreeSection implements ICSMaster getTreePart().setButtonEnabled(F_BUTTON_DOWN, canMoveDown); } - /** - * - */ private void handleAddStepAction() { // Get the current selection ISimpleCSObject csObject = getCurrentSelection(); @@ -961,18 +869,12 @@ public class SimpleCSMasterTreeSection extends TreeSection implements ICSMaster fAddStepAction.run(); } - /** - * @return - */ private ISimpleCSObject getCurrentSelection() { ISelection selection = fTreeViewer.getSelection(); Object object = ((IStructuredSelection) selection).getFirstElement(); return (ISimpleCSObject) object; } - /** - * - */ private void handleAddSubStepAction() { // Get the current selection ISimpleCSObject csObject = getCurrentSelection(); @@ -986,9 +888,6 @@ public class SimpleCSMasterTreeSection extends TreeSection implements ICSMaster fAddSubStepAction.run(); } - /** - * - */ private void handleMoveStepAction(int positionFlag) { ISimpleCSObject object = getCurrentSelection(); if (object != null) { @@ -1007,9 +906,6 @@ public class SimpleCSMasterTreeSection extends TreeSection implements ICSMaster } } - /** - * - */ private void handlePreviewAction() { // Get the editor PDEFormEditor editor = (PDEFormEditor) getPage().getEditor(); @@ -1068,17 +964,11 @@ public class SimpleCSMasterTreeSection extends TreeSection implements ICSMaster super.refresh(); } - /** - * @param event - */ private void handleModelEventWorldChanged(IModelChangedEvent event) { // Section will be updated on refresh markStale(); } - /** - * @param event - */ private void handleModelChangeTypeSwap(IModelChangedEvent event) { // Swap event Object[] objects = event.getChangedObjects(); @@ -1096,9 +986,6 @@ public class SimpleCSMasterTreeSection extends TreeSection implements ICSMaster } } - /** - * @param event - */ private void handleModelInsertType(IModelChangedEvent event) { // Insert event Object[] objects = event.getChangedObjects(); @@ -1114,9 +1001,6 @@ public class SimpleCSMasterTreeSection extends TreeSection implements ICSMaster } } - /** - * @param event - */ private void handleModelRemoveType(IModelChangedEvent event) { // Remove event Object[] objects = event.getChangedObjects(); @@ -1160,9 +1044,6 @@ public class SimpleCSMasterTreeSection extends TreeSection implements ICSMaster } } - /** - * @param event - */ private void handleModelChangeType(IModelChangedEvent event) { // Change event Object[] objects = event.getChangedObjects(); @@ -1300,9 +1181,6 @@ public class SimpleCSMasterTreeSection extends TreeSection implements ICSMaster return false; } - /** - * @param object - */ private void handleDeleteAction() { ISimpleCSObject object = getCurrentSelection(); if (object != null) { @@ -1364,11 +1242,6 @@ public class SimpleCSMasterTreeSection extends TreeSection implements ICSMaster return false; } - /** - * @param targetObject - * @param sourceObjects - * @return - */ private boolean validatePaste(Object targetObject, Object[] sourceObjects) { // Validate target object if ((targetObject instanceof ISimpleCSObject) == false) { @@ -1381,10 +1254,6 @@ public class SimpleCSMasterTreeSection extends TreeSection implements ICSMaster return true; } - /** - * @param sourceObjects - * @return - */ private boolean validatePaste(Object[] sourceObjects) { // Validate source objects if (sourceObjects == null) { diff --git a/ua/org.eclipse.pde.ua.ui/src/org/eclipse/pde/internal/ua/ui/editor/cheatsheet/simple/actions/SimpleCSAddSubStepAction.java b/ua/org.eclipse.pde.ua.ui/src/org/eclipse/pde/internal/ua/ui/editor/cheatsheet/simple/actions/SimpleCSAddSubStepAction.java index 228c6adb01..099989f085 100755 --- a/ua/org.eclipse.pde.ua.ui/src/org/eclipse/pde/internal/ua/ui/editor/cheatsheet/simple/actions/SimpleCSAddSubStepAction.java +++ b/ua/org.eclipse.pde.ua.ui/src/org/eclipse/pde/internal/ua/ui/editor/cheatsheet/simple/actions/SimpleCSAddSubStepAction.java @@ -14,34 +14,19 @@ package org.eclipse.pde.internal.ua.ui.editor.cheatsheet.simple.actions; import java.util.ArrayList; import org.eclipse.jface.action.Action; -import org.eclipse.pde.internal.ua.core.cheatsheet.simple.ISimpleCSConstants; -import org.eclipse.pde.internal.ua.core.cheatsheet.simple.ISimpleCSItem; -import org.eclipse.pde.internal.ua.core.cheatsheet.simple.ISimpleCSModelFactory; -import org.eclipse.pde.internal.ua.core.cheatsheet.simple.ISimpleCSObject; -import org.eclipse.pde.internal.ua.core.cheatsheet.simple.ISimpleCSSubItem; -import org.eclipse.pde.internal.ua.core.cheatsheet.simple.ISimpleCSSubItemObject; +import org.eclipse.pde.internal.ua.core.cheatsheet.simple.*; import org.eclipse.pde.internal.ui.util.PDELabelUtility; -/** - * SimpleCSAddStepAction - * - */ public class SimpleCSAddSubStepAction extends Action { private ISimpleCSItem fItem; private ISimpleCSSubItem fSubitem; - /** - * - */ public SimpleCSAddSubStepAction() { setText(SimpleActionMessages.SimpleCSAddSubStepAction_actionText); } - /** - * @param cheatsheet - */ public void setDataObject(ISimpleCSObject csObject) { // Determine input if (csObject.getType() == ISimpleCSConstants.TYPE_ITEM) { @@ -81,9 +66,6 @@ public class SimpleCSAddSubStepAction extends Action { insertNewSubItem(newSubItem); } - /** - * @return - */ private ISimpleCSSubItem createNewSubItem() { ISimpleCSModelFactory factory = fItem.getModel().getFactory(); // Element: subitem @@ -105,9 +87,6 @@ public class SimpleCSAddSubStepAction extends Action { return subitem; } - /** - * @param newSubItem - */ private void insertNewSubItem(ISimpleCSSubItem newSubItem) { // Insert the new subitem depending on the input specfied if (fSubitem != null) { diff --git a/ua/org.eclipse.pde.ua.ui/src/org/eclipse/pde/internal/ua/ui/editor/cheatsheet/simple/actions/SimpleCSPreviewAction.java b/ua/org.eclipse.pde.ua.ui/src/org/eclipse/pde/internal/ua/ui/editor/cheatsheet/simple/actions/SimpleCSPreviewAction.java index 1e39263927..bb84fdb686 100755 --- a/ua/org.eclipse.pde.ua.ui/src/org/eclipse/pde/internal/ua/ui/editor/cheatsheet/simple/actions/SimpleCSPreviewAction.java +++ b/ua/org.eclipse.pde.ua.ui/src/org/eclipse/pde/internal/ua/ui/editor/cheatsheet/simple/actions/SimpleCSPreviewAction.java @@ -32,9 +32,6 @@ public class SimpleCSPreviewAction extends Action { private IEditorInput fEditorInput; - /** - * @param input - */ public SimpleCSPreviewAction() { fDataModelObject = null; fEditorInput = null; @@ -73,16 +70,10 @@ public class SimpleCSPreviewAction extends Action { } } - /** - * @param object - */ public void setDataModelObject(ISimpleCS object) { fDataModelObject = object; } - /** - * @param editorInput - */ public void setEditorInput(IEditorInput editorInput) { fEditorInput = editorInput; } diff --git a/ua/org.eclipse.pde.ua.ui/src/org/eclipse/pde/internal/ua/ui/editor/cheatsheet/simple/actions/SimpleCSRemoveRunObjectAction.java b/ua/org.eclipse.pde.ua.ui/src/org/eclipse/pde/internal/ua/ui/editor/cheatsheet/simple/actions/SimpleCSRemoveRunObjectAction.java index fe13e38e04..4cd399d012 100755 --- a/ua/org.eclipse.pde.ua.ui/src/org/eclipse/pde/internal/ua/ui/editor/cheatsheet/simple/actions/SimpleCSRemoveRunObjectAction.java +++ b/ua/org.eclipse.pde.ua.ui/src/org/eclipse/pde/internal/ua/ui/editor/cheatsheet/simple/actions/SimpleCSRemoveRunObjectAction.java @@ -12,13 +12,7 @@ package org.eclipse.pde.internal.ua.ui.editor.cheatsheet.simple.actions; import org.eclipse.jface.action.Action; -import org.eclipse.pde.internal.ua.core.cheatsheet.simple.ISimpleCSConstants; -import org.eclipse.pde.internal.ua.core.cheatsheet.simple.ISimpleCSItem; -import org.eclipse.pde.internal.ua.core.cheatsheet.simple.ISimpleCSObject; -import org.eclipse.pde.internal.ua.core.cheatsheet.simple.ISimpleCSPerformWhen; -import org.eclipse.pde.internal.ua.core.cheatsheet.simple.ISimpleCSRunContainerObject; -import org.eclipse.pde.internal.ua.core.cheatsheet.simple.ISimpleCSRunObject; -import org.eclipse.pde.internal.ua.core.cheatsheet.simple.ISimpleCSSubItem; +import org.eclipse.pde.internal.ua.core.cheatsheet.simple.*; /** * SimpleCSAddStepAction @@ -28,18 +22,12 @@ public class SimpleCSRemoveRunObjectAction extends Action { private ISimpleCSRunContainerObject fRunContainerObject; - /** - * - */ public SimpleCSRemoveRunObjectAction() { setText(SimpleActionMessages.SimpleCSRemoveRunObjectAction_actionText); // setImageDescriptor(PDEUserAssistanceUIPluginImages.DESC_GEL_SC_OBJ); // setToolTipText(PDEUIMessages.SchemaEditor_NewElement_tooltip); } - /** - * @param cheatsheet - */ public void setRunObject(ISimpleCSRunContainerObject runObject) { fRunContainerObject = runObject; } diff --git a/ua/org.eclipse.pde.ua.ui/src/org/eclipse/pde/internal/ua/ui/editor/cheatsheet/simple/actions/SimpleCSRemoveStepAction.java b/ua/org.eclipse.pde.ua.ui/src/org/eclipse/pde/internal/ua/ui/editor/cheatsheet/simple/actions/SimpleCSRemoveStepAction.java index 68ed2c9ec4..bcdb0c1061 100755 --- a/ua/org.eclipse.pde.ua.ui/src/org/eclipse/pde/internal/ua/ui/editor/cheatsheet/simple/actions/SimpleCSRemoveStepAction.java +++ b/ua/org.eclipse.pde.ua.ui/src/org/eclipse/pde/internal/ua/ui/editor/cheatsheet/simple/actions/SimpleCSRemoveStepAction.java @@ -26,9 +26,6 @@ public class SimpleCSRemoveStepAction extends Action { private ISimpleCSObject fObjectToSelect; - /** - * - */ public SimpleCSRemoveStepAction() { setText(SimpleActionMessages.SimpleCSRemoveStepAction_actionText); // TODO: MP: LOW: SimpleCS: Add tool-tip / image ? @@ -38,9 +35,6 @@ public class SimpleCSRemoveStepAction extends Action { fObjectToSelect = null; } - /** - * @param cheatsheet - */ public void setItem(ISimpleCSItem item) { fItem = item; } @@ -59,9 +53,6 @@ public class SimpleCSRemoveStepAction extends Action { } } - /** - * @param cheatsheet - */ private void determineItemToSelect(ISimpleCS cheatsheet) { // Select the next sibling fObjectToSelect = cheatsheet.getNextSibling(fItem); @@ -77,9 +68,6 @@ public class SimpleCSRemoveStepAction extends Action { } } - /** - * @return - */ public ISimpleCSObject getObjectToSelect() { return fObjectToSelect; } diff --git a/ua/org.eclipse.pde.ua.ui/src/org/eclipse/pde/internal/ua/ui/editor/cheatsheet/simple/actions/SimpleCSRemoveSubStepAction.java b/ua/org.eclipse.pde.ua.ui/src/org/eclipse/pde/internal/ua/ui/editor/cheatsheet/simple/actions/SimpleCSRemoveSubStepAction.java index 38d64e6a75..23db80cce6 100755 --- a/ua/org.eclipse.pde.ua.ui/src/org/eclipse/pde/internal/ua/ui/editor/cheatsheet/simple/actions/SimpleCSRemoveSubStepAction.java +++ b/ua/org.eclipse.pde.ua.ui/src/org/eclipse/pde/internal/ua/ui/editor/cheatsheet/simple/actions/SimpleCSRemoveSubStepAction.java @@ -12,13 +12,7 @@ package org.eclipse.pde.internal.ua.ui.editor.cheatsheet.simple.actions; import org.eclipse.jface.action.Action; -import org.eclipse.pde.internal.ua.core.cheatsheet.simple.ISimpleCSConditionalSubItem; -import org.eclipse.pde.internal.ua.core.cheatsheet.simple.ISimpleCSConstants; -import org.eclipse.pde.internal.ua.core.cheatsheet.simple.ISimpleCSItem; -import org.eclipse.pde.internal.ua.core.cheatsheet.simple.ISimpleCSObject; -import org.eclipse.pde.internal.ua.core.cheatsheet.simple.ISimpleCSRepeatedSubItem; -import org.eclipse.pde.internal.ua.core.cheatsheet.simple.ISimpleCSSubItem; -import org.eclipse.pde.internal.ua.core.cheatsheet.simple.ISimpleCSSubItemObject; +import org.eclipse.pde.internal.ua.core.cheatsheet.simple.*; /** * SimpleCSAddStepAction @@ -30,21 +24,12 @@ public class SimpleCSRemoveSubStepAction extends Action { private ISimpleCSObject fObjectToSelect; - /** - * - */ public SimpleCSRemoveSubStepAction() { - // TODO: MP: LOW: SimpleCS: Add tool-tip / image ? setText(SimpleActionMessages.SimpleCSRemoveSubStepAction_actionText); -// setImageDescriptor(PDEUserAssistanceUIPluginImages.DESC_GEL_SC_OBJ); -// setToolTipText(PDEUIMessages.SchemaEditor_NewElement_tooltip); fSubItem = null; fObjectToSelect = null; } - /** - * @param subitem - */ public void setSubItem(ISimpleCSSubItemObject subitem) { fSubItem = subitem; } @@ -81,9 +66,6 @@ public class SimpleCSRemoveSubStepAction extends Action { } } - /** - * @param item - */ private void determineItemToSelect(ISimpleCSItem item) { // Select the next sibling fObjectToSelect = item.getNextSibling(fSubItem); @@ -99,17 +81,11 @@ public class SimpleCSRemoveSubStepAction extends Action { } } - /** - * @param item - */ private void determineItemToSelect(ISimpleCSObject object) { // The parent itself fObjectToSelect = object; } - /** - * @return - */ public ISimpleCSObject getObjectToSelect() { return fObjectToSelect; } diff --git a/ua/org.eclipse.pde.ua.ui/src/org/eclipse/pde/internal/ua/ui/editor/cheatsheet/simple/details/SimpleCSCommandComboPart.java b/ua/org.eclipse.pde.ua.ui/src/org/eclipse/pde/internal/ua/ui/editor/cheatsheet/simple/details/SimpleCSCommandComboPart.java index dba4821513..acf1a20157 100755 --- a/ua/org.eclipse.pde.ua.ui/src/org/eclipse/pde/internal/ua/ui/editor/cheatsheet/simple/details/SimpleCSCommandComboPart.java +++ b/ua/org.eclipse.pde.ua.ui/src/org/eclipse/pde/internal/ua/ui/editor/cheatsheet/simple/details/SimpleCSCommandComboPart.java @@ -34,18 +34,12 @@ public class SimpleCSCommandComboPart extends ComboPart implements ISimpleCSComm private int fComboEntryLimit; - /** - * - */ public SimpleCSCommandComboPart() { super(); fNewCommandKeyIndex = -1; fComboEntryLimit = -1; } - /** - * @param listener - */ public void addDisposeListener(DisposeListener listener) { if (combo == null) { return; @@ -78,9 +72,6 @@ public class SimpleCSCommandComboPart extends ComboPart implements ISimpleCSComm putValueInCombo(key, fNewCommandKeyIndex); } - /** - * @param key - */ private void putValueInCombo(String key, int index) { // Ensure the key does not already exist in the combo if (indexOf(key) != -1) { @@ -101,9 +92,6 @@ public class SimpleCSCommandComboPart extends ComboPart implements ISimpleCSComm } } - /** - * - */ private void removeLeastRecentEntry() { // The least recent entry is the last non-selected entry in the // reciever's list @@ -129,16 +117,10 @@ public class SimpleCSCommandComboPart extends ComboPart implements ISimpleCSComm remove(secondlastEntry); } - /** - * @param limit - */ public void setComboEntryLimit(int limit) { fComboEntryLimit = limit; } - /** - * @return - */ public int getComboEntryLimit() { return fComboEntryLimit; } @@ -153,9 +135,6 @@ public class SimpleCSCommandComboPart extends ComboPart implements ISimpleCSComm fNewCommandKeyIndex = newCommandKeyIndex; } - /** - * @return - */ public int getNewCommandKeyIndex() { return fNewCommandKeyIndex; } @@ -168,9 +147,6 @@ public class SimpleCSCommandComboPart extends ComboPart implements ISimpleCSComm SimpleCSCommandManager.Instance().removeCommandKeyListener(this); } - /** - * - */ public void populate() { // Populate the combo with all the values found in the command manager Iterator iterator = SimpleCSCommandManager.Instance().getKeys().iterator(); @@ -180,18 +156,10 @@ public class SimpleCSCommandComboPart extends ComboPart implements ISimpleCSComm } } - /** - * @param key - * @param value - */ public void putValue(String key, String value) { putValue(key, value, -1); } - /** - * @param key - * @param value - */ public void putValue(String key, String value, int index) { // Source: This combo box // Add the new key to the combo if it does not already exist @@ -202,10 +170,6 @@ public class SimpleCSCommandComboPart extends ComboPart implements ISimpleCSComm manager.put(key, value); } - /** - * @param key - * @return - */ public String getValue(String key) { return SimpleCSCommandManager.Instance().get(key); } diff --git a/ua/org.eclipse.pde.ua.ui/src/org/eclipse/pde/internal/ua/ui/editor/cheatsheet/simple/details/SimpleCSSubItemDetails.java b/ua/org.eclipse.pde.ua.ui/src/org/eclipse/pde/internal/ua/ui/editor/cheatsheet/simple/details/SimpleCSSubItemDetails.java index 4a42748895..ad45cb1bff 100755 --- a/ua/org.eclipse.pde.ua.ui/src/org/eclipse/pde/internal/ua/ui/editor/cheatsheet/simple/details/SimpleCSSubItemDetails.java +++ b/ua/org.eclipse.pde.ua.ui/src/org/eclipse/pde/internal/ua/ui/editor/cheatsheet/simple/details/SimpleCSSubItemDetails.java @@ -45,9 +45,6 @@ public class SimpleCSSubItemDetails extends CSAbstractDetails { private SimpleCSCommandDetails fCommandSection; - /** - * @param elementSection - */ public SimpleCSSubItemDetails(ICSMaster masterTreeSection) { super(masterTreeSection, SimpleCSInputContext.CONTEXT_ID); fSubItem = null; @@ -58,9 +55,6 @@ public class SimpleCSSubItemDetails extends CSAbstractDetails { fCommandSection = new SimpleCSCommandDetails(masterTreeSection); } - /** - * @param object - */ public void setData(ISimpleCSSubItem object) { // Set data fSubItem = object; diff --git a/ua/org.eclipse.pde.ua.ui/src/org/eclipse/pde/internal/ua/ui/editor/toc/HelpEditorUtil.java b/ua/org.eclipse.pde.ua.ui/src/org/eclipse/pde/internal/ua/ui/editor/toc/HelpEditorUtil.java index bffa3b273b..3339118cdd 100644 --- a/ua/org.eclipse.pde.ua.ui/src/org/eclipse/pde/internal/ua/ui/editor/toc/HelpEditorUtil.java +++ b/ua/org.eclipse.pde.ua.ui/src/org/eclipse/pde/internal/ua/ui/editor/toc/HelpEditorUtil.java @@ -63,9 +63,6 @@ public class HelpEditorUtil { return fileExtension != null && fileExtension.equals(tocExtension); } - /** - * @param file - */ public static boolean isTOCFile(IPath path) { if (!hasValidTocExtension(path)) return false; diff --git a/ua/org.eclipse.pde.ua.ui/src/org/eclipse/pde/internal/ua/ui/editor/toc/TocDragAdapter.java b/ua/org.eclipse.pde.ua.ui/src/org/eclipse/pde/internal/ua/ui/editor/toc/TocDragAdapter.java index bff55c4c64..1412d01bf8 100755 --- a/ua/org.eclipse.pde.ua.ui/src/org/eclipse/pde/internal/ua/ui/editor/toc/TocDragAdapter.java +++ b/ua/org.eclipse.pde.ua.ui/src/org/eclipse/pde/internal/ua/ui/editor/toc/TocDragAdapter.java @@ -37,7 +37,6 @@ public class TocDragAdapter implements DragSourceListener { * Constructs a new Drag Adapter with the specified selection * provider and TocTreeSection * - * @param provider The provider of the dragged items * @param section The section that will handle removal */ public TocDragAdapter(TocTreeSection section) { diff --git a/ua/org.eclipse.pde.ua.ui/src/org/eclipse/pde/internal/ua/ui/editor/toc/TocHyperlinkDetector.java b/ua/org.eclipse.pde.ua.ui/src/org/eclipse/pde/internal/ua/ui/editor/toc/TocHyperlinkDetector.java index a1847dcb94..3c80aa9b6b 100755 --- a/ua/org.eclipse.pde.ua.ui/src/org/eclipse/pde/internal/ua/ui/editor/toc/TocHyperlinkDetector.java +++ b/ua/org.eclipse.pde.ua.ui/src/org/eclipse/pde/internal/ua/ui/editor/toc/TocHyperlinkDetector.java @@ -25,9 +25,6 @@ import org.eclipse.pde.internal.ui.editor.text.ResourceHyperlink; public class TocHyperlinkDetector extends PDEHyperlinkDetector { - /** - * @param editor the editor in which to detect the hyperlink - */ public TocHyperlinkDetector(PDESourcePage page) { super(page); } diff --git a/ua/org.eclipse.pde.ua.ui/src/org/eclipse/pde/internal/ua/ui/editor/toc/TocPage.java b/ua/org.eclipse.pde.ua.ui/src/org/eclipse/pde/internal/ua/ui/editor/toc/TocPage.java index 278abb4e97..ced08f7b9a 100755 --- a/ua/org.eclipse.pde.ua.ui/src/org/eclipse/pde/internal/ua/ui/editor/toc/TocPage.java +++ b/ua/org.eclipse.pde.ua.ui/src/org/eclipse/pde/internal/ua/ui/editor/toc/TocPage.java @@ -46,18 +46,12 @@ public class TocPage extends PDEFormPage implements IModelChangedListener { private TocBlock fBlock; - /** - * @param editor - */ public TocPage(FormEditor editor) { super(editor, PAGE_ID, TocMessages.TocPage_title); fBlock = new TocBlock(this); } - /** - * @return - */ public PDEMasterDetailsBlock getBlock() { return fBlock; } @@ -152,16 +146,10 @@ public class TocPage extends PDEFormPage implements IModelChangedListener { fBlock.modelChanged(event); } - /** - * @return - */ public ISelection getSelection() { return fBlock.getSelection(); } - /** - * @param event - */ private void handleModelEventWorldChanged(IModelChangedEvent event) { Object[] objects = event.getChangedObjects(); diff --git a/ua/org.eclipse.pde.ua.ui/src/org/eclipse/pde/internal/ua/ui/editor/toc/details/TocAbstractDetails.java b/ua/org.eclipse.pde.ua.ui/src/org/eclipse/pde/internal/ua/ui/editor/toc/details/TocAbstractDetails.java index df5c2b1c3d..941422e50c 100755 --- a/ua/org.eclipse.pde.ua.ui/src/org/eclipse/pde/internal/ua/ui/editor/toc/details/TocAbstractDetails.java +++ b/ua/org.eclipse.pde.ua.ui/src/org/eclipse/pde/internal/ua/ui/editor/toc/details/TocAbstractDetails.java @@ -44,9 +44,6 @@ public abstract class TocAbstractDetails extends PDEDetails { private String fContextID; - /** - * - */ public TocAbstractDetails(TocTreeSection masterSection, String contextID) { fMasterSection = masterSection; fContextID = contextID; @@ -62,16 +59,10 @@ public abstract class TocAbstractDetails extends PDEDetails { hookListeners(); } - /** - * @param parent - */ private void configureParentLayout(Composite parent) { parent.setLayout(FormLayoutFactory.createDetailsGridLayout(false, 1)); } - /** - * @param parent - */ public void createDetails(Composite parent) { // Create the main section int style = ExpandableComposite.TITLE_BAR; @@ -94,29 +85,14 @@ public abstract class TocAbstractDetails extends PDEDetails { markDetailsPart(fMainSection); } - /** - * - */ protected abstract void createFields(Composite parent); - /** - * - */ protected abstract String getDetailsTitle(); - /** - * - */ protected abstract String getDetailsDescription(); - /** - * - */ public abstract void updateFields(); - /** - * - */ public abstract void hookListeners(); /* (non-Javadoc) @@ -187,31 +163,18 @@ public abstract class TocAbstractDetails extends PDEDetails { // NO-OP } - /** - * @return - */ public boolean isEditableElement() { return fMasterSection.isEditable(); } - /** - * @return - */ public FormToolkit getToolkit() { return getManagedForm().getToolkit(); } - /** - * @return - */ public TocTreeSection getMasterSection() { return fMasterSection; } - /** - * @param selection - * @return - */ protected Object getFirstSelectedObject(ISelection selection) { // Get the structured selection (obtained from the master tree viewer) IStructuredSelection structuredSel = ((IStructuredSelection) selection); |