diff options
| author | Paul Pazderski | 2019-11-22 20:29:07 +0000 |
|---|---|---|
| committer | Alexander Kurtakov | 2019-11-23 06:56:26 +0000 |
| commit | 1e4711dcdb57d77c8d11e3deb94ddf0fefc3bf8b (patch) | |
| tree | 656460b07c9580c8cb640a7a5b52614f1c1e7c7b /org.eclipse.ui.cheatsheets | |
| parent | 22f7a9940afebb90e0b9067722e647d5c1f64928 (diff) | |
| download | eclipse.platform.ua-1e4711dcdb57d77c8d11e3deb94ddf0fefc3bf8b.tar.gz eclipse.platform.ua-1e4711dcdb57d77c8d11e3deb94ddf0fefc3bf8b.tar.xz eclipse.platform.ua-1e4711dcdb57d77c8d11e3deb94ddf0fefc3bf8b.zip | |
Bug 548250 - Javadoc problems in platform.uaY20191127-0140Y20191126-0500S4_14_0_RC2aS4_14_0_RC2S4_14_0_RC1R4_14I20191210-0610I20191204-1800I20191204-0600I20191203-1800I20191203-0600I20191202-1800I20191202-0600I20191201-1800I20191201-0600I20191130-1800I20191130-0600I20191129-1800I20191127-1800I20191127-0600I20191126-2315I20191126-1800I20191126-0600I20191125-1800I20191125-0600I20191124-1800I20191124-0600I20191123-1800I20191123-1115I20191123-0600R4_14_maintenance
Change-Id: I4fc959485fcb2ee5b20c4099c0f08532e66669da
Signed-off-by: Paul Pazderski <paul-eclipse@ppazderski.de>
Diffstat (limited to 'org.eclipse.ui.cheatsheets')
14 files changed, 63 insertions, 47 deletions
diff --git a/org.eclipse.ui.cheatsheets/src/org/eclipse/ui/internal/cheatsheets/actions/CheatSheetMenu.java b/org.eclipse.ui.cheatsheets/src/org/eclipse/ui/internal/cheatsheets/actions/CheatSheetMenu.java index 9523e4041..cf6bf9981 100644 --- a/org.eclipse.ui.cheatsheets/src/org/eclipse/ui/internal/cheatsheets/actions/CheatSheetMenu.java +++ b/org.eclipse.ui.cheatsheets/src/org/eclipse/ui/internal/cheatsheets/actions/CheatSheetMenu.java @@ -200,7 +200,7 @@ public class CheatSheetMenu extends ContributionItem { * is a good guideline to follow). * </p> * - * @return an <code>ArrayList<code> of cheatsheet items <code>CheatSheetElement</code> + * @return an <code>ArrayList</code> of cheatsheet items <code>CheatSheetElement</code> */ protected ArrayList<CheatSheetElement> getCheatSheetItems() { ArrayList<CheatSheetElement> list = new ArrayList<>(MAX_CHEATSHEET_ITEMS); @@ -309,9 +309,9 @@ public class CheatSheetMenu extends ContributionItem { /** * Sets the showActive flag. If <code>showActive == true</code> then the - * active cheatsheet is hilighted with a check mark. + * active cheatsheet is highlighted with a check mark. * - * @param the new showActive flag + * @param b the new showActive flag */ protected void showActive(boolean b) { showActive = b; diff --git a/org.eclipse.ui.cheatsheets/src/org/eclipse/ui/internal/cheatsheets/composite/model/BlockedTaskFinder.java b/org.eclipse.ui.cheatsheets/src/org/eclipse/ui/internal/cheatsheets/composite/model/BlockedTaskFinder.java index c30892fae..81d619add 100644 --- a/org.eclipse.ui.cheatsheets/src/org/eclipse/ui/internal/cheatsheets/composite/model/BlockedTaskFinder.java +++ b/org.eclipse.ui.cheatsheets/src/org/eclipse/ui/internal/cheatsheets/composite/model/BlockedTaskFinder.java @@ -23,22 +23,29 @@ public class BlockedTaskFinder { private Set<ICompositeCheatSheetTask> stateChangedTasks; private Set<ICompositeCheatSheetTask> impactedTasks; + /** - * Find which tasks have either become blocked or unblocked so that they - * can be added to the list of change events. - * @param stateChangedTasks The set of tasks which has changed + * Find which tasks have either become blocked or unblocked so that they can + * be added to the list of change events. + * + * @param stateChangedTasks + * The set of tasks which has changed * @return The set of tasks which have become blocked or unblocked by the - * change of state and were not in the original set. The algorithm will sometimes add tasks to - * the result set which were not actually impacted but this is not a major problem - * since it only means that extra events get sent to the explorer. For updates other - * than resets the number of extra events is very low. - * - * This takes several steps. - * <li> If a group is completed, skipped or reset add any non-started children. - * <li> Determine all successors of tasks whose state has changed that are not in the change set - * <li> Add the successor and its children to the list if not started + * change of state and were not in the original set. The algorithm + * will sometimes add tasks to the result set which were not + * actually impacted but this is not a major problem since it only + * means that extra events get sent to the explorer. For updates + * other than resets the number of extra events is very low. + * <p> + * This takes several steps. + * <ul> + * <li>If a group is completed, skipped or reset add any non-started + * children. + * <li>Determine all successors of tasks whose state has changed + * that are not in the change set + * <li>Add the successor and its children to the list if not started + * </ul> */ - public Set<ICompositeCheatSheetTask> findBlockedTaskChanges(Set<ICompositeCheatSheetTask> stateChangedTasks) { this.stateChangedTasks = stateChangedTasks; impactedTasks = new HashSet<>(); diff --git a/org.eclipse.ui.cheatsheets/src/org/eclipse/ui/internal/cheatsheets/composite/model/TaskDependencies.java b/org.eclipse.ui.cheatsheets/src/org/eclipse/ui/internal/cheatsheets/composite/model/TaskDependencies.java index 91f6c5331..c81320181 100644 --- a/org.eclipse.ui.cheatsheets/src/org/eclipse/ui/internal/cheatsheets/composite/model/TaskDependencies.java +++ b/org.eclipse.ui.cheatsheets/src/org/eclipse/ui/internal/cheatsheets/composite/model/TaskDependencies.java @@ -102,12 +102,14 @@ public class TaskDependencies { /** * Check for circular dependencies using the following algorithm. - * 1. Create a set of all the tasks which have an id (tasks without id cannot be in a cycle).; - * 2. Remove from the set any tasks which depend on no other task, these cannot be part of a cycle - * 3. Remove from the set any tasks which only depend on tasks already removed, these cannot be + * <ol> + * <li>Create a set of all the tasks which have an id (tasks without id cannot be in a cycle).; + * <li>Remove from the set any tasks which depend on no other task, these cannot be part of a cycle + * <li>Remove from the set any tasks which only depend on tasks already removed, these cannot be * part of a cycle. - * 4. Repeat step 3 until not further tasks can be removed - * 5. Any tasks remaining are part of a cycle or depend on a task in a cycle + * <li>Repeat step 3 until not further tasks can be removed + * <li>Any tasks remaining are part of a cycle or depend on a task in a cycle + * </ol> * @param model * @param status */ diff --git a/org.eclipse.ui.cheatsheets/src/org/eclipse/ui/internal/cheatsheets/data/AbstractExecutable.java b/org.eclipse.ui.cheatsheets/src/org/eclipse/ui/internal/cheatsheets/data/AbstractExecutable.java index b2e88675a..ab8e1f806 100644 --- a/org.eclipse.ui.cheatsheets/src/org/eclipse/ui/internal/cheatsheets/data/AbstractExecutable.java +++ b/org.eclipse.ui.cheatsheets/src/org/eclipse/ui/internal/cheatsheets/data/AbstractExecutable.java @@ -91,8 +91,8 @@ public abstract class AbstractExecutable { /** * Indicates this action is to be used if and only if the value of the condition attribute - * of the containing <perform-when> element matches this string value. This attribute is - * ignored if the <action> element is not a child of a <perform-when> element. + * of the containing {@literal <perform-when>} element matches this string value. This attribute is + * ignored if the {@literal <action>} element is not a child of a {@literal <perform-when>} element. * @param when The expression to use when determine if this action should be used. */ public void setWhen(String when) { diff --git a/org.eclipse.ui.cheatsheets/src/org/eclipse/ui/internal/cheatsheets/data/Action.java b/org.eclipse.ui.cheatsheets/src/org/eclipse/ui/internal/cheatsheets/data/Action.java index f18a52cac..53a6e3850 100644 --- a/org.eclipse.ui.cheatsheets/src/org/eclipse/ui/internal/cheatsheets/data/Action.java +++ b/org.eclipse.ui.cheatsheets/src/org/eclipse/ui/internal/cheatsheets/data/Action.java @@ -21,7 +21,7 @@ import org.eclipse.ui.internal.cheatsheets.views.CheatSheetManager; import org.w3c.dom.Node; /** - * Class that represents an <ACTION> element in a cheatsheet. This class stores all + * Class that represents an {@literal <ACTION>} element in a cheatsheet. This class stores all * of the attributes associated with an Action and is capable of executing that Action. */ public class Action extends AbstractExecutable { @@ -54,7 +54,7 @@ public class Action extends AbstractExecutable { /** * This method allows you to specify the class to be run when the perform button is pressed for this * item in the cheat sheet. - * @param classname the class to be run by the item in the cheat sheet + * @param aclass the class to be run by the item in the cheat sheet */ public void setClass(String aclass) { this.actionClass = aclass; diff --git a/org.eclipse.ui.cheatsheets/src/org/eclipse/ui/internal/cheatsheets/data/CheatSheetParser.java b/org.eclipse.ui.cheatsheets/src/org/eclipse/ui/internal/cheatsheets/data/CheatSheetParser.java index 98bd50a71..80a48f308 100644 --- a/org.eclipse.ui.cheatsheets/src/org/eclipse/ui/internal/cheatsheets/data/CheatSheetParser.java +++ b/org.eclipse.ui.cheatsheets/src/org/eclipse/ui/internal/cheatsheets/data/CheatSheetParser.java @@ -105,20 +105,27 @@ public class CheatSheetParser implements IStatusContainer { } /** - * Converts any characters required to escaped by an XML parser to - * their escaped counterpart. + * Converts any characters required to escaped by an XML parser to their + * escaped counterpart. * - * Characters XML escaped counterpart - * < -> < - * > -> > - * & -> & - * ' -> ' - * " -> " + * <pre> + * {@code + * Characters XML escaped counterpart + * < -> < + * > -> > + * & -> & + * ' -> ' + * " -> " + * } + * </pre> + * + * Tags that will be ignored {@literal <b>, </b> and <br/> + * }. * - * Tags that will be ignored <b>, </b> and <br/>. - * - * @param text the string buffer to have its characters escaped - * @return string buffer with any of the characters requiring XML escaping escaped + * @param text + * the string buffer to have its characters escaped + * @return string buffer with any of the characters requiring XML escaping + * escaped */ private StringBuilder escapeXMLCharacters(StringBuilder text) { // Set the maximum length of the tags to ignore diff --git a/org.eclipse.ui.cheatsheets/src/org/eclipse/ui/internal/cheatsheets/data/SubItem.java b/org.eclipse.ui.cheatsheets/src/org/eclipse/ui/internal/cheatsheets/data/SubItem.java index 39d28e4fe..9919825a8 100644 --- a/org.eclipse.ui.cheatsheets/src/org/eclipse/ui/internal/cheatsheets/data/SubItem.java +++ b/org.eclipse.ui.cheatsheets/src/org/eclipse/ui/internal/cheatsheets/data/SubItem.java @@ -84,7 +84,7 @@ public class SubItem extends AbstractSubItem implements IExecutableItem, IPerfor } /** - * @param Executable The Executable to set. + * @param executable The Executable to set. */ @Override public void setExecutable(AbstractExecutable executable) { diff --git a/org.eclipse.ui.cheatsheets/src/org/eclipse/ui/internal/cheatsheets/registry/Category.java b/org.eclipse.ui.cheatsheets/src/org/eclipse/ui/internal/cheatsheets/registry/Category.java index 7093cb936..7d933fd2e 100644 --- a/org.eclipse.ui.cheatsheets/src/org/eclipse/ui/internal/cheatsheets/registry/Category.java +++ b/org.eclipse.ui.cheatsheets/src/org/eclipse/ui/internal/cheatsheets/registry/Category.java @@ -83,9 +83,9 @@ public class Category implements IWorkbenchAdapter, IPluginContribution, * the specified configuration element. * * @param configElement - * the <code>IConfigurationElement<code> containing + * the <code>IConfigurationElement</code> containing * the ID, label, and optional parent category path. - * @throws WorkbenchException if the ID or label is <code>null</code + * @throws WorkbenchException if the ID or label is <code>null</code> */ public Category(IConfigurationElement configElement) throws WorkbenchException { diff --git a/org.eclipse.ui.cheatsheets/src/org/eclipse/ui/internal/cheatsheets/registry/CheatSheetCollectionSorter.java b/org.eclipse.ui.cheatsheets/src/org/eclipse/ui/internal/cheatsheets/registry/CheatSheetCollectionSorter.java index d901c8552..37ba63696 100644 --- a/org.eclipse.ui.cheatsheets/src/org/eclipse/ui/internal/cheatsheets/registry/CheatSheetCollectionSorter.java +++ b/org.eclipse.ui.cheatsheets/src/org/eclipse/ui/internal/cheatsheets/registry/CheatSheetCollectionSorter.java @@ -23,7 +23,7 @@ import com.ibm.icu.text.Collator; /** * A Viewer element sorter that sorts Elements by their name attribute. * Note that capitalization differences are not considered by this - * sorter, so a < B < c. + * sorter, so a < B < c. */ public class CheatSheetCollectionSorter extends ViewerComparator { public final static CheatSheetCollectionSorter INSTANCE = new CheatSheetCollectionSorter(); diff --git a/org.eclipse.ui.cheatsheets/src/org/eclipse/ui/internal/cheatsheets/views/CheatSheetHelpPart.java b/org.eclipse.ui.cheatsheets/src/org/eclipse/ui/internal/cheatsheets/views/CheatSheetHelpPart.java index 0905ff8fe..2d2685d1a 100644 --- a/org.eclipse.ui.cheatsheets/src/org/eclipse/ui/internal/cheatsheets/views/CheatSheetHelpPart.java +++ b/org.eclipse.ui.cheatsheets/src/org/eclipse/ui/internal/cheatsheets/views/CheatSheetHelpPart.java @@ -102,7 +102,7 @@ public class CheatSheetHelpPart extends AbstractFormPart implements IHelpPart { /** * Returns the part's unique identifier. * - * @param the unique id for the part + * @return the unique id for the part */ @Override public String getId() { @@ -145,7 +145,7 @@ public class CheatSheetHelpPart extends AbstractFormPart implements IHelpPart { /** * Sets the visibility of the part. * - * @param whether or not the part should be visible + * @param visible whether or not the part should be visible */ @Override public void setVisible(boolean visible) { diff --git a/org.eclipse.ui.cheatsheets/src/org/eclipse/ui/internal/cheatsheets/views/CheatSheetPage.java b/org.eclipse.ui.cheatsheets/src/org/eclipse/ui/internal/cheatsheets/views/CheatSheetPage.java index cb8b24b32..557e1b901 100644 --- a/org.eclipse.ui.cheatsheets/src/org/eclipse/ui/internal/cheatsheets/views/CheatSheetPage.java +++ b/org.eclipse.ui.cheatsheets/src/org/eclipse/ui/internal/cheatsheets/views/CheatSheetPage.java @@ -105,7 +105,7 @@ public class CheatSheetPage extends Page implements IMenuContributor { } /** - * Creates the cheatsheet's title areawhich will consists of a title and + * Creates the cheatsheet's title area which will consists of a title and * image. * * @param parent diff --git a/org.eclipse.ui.cheatsheets/src/org/eclipse/ui/internal/cheatsheets/views/CheatSheetView.java b/org.eclipse.ui.cheatsheets/src/org/eclipse/ui/internal/cheatsheets/views/CheatSheetView.java index a4c1ade8a..91e7d6ab0 100644 --- a/org.eclipse.ui.cheatsheets/src/org/eclipse/ui/internal/cheatsheets/views/CheatSheetView.java +++ b/org.eclipse.ui.cheatsheets/src/org/eclipse/ui/internal/cheatsheets/views/CheatSheetView.java @@ -78,6 +78,7 @@ public class CheatSheetView extends ViewPart { * </p> * <p> * For implementors this is a multi-step process: + * </p> * <ol> * <li>Create one or more controls within the parent.</li> * <li>Set the parent layout as needed.</li> @@ -86,7 +87,6 @@ public class CheatSheetView extends ViewPart { * <li>Register a selection provider with the <code>ISelectionService</code> * (optional). </li> * </ol> - * </p> * * @param parent the parent control */ diff --git a/org.eclipse.ui.cheatsheets/src/org/eclipse/ui/internal/cheatsheets/views/CheatSheetViewer.java b/org.eclipse.ui.cheatsheets/src/org/eclipse/ui/internal/cheatsheets/views/CheatSheetViewer.java index dcb81953e..2605eca0a 100644 --- a/org.eclipse.ui.cheatsheets/src/org/eclipse/ui/internal/cheatsheets/views/CheatSheetViewer.java +++ b/org.eclipse.ui.cheatsheets/src/org/eclipse/ui/internal/cheatsheets/views/CheatSheetViewer.java @@ -612,6 +612,7 @@ public class CheatSheetViewer implements ICheatSheetViewer, IMenuContributor { * </p> * <p> * For implementors this is a multi-step process: + * </p> * <ol> * <li>Create one or more controls within the parent.</li> * <li>Set the parent layout as needed.</li> @@ -620,7 +621,6 @@ public class CheatSheetViewer implements ICheatSheetViewer, IMenuContributor { * <li>Register a selection provider with the <code>ISelectionService</code> * (optional). </li> * </ol> - * </p> * * @param parent the parent control */ diff --git a/org.eclipse.ui.cheatsheets/src/org/eclipse/ui/internal/cheatsheets/views/ErrorPage.java b/org.eclipse.ui.cheatsheets/src/org/eclipse/ui/internal/cheatsheets/views/ErrorPage.java index 9ab6ca9bf..94669eb48 100644 --- a/org.eclipse.ui.cheatsheets/src/org/eclipse/ui/internal/cheatsheets/views/ErrorPage.java +++ b/org.eclipse.ui.cheatsheets/src/org/eclipse/ui/internal/cheatsheets/views/ErrorPage.java @@ -131,7 +131,7 @@ public class ErrorPage extends Page { } /** - * Creates the cheatsheet's title areawhich will consists + * Creates the cheatsheet's title area which will consists * of a title and image. * * @param parent the SWT parent for the title area composite |