Bug 543933 - Build javadocs with Java 11
Fix javadoc warnings catched by Java 11 tool with XDoclint:html.
Change-Id: I361234cd816bf809e3a66aa5e3fb9a05988356e5
Signed-off-by: Alexander Kurtakov <akurtako@redhat.com>
diff --git a/bundles/org.eclipse.core.databinding/src/org/eclipse/core/databinding/conversion/package.html b/bundles/org.eclipse.core.databinding/src/org/eclipse/core/databinding/conversion/package.html
index ea29d42..07f422e 100644
--- a/bundles/org.eclipse.core.databinding/src/org/eclipse/core/databinding/conversion/package.html
+++ b/bundles/org.eclipse.core.databinding/src/org/eclipse/core/databinding/conversion/package.html
@@ -11,7 +11,7 @@
<h2>
Package Specification</h2>
<p>
-This package provides the <tt>IConverter</tt> interface along with classes
+This package provides the <code>IConverter</code> interface along with classes
that implement the interface to convert between common data types.
</p>
</body>
diff --git a/bundles/org.eclipse.e4.ui.progress/src/org/eclipse/e4/ui/progress/IProgressService.java b/bundles/org.eclipse.e4.ui.progress/src/org/eclipse/e4/ui/progress/IProgressService.java
index d501622..8279f28 100644
--- a/bundles/org.eclipse.e4.ui.progress/src/org/eclipse/e4/ui/progress/IProgressService.java
+++ b/bundles/org.eclipse.e4.ui.progress/src/org/eclipse/e4/ui/progress/IProgressService.java
@@ -35,7 +35,7 @@
* <p>
* This service can be acquired from your service locator:
* </p>
- *
+ *
* <pre>
* IProgressService service = (IProgressService) getSite().getService(IProgressService.class);
* </pre>
@@ -76,36 +76,39 @@
public void registerIconForFamily(ImageDescriptor icon, Object family);
/**
- * Runs the given operation in the UI thread using the given runnable context.
- * The given scheduling rule, if any, will be acquired for the duration of the operation.
- * If the rule is not available when this method is called, a progress dialog will be
- * displayed that gives users control over the background processes that may
- * be blocking the runnable from proceeding.
- * <p>
- * This method can act as a wrapper for uses of <tt>IRunnableContext</tt>
- * where the <tt>fork</tt> parameter was <tt>false</tt>.
- * <p>
- * Note: Running long operations in the UI thread is generally not
- * recommended. This can result in the UI becoming unresponsive for
- * the duration of the operation. Where possible, <tt>busyCursorWhile</tt>
- * should be used instead.
- * </p>
- * <p>
- * Modal dialogs should also be avoided in the runnable as there will already
- * be a modal progress dialog open when this operation runs.
- * </p>
- * @see org.eclipse.jface.dialogs.Dialog
- * @see org.eclipse.swt.SWT#APPLICATION_MODAL
- *
- * @param context The runnable context to run the operation in
- * @param runnable The operation to run
- * @param rule A scheduling rule, or <code>null</code>
- * @throws InvocationTargetException wraps any exception or error which occurs
- * while running the runnable
- * @throws InterruptedException propagated by the context if the runnable
- * acknowledges cancelation by throwing this exception.
- *
- */
+ * Runs the given operation in the UI thread using the given runnable context.
+ * The given scheduling rule, if any, will be acquired for the duration of the
+ * operation. If the rule is not available when this method is called, a
+ * progress dialog will be displayed that gives users control over the
+ * background processes that may be blocking the runnable from proceeding.
+ * <p>
+ * This method can act as a wrapper for uses of <code>IRunnableContext</code>
+ * where the <code>fork</code> parameter was <code>false</code>.
+ * </p>
+ * <p>
+ * Note: Running long operations in the UI thread is generally not recommended.
+ * This can result in the UI becoming unresponsive for the duration of the
+ * operation. Where possible, <code>busyCursorWhile</code> should be used
+ * instead.
+ * </p>
+ * <p>
+ * Modal dialogs should also be avoided in the runnable as there will already be
+ * a modal progress dialog open when this operation runs.
+ * </p>
+ *
+ * @see org.eclipse.jface.dialogs.Dialog
+ * @see org.eclipse.swt.SWT#APPLICATION_MODAL
+ *
+ * @param context The runnable context to run the operation in
+ * @param runnable The operation to run
+ * @param rule A scheduling rule, or <code>null</code>
+ * @throws InvocationTargetException wraps any exception or error which occurs
+ * while running the runnable
+ * @throws InterruptedException propagated by the context if the runnable
+ * acknowledges cancelation by throwing this
+ * exception.
+ *
+ */
public void runInUI(IRunnableContext context,
IRunnableWithProgress runnable, ISchedulingRule rule)
throws InvocationTargetException, InterruptedException;
diff --git a/bundles/org.eclipse.ui.forms/src/org/eclipse/ui/forms/FormColors.java b/bundles/org.eclipse.ui.forms/src/org/eclipse/ui/forms/FormColors.java
index 5dea48c..a99d84e 100644
--- a/bundles/org.eclipse.ui.forms/src/org/eclipse/ui/forms/FormColors.java
+++ b/bundles/org.eclipse.ui.forms/src/org/eclipse/ui/forms/FormColors.java
@@ -59,7 +59,7 @@
/**
* Key for the section title bar background.
*
- * @deprecated use <code>IFormColors.TB_BG
+ * @deprecated use <code>IFormColors.TB_BG</code>
*/
@Deprecated
public static final String TB_BG = IFormColors.TB_BG;
diff --git a/bundles/org.eclipse.ui.forms/src/org/eclipse/ui/forms/widgets/FormText.java b/bundles/org.eclipse.ui.forms/src/org/eclipse/ui/forms/widgets/FormText.java
index e3beb38..bb7b0d2 100644
--- a/bundles/org.eclipse.ui.forms/src/org/eclipse/ui/forms/widgets/FormText.java
+++ b/bundles/org.eclipse.ui.forms/src/org/eclipse/ui/forms/widgets/FormText.java
@@ -519,13 +519,11 @@
}
/**
- * If paragraphs are separated, spacing will be added between them.
- * Otherwise, new paragraphs will simply start on a new line with no
- * spacing.
+ * If paragraphs are separated, spacing will be added between them. Otherwise,
+ * new paragraphs will simply start on a new line with no spacing.
*
- * @param value
- * <samp>true </samp> if paragraphs are separated, </samp> false
- * </samp> otherwise.
+ * @param value <code>true</code> if paragraphs are separated, <code>false
+ * </code> otherwise.
*/
public void setParagraphsSeparated(boolean value) {
paragraphsSeparated = value;
@@ -848,23 +846,23 @@
}
/**
- * Controls whether whitespace inside paragraph and list items is
- * normalized. Note that the new value will not affect the current text in
- * the control, only subsequent calls to <code>setText</code> or
- * <code>setContents</code>.
+ * Controls whether whitespace inside paragraph and list items is normalized.
+ * Note that the new value will not affect the current text in the control, only
+ * subsequent calls to <code>setText</code> or <code>setContents</code>.
* <p>
* If normalized:
+ * </p>
* <ul>
* <li>all white space characters will be condensed into at most one when
* between words.</li>
- * <li>new line characters will be ignored and replaced with one white
- * space character</li>
- * <li>white space characters after the opening tags and before the closing
- * tags will be trimmed</li>
+ * <li>new line characters will be ignored and replaced with one white space
+ * character</li>
+ * <li>white space characters after the opening tags and before the closing tags
+ * will be trimmed</li>
+ * </ul>
*
- * @param value
- * <code>true</code> if whitespace is normalized,
- * <code>false</code> otherwise.
+ * @param value <code>true</code> if whitespace is normalized,
+ * <code>false</code> otherwise.
*/
public void setWhitespaceNormalized(boolean value) {
model.setWhitespaceNormalized(value);
diff --git a/bundles/org.eclipse.ui.ide/extensions/org/eclipse/ui/IResourceActionFilter.java b/bundles/org.eclipse.ui.ide/extensions/org/eclipse/ui/IResourceActionFilter.java
index b62bcfb..5d6c19f 100644
--- a/bundles/org.eclipse.ui.ide/extensions/org/eclipse/ui/IResourceActionFilter.java
+++ b/bundles/org.eclipse.ui.ide/extensions/org/eclipse/ui/IResourceActionFilter.java
@@ -59,39 +59,43 @@
public static final String PROJECT_NATURE = "projectNature"; //$NON-NLS-1$
/**
- * An attribute indicating a persistent property on the selected resource
- * (value <code>"persistentProperty"</code>).
- * If the value is a simple string, then this simply tests for existence of the property on the resource.
- * If it has the format <code>"propertyName=propertyValue" this obtains the value of the property
- * with the specified name and tests it for equality with the specified value.
- */
+ * An attribute indicating a persistent property on the selected resource (value
+ * <code>"persistentProperty"</code>). If the value is a simple string, then
+ * this simply tests for existence of the property on the resource. If it has
+ * the format <code>"propertyName=propertyValue"</code> this obtains the value
+ * of the property with the specified name and tests it for equality with the
+ * specified value.
+ */
public static final String PERSISTENT_PROPERTY = "persistentProperty"; //$NON-NLS-1$
/**
- * An attribute indicating a persistent property on the selected resource's project.
- * (value <code>"projectPersistentProperty"</code>).
- * If the value is a simple string, then this simply tests for existence of the property on the resource.
- * If it has the format <code>"propertyName=propertyValue" this obtains the value of the property
- * with the specified name and tests it for equality with the specified value.
- */
+ * An attribute indicating a persistent property on the selected resource's
+ * project. (value <code>"projectPersistentProperty"</code>). If the value is a
+ * simple string, then this simply tests for existence of the property on the
+ * resource. If it has the format <code>"propertyName=propertyValue"</code> this
+ * obtains the value of the property with the specified name and tests it for
+ * equality with the specified value.
+ */
public static final String PROJECT_PERSISTENT_PROPERTY = "projectPersistentProperty"; //$NON-NLS-1$
/**
- * An attribute indicating a session property on the selected resource
- * (value <code>"sessionProperty"</code>).
- * If the value is a simple string, then this simply tests for existence of the property on the resource.
- * If it has the format <code>"propertyName=propertyValue" this obtains the value of the property
- * with the specified name and tests it for equality with the specified value.
- */
+ * An attribute indicating a session property on the selected resource (value
+ * <code>"sessionProperty"</code>). If the value is a simple string, then this
+ * simply tests for existence of the property on the resource. If it has the
+ * format <code>"propertyName=propertyValue"</code> this obtains the value of
+ * the property with the specified name and tests it for equality with the
+ * specified value.
+ */
public static final String SESSION_PROPERTY = "sessionProperty"; //$NON-NLS-1$
/**
- * An attribute indicating a session property on the selected resource's project.
- * (value <code>"projectSessionProperty"</code>).
- * If the value is a simple string, then this simply tests for existence of the property on the resource.
- * If it has the format <code>"propertyName=propertyValue" this obtains the value of the property
- * with the specified name and tests it for equality with the specified value.
- */
+ * An attribute indicating a session property on the selected resource's
+ * project. (value <code>"projectSessionProperty"</code>). If the value is a
+ * simple string, then this simply tests for existence of the property on the
+ * resource. If it has the format <code>"propertyName=propertyValue"</code> this
+ * obtains the value of the property with the specified name and tests it for
+ * equality with the specified value.
+ */
public static final String PROJECT_SESSION_PROPERTY = "projectSessionProperty"; //$NON-NLS-1$
/**
diff --git a/bundles/org.eclipse.ui.ide/extensions/org/eclipse/ui/dialogs/WizardResourceImportPage.java b/bundles/org.eclipse.ui.ide/extensions/org/eclipse/ui/dialogs/WizardResourceImportPage.java
index 8f54763..45326f0 100644
--- a/bundles/org.eclipse.ui.ide/extensions/org/eclipse/ui/dialogs/WizardResourceImportPage.java
+++ b/bundles/org.eclipse.ui.ide/extensions/org/eclipse/ui/dialogs/WizardResourceImportPage.java
@@ -334,11 +334,11 @@
}
/**
- * <bold>DO NOT USE THIS METHOD</bold>
- * Returns this page's list of currently-specified resources to be
- * imported filtered by the IElementFilter.
- * @deprecated Should use the API {@link IElementFilter}
- */
+ * <b>DO NOT USE THIS METHOD</b> Returns this page's list of currently-specified
+ * resources to be imported filtered by the IElementFilter.
+ *
+ * @deprecated Should use the API {@link IElementFilter}
+ */
@Deprecated
protected void getSelectedResources(org.eclipse.ui.internal.ide.dialogs.IElementFilter filter, IProgressMonitor monitor) throws InterruptedException {
this.selectionGroup.getAllCheckedListItems(filter, monitor);
diff --git a/bundles/org.eclipse.ui.ide/src/org/eclipse/ui/ide/IDE.java b/bundles/org.eclipse.ui.ide/src/org/eclipse/ui/ide/IDE.java
index 14bb26a..d8607ab 100644
--- a/bundles/org.eclipse.ui.ide/src/org/eclipse/ui/ide/IDE.java
+++ b/bundles/org.eclipse.ui.ide/src/org/eclipse/ui/ide/IDE.java
@@ -95,12 +95,14 @@
*/
public final class IDE {
/**
- * The persistent property key used on IFile resources to contain the
- * preferred editor ID to use.
+ * The persistent property key used on IFile resources to contain the preferred
+ * editor ID to use.
* <p>
* Example of retrieving the persisted editor id:
+ * </p>
*
- * <pre><code>
+ * <pre>
+ * <code>
* IFile file = ...
* IEditorDescriptor editorDesc = null;
* try {
@@ -111,22 +113,24 @@
* } catch (CoreException e) {
* // handle problem accessing persistent property here
* }
- * </code></pre>
+ * </code>
+ * </pre>
*
- * </p>
* <p>
* Example of persisting the editor id:
+ * </p>
*
- * <pre><code>
+ * <pre>
+ * <code>
* IFile file = ...
* try {
* file.setPersistentProperty(EDITOR_KEY, editorDesc.getId());
* } catch (CoreException e) {
* // handle problem setting persistent property here
* }
- * </code></pre>
+ * </code>
+ * </pre>
*
- * </p>
*/
public static final QualifiedName EDITOR_KEY = new QualifiedName(
"org.eclipse.ui.internal.registry.ResourceEditorRegistry", "EditorProperty");//$NON-NLS-2$//$NON-NLS-1$
@@ -690,7 +694,6 @@
* <li>The workbench editor registry is consulted to determine if the
* default text editor is available.</li>
* </ol>
- * </p>
*
* @param file
* the file
@@ -729,7 +732,6 @@
* <li>The workbench editor registry is consulted to determine if the
* default text editor is available.</li>
* </ol>
- * </p>
*
* @param file
* the file
@@ -756,47 +758,43 @@
}
/**
- * Returns an editor descriptor appropriate for opening the given file
- * resource.
+ * Returns an editor descriptor appropriate for opening the given file resource.
* <p>
- * The editor descriptor is determined using a multi-step process. This
- * method will attempt to resolve the editor based on content-type bindings
- * as well as traditional name/extension bindings if
- * <code>determineContentType</code>is <code>true</code>.
+ * The editor descriptor is determined using a multi-step process. This method
+ * will attempt to resolve the editor based on content-type bindings as well as
+ * traditional name/extension bindings if <code>determineContentType</code>is
+ * <code>true</code>.
* </p>
* <ol>
- * <li>The <code>IResource</code> is consulted for a persistent property
- * named <code>IDE.EDITOR_KEY</code> containing the preferred editor id to
- * be used.</li>
+ * <li>The <code>IResource</code> is consulted for a persistent property named
+ * <code>IDE.EDITOR_KEY</code> containing the preferred editor id to be
+ * used.</li>
* <li>The workbench editor registry is consulted to determine if an editor
- * extension has been registered for the file type. If so, an instance of
- * the editor extension is opened on the file. See
+ * extension has been registered for the file type. If so, an instance of the
+ * editor extension is opened on the file. See
* <code>IEditorRegistry.getDefaultEditor(String)</code>.</li>
* <li>The preferred {@link IUnassociatedEditorStrategy} is consulted.</li>
- * <li>The {@link SystemEditorOrTextEditorStrategy} is consulted, whose
- * behavior is
+ * <li>The {@link SystemEditorOrTextEditorStrategy} is consulted, whose behavior
+ * is
* <ol>
- * <li>The operating system is consulted to determine if an in-place
- * component editor is available (e.g. OLE editor on Win32 platforms).</li>
- * <li>The operating system is consulted to determine if an external editor
- * is available.</li>
- * <li>The workbench editor registry is consulted to determine if the
- * default text editor is available.</li></li>
+ * <li>The operating system is consulted to determine if an in-place component
+ * editor is available (e.g. OLE editor on Win32 platforms).</li>
+ * <li>The operating system is consulted to determine if an external editor is
+ * available.</li>
+ * <li>The workbench editor registry is consulted to determine if the default
+ * text editor is available.</li>
* </ol>
+ * </li>
* </ol>
- * </p>
*
- * @param file
- * the file
- * @param determineContentType
- * query the content type system for the content type of the file
- * @param allowInteractive
- * whether we allow user interactions
+ * @param file the file
+ * @param determineContentType query the content type system for the content
+ * type of the file
+ * @param allowInteractive whether we allow user interactions
* @return an editor descriptor, appropriate for opening the file
- * @throws PartInitException
- * if no editor can be found
- * @throws OperationCanceledException
- * in case descriptor lookup was canceled by the user
+ * @throws PartInitException if no editor can be found
+ * @throws OperationCanceledException in case descriptor lookup was canceled by
+ * the user
* @since 3.12
*/
public static IEditorDescriptor getEditorDescriptor(IFile file, boolean determineContentType, boolean allowInteractive)
@@ -1001,7 +999,6 @@
* <li>The workbench editor registry is consulted to determine if the
* default text editor is available.</li>
* </ol>
- * </p>
*
* @param name
* the file name
@@ -1039,7 +1036,6 @@
* <li>The workbench editor registry is consulted to determine if the
* default text editor is available.</li>
* </ol>
- * </p>
*
* @param name
* the file name
@@ -1073,44 +1069,40 @@
}
/**
- * Returns an editor descriptor appropriate for opening a file resource with
- * the given name.
+ * Returns an editor descriptor appropriate for opening a file resource with the
+ * given name.
* <p>
- * The editor descriptor is determined using a multi-step process. This
- * method will attempt to infer the content type of the file if
+ * The editor descriptor is determined using a multi-step process. This method
+ * will attempt to infer the content type of the file if
* <code>inferContentType</code> is <code>true</code>.
* </p>
* <ol>
* <li>The workbench editor registry is consulted to determine if an editor
- * extension has been registered for the file type. If so, an instance of
- * the editor extension is opened on the file. See
+ * extension has been registered for the file type. If so, an instance of the
+ * editor extension is opened on the file. See
* <code>IEditorRegistry.getDefaultEditor(String)</code>.</li>
* <li>The preferred {@link IUnassociatedEditorStrategy} is consulted.</li>
- * <li>The {@link SystemEditorOrTextEditorStrategy} is consulted, whose
- * behavior is
+ * <li>The {@link SystemEditorOrTextEditorStrategy} is consulted, whose behavior
+ * is
* <ol>
- * <li>The operating system is consulted to determine if an in-place
- * component editor is available (e.g. OLE editor on Win32 platforms).</li>
- * <li>The operating system is consulted to determine if an external editor
- * is available.</li>
- * <li>The workbench editor registry is consulted to determine if the
- * default text editor is available.</li></li>
+ * <li>The operating system is consulted to determine if an in-place component
+ * editor is available (e.g. OLE editor on Win32 platforms).</li>
+ * <li>The operating system is consulted to determine if an external editor is
+ * available.</li>
+ * <li>The workbench editor registry is consulted to determine if the default
+ * text editor is available.</li>
* </ol>
+ * </li>
* </ol>
- * </p>
*
- * @param name
- * the file name
- * @param inferContentType
- * attempt to infer the content type from the file name if this
- * is <code>true</code>
- * @param allowInteractive
- * whether we allow user interactions.
+ * @param name the file name
+ * @param inferContentType attempt to infer the content type from the file name
+ * if this is <code>true</code>
+ * @param allowInteractive whether we allow user interactions.
* @return an editor descriptor, appropriate for opening the file
- * @throws PartInitException
- * if no editor can be found
- * @throws OperationCanceledException
- * in case descriptor lookup was canceled by the user
+ * @throws PartInitException if no editor can be found
+ * @throws OperationCanceledException in case descriptor lookup was canceled by
+ * the user
* @since 3.12
*/
public static IEditorDescriptor getEditorDescriptor(String name, boolean inferContentType, boolean allowInteractive)
diff --git a/bundles/org.eclipse.ui.ide/src/org/eclipse/ui/views/markers/MarkerField.java b/bundles/org.eclipse.ui.ide/src/org/eclipse/ui/views/markers/MarkerField.java
index 84d4044..a22af17 100644
--- a/bundles/org.eclipse.ui.ide/src/org/eclipse/ui/views/markers/MarkerField.java
+++ b/bundles/org.eclipse.ui.ide/src/org/eclipse/ui/views/markers/MarkerField.java
@@ -105,12 +105,14 @@
* @param item1
* @param item2
* @return Either:
- * <li>a negative number if the value of item1 is less than the
- * value of item2 for this field.
- * <li><code>0</code> if the value of item1 and the value of
- * item2 are equal for this field.
- * <li>a positive number if the value of item1 is greater than the
- * value of item2 for this field.
+ * <ul>
+ * <li>a negative number if the value of item1 is less than the value of
+ * item2 for this field.</li>
+ * <li><code>0</code> if the value of item1 and the value of item2 are
+ * equal for this field.</li>
+ * <li>a positive number if the value of item1 is greater than the value
+ * of item2 for this field.</li>
+ * </ul>
*/
public int compare(MarkerItem item1, MarkerItem item2) {
return getValue(item1).compareTo(getValue(item2));
diff --git a/bundles/org.eclipse.ui.navigator/src/org/eclipse/ui/navigator/CommonViewer.java b/bundles/org.eclipse.ui.navigator/src/org/eclipse/ui/navigator/CommonViewer.java
index 8746a45..d15c525 100644
--- a/bundles/org.eclipse.ui.navigator/src/org/eclipse/ui/navigator/CommonViewer.java
+++ b/bundles/org.eclipse.ui.navigator/src/org/eclipse/ui/navigator/CommonViewer.java
@@ -153,16 +153,16 @@
/**
* <p>
- * Adds DND support to the Navigator. Uses hooks into the extensible
- * framework for DND.
+ * Adds DND support to the Navigator. Uses hooks into the extensible framework
+ * for DND.
* </p>
* <p>
* By default, the following Transfer types are supported:
+ * </p>
* <ul>
* <li>LocalSelectionTransfer.getInstance(),
* <li>PluginTransfer.getInstance()
* </ul>
- * </p>
*
* @see CommonDragAdapter
* @see CommonDropAdapter
diff --git a/bundles/org.eclipse.ui.navigator/src/org/eclipse/ui/navigator/ICommonMenuConstants.java b/bundles/org.eclipse.ui.navigator/src/org/eclipse/ui/navigator/ICommonMenuConstants.java
index cfecb49..e2e3376 100644
--- a/bundles/org.eclipse.ui.navigator/src/org/eclipse/ui/navigator/ICommonMenuConstants.java
+++ b/bundles/org.eclipse.ui.navigator/src/org/eclipse/ui/navigator/ICommonMenuConstants.java
@@ -41,11 +41,11 @@
* <code>"group.goto"</code>).
* <p>
* Examples for open actions are:
+ * </p>
* <ul>
* <li>Go Into</li>
* <li>Go To</li>
* </ul>
- * </p>
*/
String GROUP_GOTO = "group.goto"; //$NON-NLS-1$
@@ -54,24 +54,23 @@
* <code>"group.show"</code>).
* <p>
* Examples for show actions are:
+ * </p>
* <ul>
* <li>Show in Navigator</li>
* <li>Show in Type Hierarchy</li>
* </ul>
- * </p>
*/
String GROUP_SHOW = "group.show"; //$NON-NLS-1$
/**
- * Pop-up menu: name of group for new actions (value
- * <code>"group.new"</code>).
+ * Pop-up menu: name of group for new actions (value <code>"group.new"</code>).
* <p>
* Examples for new actions are:
+ * </p>
* <ul>
* <li>Create new class</li>
* <li>Create new interface</li>
* </ul>
- * </p>
*/
String GROUP_NEW = "group.new"; //$NON-NLS-1$
@@ -80,11 +79,11 @@
* <code>"group.open"</code>).
* <p>
* Examples for open actions are:
+ * </p>
* <ul>
* <li>Open To</li>
* <li>Open With</li>
* </ul>
- * </p>
*
* @see #GROUP_OPEN_WITH
*/
@@ -95,10 +94,10 @@
* <code>"group.openWith"</code>).
* <p>
* Examples for open actions are:
+ * </p>
* <ul>
* <li>Open With</li>
* </ul>
- * </p>
*/
String GROUP_OPEN_WITH = "group.openWith"; //$NON-NLS-1$
@@ -107,11 +106,11 @@
* <code>"group.port"</code>).
* <p>
* Examples for open actions are:
+ * </p>
* <ul>
* <li>Import</li>
* <li>Export</li>
* </ul>
- * </p>
*/
String GROUP_PORT = "group.port";//$NON-NLS-1$
diff --git a/bundles/org.eclipse.ui.navigator/src/org/eclipse/ui/navigator/NavigatorActionService.java b/bundles/org.eclipse.ui.navigator/src/org/eclipse/ui/navigator/NavigatorActionService.java
index 4ba1c2c..1ba41e8 100644
--- a/bundles/org.eclipse.ui.navigator/src/org/eclipse/ui/navigator/NavigatorActionService.java
+++ b/bundles/org.eclipse.ui.navigator/src/org/eclipse/ui/navigator/NavigatorActionService.java
@@ -121,20 +121,20 @@
}
/**
- * Prepares the menu for object contributions, if the option is set in the extension. The option
- * is controlled by the &lgt;popupMenu /> element's 'allowPlatformContributions' attribute.
- * Clients may choose to ignore this setting by supplying a value of <b>true</b> for the
+ * Prepares the menu for object contributions, if the option is set in the
+ * extension. The option is controlled by the <code><popupMenu /></code>
+ * element's 'allowPlatformContributions' attribute. Clients may choose to
+ * ignore this setting by supplying a value of <b>true</b> for the
* <code>force</code> attribute.
*
- * @param menu
- * The context menu of the IViewPart
- * @param aSelectionProvider
- * The selection provider that will supplement actions with a valid, current
- * selection.
- * @param force
- * A value of 'true' forces the menu to be registered for object/view contributions.
- * Otherwise, the option from the extension point will be respected. See
- * <b>org.eclipse.ui.navigator.viewer/viewer</b> for more information.
+ * @param menu The context menu of the IViewPart
+ * @param aSelectionProvider The selection provider that will supplement actions
+ * with a valid, current selection.
+ * @param force A value of 'true' forces the menu to be registered
+ * for object/view contributions. Otherwise, the
+ * option from the extension point will be respected.
+ * See <b>org.eclipse.ui.navigator.viewer/viewer</b>
+ * for more information.
*/
public void prepareMenuForPlatformContributions(MenuManager menu, ISelectionProvider aSelectionProvider, boolean force) {
Assert.isTrue(!disposed);
diff --git a/bundles/org.eclipse.ui.views/src/org/eclipse/ui/views/properties/IPropertyDescriptor.java b/bundles/org.eclipse.ui.views/src/org/eclipse/ui/views/properties/IPropertyDescriptor.java
index 774dc5a..1fff0e7 100644
--- a/bundles/org.eclipse.ui.views/src/org/eclipse/ui/views/properties/IPropertyDescriptor.java
+++ b/bundles/org.eclipse.ui.views/src/org/eclipse/ui/views/properties/IPropertyDescriptor.java
@@ -130,12 +130,12 @@
public Object getId();
/**
- * Returns the label provider for this property. The label provider is used
- * to obtain the text (and possible image) for displaying the <it>value</it>
- * of this property.
- *
- * @return the label provider used to display this property
- */
+ * Returns the label provider for this property. The label provider is used to
+ * obtain the text (and possible image) for displaying the <i>value</i> of this
+ * property.
+ *
+ * @return the label provider used to display this property
+ */
public ILabelProvider getLabelProvider();
/**
diff --git a/bundles/org.eclipse.ui.views/src/org/eclipse/ui/views/properties/PropertyDescriptor.java b/bundles/org.eclipse.ui.views/src/org/eclipse/ui/views/properties/PropertyDescriptor.java
index 183481b..7b2ce8a 100644
--- a/bundles/org.eclipse.ui.views/src/org/eclipse/ui/views/properties/PropertyDescriptor.java
+++ b/bundles/org.eclipse.ui.views/src/org/eclipse/ui/views/properties/PropertyDescriptor.java
@@ -334,7 +334,6 @@
*
* NOTE: Help support system API's changed since 2.0 and arrays
* of contexts are no longer supported.
- * </p>
* <p>
* Thus the only valid parameter type for this method
* is a <code>String</code> representing a context id.
diff --git a/bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/IEditorRegistry.java b/bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/IEditorRegistry.java
index 0178e91..b7a7443 100644
--- a/bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/IEditorRegistry.java
+++ b/bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/IEditorRegistry.java
@@ -71,18 +71,18 @@
String SYSTEM_INPLACE_EDITOR_ID = "org.eclipse.ui.systemInPlaceEditor"; //$NON-NLS-1$
/**
- * Adds a listener for changes to properties of this registry.
- * Has no effect if an identical listener is already registered.
- * <p>
- * The properties ids are as follows:
- * <ul>
- * <li><code>PROP_CONTENTS</code>: Triggered when the file editor mappings in
- * the editor registry change.</li>
- * </ul>
- * </p>
- *
- * @param listener a property listener
- */
+ * Adds a listener for changes to properties of this registry. Has no effect if
+ * an identical listener is already registered.
+ * <p>
+ * The properties ids are as follows:
+ * </p>
+ * <ul>
+ * <li><code>PROP_CONTENTS</code>: Triggered when the file editor mappings in
+ * the editor registry change.</li>
+ * </ul>
+ *
+ * @param listener a property listener
+ */
void addPropertyListener(IPropertyListener listener);
/**
diff --git a/bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/IElementFactory.java b/bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/IElementFactory.java
index 8149306..09f7cc0 100644
--- a/bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/IElementFactory.java
+++ b/bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/IElementFactory.java
@@ -40,16 +40,17 @@
* memento.
* <p>
* If the result is not null, it should be persistable; that is,
+ * </p>
+ *
* <pre>
* result.getAdapter(org.eclipse.ui.IPersistableElement.class)
* </pre>
+ * <p>
* should not return <code>null</code>.
* </p>
*
- * @param memento
- * a memento containing the state for the object
- * @return an object, or <code>null</code> if the element could not be
- * created
+ * @param memento a memento containing the state for the object
+ * @return an object, or <code>null</code> if the element could not be created
*/
IAdaptable createElement(IMemento memento);
}
diff --git a/bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/IFileEditorMapping.java b/bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/IFileEditorMapping.java
index b66401f..8fdb870 100644
--- a/bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/IFileEditorMapping.java
+++ b/bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/IFileEditorMapping.java
@@ -76,11 +76,11 @@
ImageDescriptor getImageDescriptor();
/**
- * Returns the label to use for this mapping.
- * Labels have the form "<it>name</it>.<it>extension</it>".
- *
- * @return the label to use for this mapping
- */
+ * Returns the label to use for this mapping. Labels have the form
+ * "<i>name.extension</i>".
+ *
+ * @return the label to use for this mapping
+ */
String getLabel();
/**
diff --git a/bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/ISizeProvider.java b/bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/ISizeProvider.java
index 3807fe9..ac28f87 100644
--- a/bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/ISizeProvider.java
+++ b/bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/ISizeProvider.java
@@ -69,19 +69,19 @@
/**
* <p>
- * Returns the best size for this part, given the available width and height
- * and the workbench's preferred size for the part. Parts can overload this
- * to enforce a minimum size, maximum size, or a quantized set of preferred
- * sizes. If width == true, this method computes a width in pixels. If width
- * == false, this method computes a height. availableParallel and
- * availablePerpendicular contain the space available, and preferredParallel
- * contains the preferred result.
+ * Returns the best size for this part, given the available width and height and
+ * the workbench's preferred size for the part. Parts can overload this to
+ * enforce a minimum size, maximum size, or a quantized set of preferred sizes.
+ * If width == true, this method computes a width in pixels. If width == false,
+ * this method computes a height. availableParallel and availablePerpendicular
+ * contain the space available, and preferredParallel contains the preferred
+ * result.
* </p>
*
* <p>
- * This method returns an answer that is less than or equal to
- * availableParallel and as close to preferredParallel as possible. Return
- * values larger than availableParallel will be truncated.
+ * This method returns an answer that is less than or equal to availableParallel
+ * and as close to preferredParallel as possible. Return values larger than
+ * availableParallel will be truncated.
* </p>
*
* <p>
@@ -90,23 +90,27 @@
* </p>
*
* <p>
- * The getSizeFlags method controls how frequently this method will be
- * called and what information will be available when it is. Any subclass
- * that specializes this method should also specialize getSizeFlags.
- * computePreferredSize(width, INFINITE, someSize, 0) returns the minimum
- * size of the control (if any). computePreferredSize(width, INFINITE,
- * someSize, INFINITE) returns the maximum size of the control.
+ * The getSizeFlags method controls how frequently this method will be called
+ * and what information will be available when it is. Any subclass that
+ * specializes this method should also specialize getSizeFlags.
+ * computePreferredSize(width, INFINITE, someSize, 0) returns the minimum size
+ * of the control (if any). computePreferredSize(width, INFINITE, someSize,
+ * INFINITE) returns the maximum size of the control.
* </p>
*
* <p>
* Examples:
+ * </p>
* <ul>
* <li>To maintain a constant size of 100x300 pixels: {return width ? 100 :
* 300}, getSizeFlags(boolean) must return SWT.MIN | SWT.MAX</li>
* <li>To grow without constraints: {return preferredResult;},
* getSizeFlags(boolean) must return 0.</li>
- * <li>To enforce a width that is always a multiple of 100 pixels, to a
- * minimum of 100 pixels: <code>
+ * <li>To enforce a width that is always a multiple of 100 pixels, to a minimum
+ * of 100 pixels:
+ *
+ * <pre>
+ * <code>
* {
* if (width && preferredResult != INFINITE) {
* int result = preferredResult - ((preferredResult + 50) % 100) + 50;
@@ -116,38 +120,41 @@
* }
* return preferredResult;
* }
- * </code> In this case, getSizeFlags(boolean width) must return (width ?
- * SWT.FILL | SWT.MIN: 0)
- * </ul>
+ * </code>
+ * </pre>
+ *
+ * In this case, getSizeFlags(boolean width) must return (width ? SWT.FILL |
+ * SWT.MIN: 0)</li>
* <li>To maintain a minimum area of 100000 pixels: <code>
* {return availablePerpendicular < 100 ? 1000 : 100000 / availablePerpendicular;}
* </code> getSizeFlags(boolean width) must return SWT.WRAP | SWT.MIN;</li>
- * </p>
+ * </ul>
*
- * @param width
- * indicates whether a width (if <code>true</code>) or a height
- * (if <code>false</code>) is being computed
- * @param availableParallel
- * available space. This is a width (pixels) if width == true,
- * and a height (pixels) if width == false. A return value larger
- * than this will be ignored.
- * @param availablePerpendicular
- * available space perpendicular to the direction being measured
- * or INFINITE if unbounded (pixels). This is a height if width
- * == true, or a height if width == false. Implementations will
- * generally ignore this argument unless they contain wrapping
- * widgets. Note this argument will only contain meaningful
- * information if the part returns the SWT.WRAP flag from
- * getSizeFlags(width)
- * @param preferredResult
- * preferred size of the control (pixels, <= availableParallel).
- * Set to INFINITE if unknown or unbounded.
- * @return returns the preferred size of the control (pixels). This is a
- * width if width == true or a height if width == false. Callers are
- * responsible for rounding down the return value if it is larger
- * than availableParallel. If availableParallel is INFINITE, then a
- * return value of INFINITE is permitted, indicating that the
- * preferred size of the control is unbounded.
+ * @param width indicates whether a width (if
+ * <code>true</code>) or a height (if
+ * <code>false</code>) is being computed
+ * @param availableParallel available space. This is a width (pixels) if
+ * width == true, and a height (pixels) if width
+ * == false. A return value larger than this will
+ * be ignored.
+ * @param availablePerpendicular available space perpendicular to the direction
+ * being measured or INFINITE if unbounded
+ * (pixels). This is a height if width == true, or
+ * a height if width == false. Implementations
+ * will generally ignore this argument unless they
+ * contain wrapping widgets. Note this argument
+ * will only contain meaningful information if the
+ * part returns the SWT.WRAP flag from
+ * getSizeFlags(width)
+ * @param preferredResult preferred size of the control (pixels, <=
+ * availableParallel). Set to INFINITE if unknown
+ * or unbounded.
+ * @return returns the preferred size of the control (pixels). This is a width
+ * if width == true or a height if width == false. Callers are
+ * responsible for rounding down the return value if it is larger than
+ * availableParallel. If availableParallel is INFINITE, then a return
+ * value of INFINITE is permitted, indicating that the preferred size of
+ * the control is unbounded.
*
* @see ISizeProvider#getSizeFlags(boolean)
*/
diff --git a/bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/IStartup.java b/bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/IStartup.java
index 5f1a67c..f4d768b 100644
--- a/bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/IStartup.java
+++ b/bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/IStartup.java
@@ -23,28 +23,29 @@
*/
public interface IStartup {
/**
- * Will be called in a separate thread after the workbench initializes.
- * <p>
- * Note that most workbench methods must be called in the UI thread
- * since they may access SWT. For example, to obtain the current workbench
- * window, use:
- * <code>
- * <pre>
- * final IWorkbench workbench = PlatformUI.getWorkbench();
- * workbench.getDisplay().asyncExec(new Runnable() {
- * public void run() {
- * IWorkbenchWindow window = workbench.getActiveWorkbenchWindow();
- * if (window != null) {
- * // do something
- * }
- * }
- * });
- * </pre>
- * </code>
- * </p>
- * @see org.eclipse.swt.widgets.Display#asyncExec
- * @see org.eclipse.swt.widgets.Display#syncExec
- */
+ * Will be called in a separate thread after the workbench initializes.
+ * <p>
+ * Note that most workbench methods must be called in the UI thread since they
+ * may access SWT. For example, to obtain the current workbench window, use:
+ * </p>
+ *
+ * <pre>
+ * <code>
+ * final IWorkbench workbench = PlatformUI.getWorkbench();
+ * workbench.getDisplay().asyncExec(new Runnable() {
+ * public void run() {
+ * IWorkbenchWindow window = workbench.getActiveWorkbenchWindow();
+ * if (window != null) {
+ * // do something
+ * }
+ * }
+ * });
+ * </code>
+ * </pre>
+ *
+ * @see org.eclipse.swt.widgets.Display#asyncExec
+ * @see org.eclipse.swt.widgets.Display#syncExec
+ */
void earlyStartup();
}
diff --git a/bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/IWorkbench.java b/bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/IWorkbench.java
index 5fcc708..f3208e2 100644
--- a/bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/IWorkbench.java
+++ b/bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/IWorkbench.java
@@ -358,40 +358,34 @@
/**
* Shows the specified perspective to the user. The caller should use this
- * method when the perspective to be shown is not dependent on the page's
- * input. That is, the perspective can open in any page depending on user
- * preferences.
+ * method when the perspective to be shown is not dependent on the page's input.
+ * That is, the perspective can open in any page depending on user preferences.
* <p>
* The perspective may be shown in the specified window, in another existing
- * window, or in a new window depending on user preferences. The exact
- * policy is controlled by the workbench to ensure consistency to the user.
- * The policy is subject to change. The current policy is as follows:
+ * window, or in a new window depending on user preferences. The exact policy is
+ * controlled by the workbench to ensure consistency to the user. The policy is
+ * subject to change. The current policy is as follows:
+ * </p>
* <ul>
* <li>If the specified window has the requested perspective open, then the
* window is given focus and the perspective is shown. The page's input is
* ignored.</li>
- * <li>If another window that has the workspace root as input and the
- * requested perspective open and active, then the window is given focus.
- * </li>
- * <li>Otherwise the requested perspective is opened and shown in the
- * specified window or in a new window depending on the current user
- * preference for opening perspectives, and that window is given focus.
- * </li>
+ * <li>If another window that has the workspace root as input and the requested
+ * perspective open and active, then the window is given focus.</li>
+ * <li>Otherwise the requested perspective is opened and shown in the specified
+ * window or in a new window depending on the current user preference for
+ * opening perspectives, and that window is given focus.</li>
* </ul>
- * </p>
* <p>
- * The workbench also defines a number of menu items to activate or open
- * each registered perspective. A complete list of these perspectives is
- * available from the perspective registry found on <code>IWorkbench</code>.
+ * The workbench also defines a number of menu items to activate or open each
+ * registered perspective. A complete list of these perspectives is available
+ * from the perspective registry found on <code>IWorkbench</code>.
* </p>
*
- * @param perspectiveId
- * the perspective ID to show
- * @param window
- * the workbench window of the action calling this method.
+ * @param perspectiveId the perspective ID to show
+ * @param window the workbench window of the action calling this method.
* @return the workbench page that the perspective was shown
- * @exception WorkbenchException
- * if the perspective could not be shown
+ * @exception WorkbenchException if the perspective could not be shown
*
* @since 2.0
*/
@@ -401,43 +395,39 @@
/**
* Shows the specified perspective to the user. The caller should use this
* method when the perspective to be shown is dependent on the page's input.
- * That is, the perspective can only open in any page with the specified
- * input.
+ * That is, the perspective can only open in any page with the specified input.
* <p>
* The perspective may be shown in the specified window, in another existing
- * window, or in a new window depending on user preferences. The exact
- * policy is controlled by the workbench to ensure consistency to the user.
- * The policy is subject to change. The current policy is as follows:
- * <ul>
- * <li>If the specified window has the requested perspective open and the
- * same requested input, then the window is given focus and the perspective
- * is shown.</li>
- * <li>If another window has the requested input and the requested
- * perspective open and active, then that window is given focus.</li>
- * <li>If the specified window has the same requested input but not the
- * requested perspective, then the window is given focus and the perspective
- * is opened and shown on condition that the user preference is not to open
- * perspectives in a new window.</li>
- * <li>Otherwise the requested perspective is opened and shown in a new
- * window, and the window is given focus.</li>
- * </ul>
+ * window, or in a new window depending on user preferences. The exact policy is
+ * controlled by the workbench to ensure consistency to the user. The policy is
+ * subject to change. The current policy is as follows:
* </p>
+ * <ul>
+ * <li>If the specified window has the requested perspective open and the same
+ * requested input, then the window is given focus and the perspective is
+ * shown.</li>
+ * <li>If another window has the requested input and the requested perspective
+ * open and active, then that window is given focus.</li>
+ * <li>If the specified window has the same requested input but not the
+ * requested perspective, then the window is given focus and the perspective is
+ * opened and shown on condition that the user preference is not to open
+ * perspectives in a new window.</li>
+ * <li>Otherwise the requested perspective is opened and shown in a new window,
+ * and the window is given focus.</li>
+ * </ul>
* <p>
- * The workbench also defines a number of menu items to activate or open
- * each registered perspective. A complete list of these perspectives is
- * available from the perspective registry found on <code>IWorkbench</code>.
+ * The workbench also defines a number of menu items to activate or open each
+ * registered perspective. A complete list of these perspectives is available
+ * from the perspective registry found on <code>IWorkbench</code>.
* </p>
*
- * @param perspectiveId
- * the perspective ID to show
- * @param window
- * the workbench window of the action calling this method.
- * @param input
- * the page input, or <code>null</code> if there is no current
- * input. This is used to seed the input for the page's views
+ * @param perspectiveId the perspective ID to show
+ * @param window the workbench window of the action calling this method.
+ * @param input the page input, or <code>null</code> if there is no
+ * current input. This is used to seed the input for the
+ * page's views
* @return the workbench page that the perspective was shown
- * @exception WorkbenchException
- * if the perspective could not be shown
+ * @exception WorkbenchException if the perspective could not be shown
*
* @since 2.0
*/
diff --git a/bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/IWorkbenchPartSite.java b/bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/IWorkbenchPartSite.java
index 0525fee..ae4c715 100644
--- a/bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/IWorkbenchPartSite.java
+++ b/bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/IWorkbenchPartSite.java
@@ -59,18 +59,18 @@
String getRegisteredName();
/**
- * Registers a pop-up menu with a particular id for extension.
- * This method should only be called if the target part has more
- * than one context menu to register.
- * <p>
- * For a detailed description of context menu registration see
- * <code>registerContextMenu(MenuManager, ISelectionProvider);
- * </p>
- *
- * @param menuId the menu id
- * @param menuManager the menu manager
- * @param selectionProvider the selection provider
- */
+ * Registers a pop-up menu with a particular id for extension. This method
+ * should only be called if the target part has more than one context menu to
+ * register.
+ * <p>
+ * For a detailed description of context menu registration see
+ * <code>registerContextMenu(MenuManager, ISelectionProvider);</code>
+ * </p>
+ *
+ * @param menuId the menu id
+ * @param menuManager the menu manager
+ * @param selectionProvider the selection provider
+ */
void registerContextMenu(String menuId, MenuManager menuManager,
ISelectionProvider selectionProvider);
diff --git a/bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/actions/ActionFactory.java b/bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/actions/ActionFactory.java
index 1f06cc5..eae2b5b 100644
--- a/bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/actions/ActionFactory.java
+++ b/bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/actions/ActionFactory.java
@@ -764,12 +764,13 @@
};
/**
- * Workbench action (id: "nextEditor", commandId: "org.eclipse.ui.window.nextEditor"): Next
- * editor. This action maintains its enablement state.
+ * Workbench action (id: "nextEditor", commandId:
+ * "org.eclipse.ui.window.nextEditor"): Next editor. This action maintains its
+ * enablement state.
* <p>
- * <code>NEXT_EDITOR</code> and <code>PREVIOUS_EDITOR</code> form a cycle action pair. For a
- * given window, use {@link ActionFactory#linkCycleActionPair
- * ActionFactory.linkCycleActionPair</code>} to connect the two.
+ * <code>NEXT_EDITOR</code> and <code>PREVIOUS_EDITOR</code> form a cycle action
+ * pair. For a given window, use {@link ActionFactory#linkCycleActionPair
+ * ActionFactory.linkCycleActionPair} to connect the two.
* </p>
*/
public static final ActionFactory NEXT_EDITOR = new ActionFactory(
@@ -795,12 +796,13 @@
};
/**
- * Workbench action (id: "nextPart", commandId: "org.eclipse.ui.window.nextView"): Next part.
- * This action maintains its enablement state.
+ * Workbench action (id: "nextPart", commandId:
+ * "org.eclipse.ui.window.nextView"): Next part. This action maintains its
+ * enablement state.
* <p>
- * <code>NEXT_PART</code> and <code>PREVIOUS_PART</code> form a cycle action pair. For a given
- * window, use {@link ActionFactory#linkCycleActionPair
- * ActionFactory.linkCycleActionPair</code>} to connect the two.
+ * <code>NEXT_PART</code> and <code>PREVIOUS_PART</code> form a cycle action
+ * pair. For a given window, use {@link ActionFactory#linkCycleActionPair
+ * ActionFactory.linkCycleActionPair} to connect the two.
* </p>
*/
public static final ActionFactory NEXT_PART = new ActionFactory("nextPart", //$NON-NLS-1$
@@ -824,12 +826,14 @@
};
/**
- * Workbench action (id: "nextPerspective", commandId: "org.eclipse.ui.window.nextPerspective"):
- * Next perspective. This action maintains its enablement state.
+ * Workbench action (id: "nextPerspective", commandId:
+ * "org.eclipse.ui.window.nextPerspective"): Next perspective. This action
+ * maintains its enablement state.
* <p>
- * <code>NEXT_PERSPECTIVE</code> and <code>PREVIOUS_PERSPECTIVE</code> form a cycle action pair.
- * For a given window, use {@link ActionFactory#linkCycleActionPair
- * ActionFactory.linkCycleActionPair</code>} to connect the two.
+ * <code>NEXT_PERSPECTIVE</code> and <code>PREVIOUS_PERSPECTIVE</code> form a
+ * cycle action pair. For a given window, use
+ * {@link ActionFactory#linkCycleActionPair ActionFactory.linkCycleActionPair}
+ * to connect the two.
* </p>
*/
public static final ActionFactory NEXT_PERSPECTIVE = new ActionFactory(
@@ -942,12 +946,13 @@
};
/**
- * Workbench action (id: "previousEditor", commandId: "org.eclipse.ui.window.previousEditor"):
- * Previous editor. This action maintains its enablement state.
+ * Workbench action (id: "previousEditor", commandId:
+ * "org.eclipse.ui.window.previousEditor"): Previous editor. This action
+ * maintains its enablement state.
* <p>
- * <code>NEXT_EDITOR</code> and <code>PREVIOUS_EDITOR</code> form a cycle action pair. For a
- * given window, use {@link ActionFactory#linkCycleActionPair
- * ActionFactory.linkCycleActionPair</code>} to connect the two.
+ * <code>NEXT_EDITOR</code> and <code>PREVIOUS_EDITOR</code> form a cycle action
+ * pair. For a given window, use {@link ActionFactory#linkCycleActionPair
+ * ActionFactory.linkCycleActionPair} to connect the two.
* </p>
*/
public static final ActionFactory PREVIOUS_EDITOR = new ActionFactory(
@@ -972,12 +977,13 @@
};
/**
- * Workbench action (id: "previousPart", commandId: "org.eclipse.ui.window.previousView"):
- * Previous part. This action maintains its enablement state.
+ * Workbench action (id: "previousPart", commandId:
+ * "org.eclipse.ui.window.previousView"): Previous part. This action maintains
+ * its enablement state.
* <p>
- * <code>NEXT_PART</code> and <code>PREVIOUS_PART</code> form a cycle action pair. For a given
- * window, use {@link ActionFactory#linkCycleActionPair
- * ActionFactory.linkCycleActionPair</code>} to connect the two.
+ * <code>NEXT_PART</code> and <code>PREVIOUS_PART</code> form a cycle action
+ * pair. For a given window, use {@link ActionFactory#linkCycleActionPair
+ * ActionFactory.linkCycleActionPair} to connect the two.
* </p>
*/
public static final ActionFactory PREVIOUS_PART = new ActionFactory(
@@ -1001,12 +1007,14 @@
};
/**
- * Workbench action (id: "previousPerspective", commandId: "org.eclipse.ui.window.previousPerspective"):
- * Previous perspective. This action maintains its enablement state.
+ * Workbench action (id: "previousPerspective", commandId:
+ * "org.eclipse.ui.window.previousPerspective"): Previous perspective. This
+ * action maintains its enablement state.
* <p>
- * <code>NEXT_PERSPECTIVE</code> and <code>PREVIOUS_PERSPECTIVE</code> form a cycle action pair.
- * For a given window, use {@link ActionFactory#linkCycleActionPair
- * ActionFactory.linkCycleActionPair</code>} to connect the two.
+ * <code>NEXT_PERSPECTIVE</code> and <code>PREVIOUS_PERSPECTIVE</code> form a
+ * cycle action pair. For a given window, use
+ * {@link ActionFactory#linkCycleActionPair ActionFactory.linkCycleActionPair}
+ * to connect the two.
* </p>
*/
public static final ActionFactory PREVIOUS_PERSPECTIVE = new ActionFactory(
@@ -1623,25 +1631,20 @@
};
/**
- * Establishes bi-direction connections between the forward and backward
- * actions of a cycle pair.
+ * Establishes bi-direction connections between the forward and backward actions
+ * of a cycle pair.
* <p>
* Example usage:
+ * </p>
*
* <pre>
- * ActionFactory.IWorkbenchAction nextEditorAction = ActionFactory.NEXT_EDITOR
- * .create(window);
- * ActionFactory.IWorkbenchAction previousEditorAction = ActionFactory.PREVIOUS_EDITOR
- * .create(window);
+ * ActionFactory.IWorkbenchAction nextEditorAction = ActionFactory.NEXT_EDITOR.create(window);
+ * ActionFactory.IWorkbenchAction previousEditorAction = ActionFactory.PREVIOUS_EDITOR.create(window);
* ActionFactory.linkCycleActionPair(nextEditorAction, previousEditorAction);
* </pre>
*
- * </p>
- *
- * @param next
- * the action that moves forward
- * @param previous
- * the action that moves backward
+ * @param next the action that moves forward
+ * @param previous the action that moves backward
*/
public static void linkCycleActionPair(IWorkbenchAction next,
IWorkbenchAction previous) {
diff --git a/bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/actions/package.html b/bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/actions/package.html
index 05c521c..e0cf6c3 100644
--- a/bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/actions/package.html
+++ b/bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/actions/package.html
@@ -18,10 +18,10 @@
in a part or viewer. These should be used by ISV's to define actions for
menus, toolbars, and context menus.
<p>Action which leads to resource modification should take advantage of
-the <tt>WorkspaceModifyOperation</tt> classes. These classes are
+the <code>WorkspaceModifyOperation</code> classes. These classes are
used to defer events which typically occur as a result of workspace changes
(such as the firing of resource deltas, performance of autobuilds, etc.)
-until the outermost operation has successfully completed. This deferral
+until the outermost operation has successfully completed. This deferral
leads to an optimized, faster execution of resource modification because
fewer deltas and autobuilds are performed.
</body>
diff --git a/bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/branding/IProductConstants.java b/bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/branding/IProductConstants.java
index 94c1151..cb96c57 100644
--- a/bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/branding/IProductConstants.java
+++ b/bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/branding/IProductConstants.java
@@ -60,19 +60,20 @@
String ABOUT_IMAGE = "aboutImage"; //$NON-NLS-1$
/**
- * A file for customizing default preference
- * values for a product. The value is interpreted as either a
- * URL or a bundle-relative path by the runtime. This is not referenced
- * from the workbench.
- * <p>
- * The contents must be the same format as a
- * {@link java.util.Properties} file with the key/value pairs being:
- * <pre>
- * qualifier/key=value
- * </pre>
- * Where <code>qualifier</code> is typically the bundle id.
- * </p>
- */
+ * A file for customizing default preference values for a product. The value is
+ * interpreted as either a URL or a bundle-relative path by the runtime. This is
+ * not referenced from the workbench.
+ * <p>
+ * The contents must be the same format as a {@link java.util.Properties} file
+ * with the key/value pairs being:
+ * </p>
+ *
+ * <pre>
+ * qualifier/key=value
+ * </pre>
+ *
+ * Where <code>qualifier</code> is typically the bundle id.
+ */
String PREFERENCE_CUSTOMIZATION = "preferenceCustomization"; //$NON-NLS-1$
/**
diff --git a/bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/commands/ICommandService.java b/bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/commands/ICommandService.java
index ecd9996..87269fe 100644
--- a/bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/commands/ICommandService.java
+++ b/bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/commands/ICommandService.java
@@ -36,14 +36,14 @@
* <p>
* This service can be acquired from your service locator:
* </p>
- *
+ *
* <pre>
* ICommandService service = (ICommandService) getSite().getService(ICommandService.class);
* </pre>
* <ul>
* <li>This service is available globally.</li>
* </ul>
- *
+ *
* @noimplement This interface is not intended to be implemented by clients.
* @noextend This interface is not intended to be extended by clients.
*
@@ -352,30 +352,27 @@
void unregisterElement(IElementReference elementReference);
/**
- * Refresh any elements registered against the command with the given id.
- * It allows the active handler the opportunity to provide user feedback. If
- * the command is parameterized, some of the parameters can be specified to
- * help narrow down which elements to refresh.
+ * Refresh any elements registered against the command with the given id. It
+ * allows the active handler the opportunity to provide user feedback. If the
+ * command is parameterized, some of the parameters can be specified to help
+ * narrow down which elements to refresh.
* <p>
- * The service locator used in registering the element can also be used to
- * scope the search. For example: if you wanted all elements for your
- * command but only within the part's workbench window, you could use:
+ * The service locator used in registering the element can also be used to scope
+ * the search. For example: if you wanted all elements for your command but only
+ * within the part's workbench window, you could use:
+ * </p>
*
* <pre>
* Map filter = new HashMap();
- * filter.put(IServiceScopes.WINDOW_SCOPE, getSite().getPage()
- * .getWorkbenchWindow());
+ * filter.put(IServiceScopes.WINDOW_SCOPE, getSite().getPage().getWorkbenchWindow());
* commandService.refreshElements(commandId, filter);
* </pre>
*
- * </p>
*
- * @param commandId
- * The command id to refresh if it has registered eleemnts.
- * @param filter
- * key-value pairs that can narrow down the callbacks to return.
- * The parameters are <b>AND</b>ed together. This may be
- * <code>null</code>.
+ * @param commandId The command id to refresh if it has registered eleemnts.
+ * @param filter key-value pairs that can narrow down the callbacks to
+ * return. The parameters are <b>AND</b>ed together. This may
+ * be <code>null</code>.
* @since 3.3
*/
void refreshElements(String commandId, Map filter);
diff --git a/bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/databinding/WorkbenchObservables.java b/bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/databinding/WorkbenchObservables.java
index 27570cd..813e0d7 100644
--- a/bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/databinding/WorkbenchObservables.java
+++ b/bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/databinding/WorkbenchObservables.java
@@ -95,18 +95,17 @@
* <p>
* This method can be used by view or editor implementers to tie into the
* selection service, for example as follows:
+ * </p>
*
* <pre>
* IObservableValue<IResource> selection = WorkbenchObservables.observeAdaptedSingleSelection(getSite(),
* IResource.class);
* </pre>
*
- * </p>
*
- * @param locator
- * a service locator with an available {@link ISelectionService}
- * @param targetType
- * the target type
+ * @param locator a service locator with an available
+ * {@link ISelectionService}
+ * @param targetType the target type
* @return an observable value whose value type is the given target type
*/
public static <T> IObservableValue<T> observeAdaptedSingleSelection(IServiceLocator locator, Class<T> targetType) {
diff --git a/bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/dialogs/WorkingSetConfigurationBlock.java b/bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/dialogs/WorkingSetConfigurationBlock.java
index 76450c1..92ddef1 100644
--- a/bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/dialogs/WorkingSetConfigurationBlock.java
+++ b/bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/dialogs/WorkingSetConfigurationBlock.java
@@ -136,14 +136,13 @@
/**
* Create a new instance of this working set block using default labels.
- * <br/>
- * <br/>
- * Note: Consider using the vararg version of this contructor.
*
- * @param workingSetIds
- * working set ids from which the user can choose
- * @param settings
- * to store/load the selection history
+ * <p>
+ * Note: Consider using the vararg version of this contructor.
+ * </p>
+ *
+ * @param workingSetIds working set ids from which the user can choose
+ * @param settings to store/load the selection history
*/
public WorkingSetConfigurationBlock(String[] workingSetIds, IDialogSettings settings) {
this(settings, workingSetIds);
@@ -151,23 +150,20 @@
/**
* Create a new instance of this working set block using custom labels.
- * <br/>
- * <br/>
- * Note: Consider using the vararg version of this contructor.
*
- * @param workingSetIds
- * working set ids from which the user can choose
- * @param settings
- * to store/load the selection history
- * @param enableButtonLabel
- * the label to use for the checkable enablement button. May be
- * <code>null</code> to use the default value.
- * @param comboLabel
- * the label to use for the recent working set combo. May be
- * <code>null</code> to use the default value.
- * @param selectLabel
- * the label to use for the select button. May be
- * <code>null</code> to use the default value.
+ * <p>
+ * Note: Consider using the vararg version of this contructor.
+ * </p>
+ *
+ * @param workingSetIds working set ids from which the user can choose
+ * @param settings to store/load the selection history
+ * @param enableButtonLabel the label to use for the checkable enablement
+ * button. May be <code>null</code> to use the default
+ * value.
+ * @param comboLabel the label to use for the recent working set combo.
+ * May be <code>null</code> to use the default value.
+ * @param selectLabel the label to use for the select button. May be
+ * <code>null</code> to use the default value.
*/
public WorkingSetConfigurationBlock(String[] workingSetIds, IDialogSettings settings, String enableButtonLabel, String comboLabel, String selectLabel) {
this(settings, enableButtonLabel, null, comboLabel, selectLabel, workingSetIds);
@@ -314,7 +310,7 @@
}
/**
- * Add this block to the <code>parent</parent>
+ * Add this block to the <code>parent</code>
*
* @param parent the parent to add the block to
*/
diff --git a/bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/intro/IIntroPart.java b/bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/intro/IIntroPart.java
index 8b04981..5653e4d 100644
--- a/bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/intro/IIntroPart.java
+++ b/bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/intro/IIntroPart.java
@@ -113,39 +113,39 @@
void saveState(IMemento memento);
/**
- * Adds a listener for changes to properties of this intro part.
- * Has no effect if an identical listener is already registered.
- * <p>
- * The properties ids are as follows:
- * <ul>
- * <li><code>IIntroPart.PROP_TITLE</code> </li>
- * </ul>
- * </p>
- *
- * @param listener a property listener
- */
+ * Adds a listener for changes to properties of this intro part. Has no effect
+ * if an identical listener is already registered.
+ * <p>
+ * The properties ids are as follows:
+ * </p>
+ * <ul>
+ * <li><code>IIntroPart.PROP_TITLE</code></li>
+ * </ul>
+ *
+ * @param listener a property listener
+ */
void addPropertyListener(IPropertyListener listener);
/**
- * Creates the SWT controls for this intro part.
- * <p>
- * Clients should not call this method (the workbench calls this method when
- * it needs to, which may be never).
- * </p>
- * <p>
- * For implementors this is a multi-step process:
- * <ol>
- * <li>Create one or more controls within the parent.</li>
- * <li>Set the parent layout as needed.</li>
- * <li>Register any global actions with the <code>IActionService</code>.</li>
- * <li>Register any popup menus with the <code>IActionService</code>.</li>
- * <li>Register a selection provider with the <code>ISelectionService</code>
- * (optional). </li>
- * </ol>
- * </p>
- *
- * @param parent the parent control
- */
+ * Creates the SWT controls for this intro part.
+ * <p>
+ * Clients should not call this method (the workbench calls this method when it
+ * needs to, which may be never).
+ * </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>
+ * <li>Register any global actions with the <code>IActionService</code>.</li>
+ * <li>Register any popup menus with the <code>IActionService</code>.</li>
+ * <li>Register a selection provider with the <code>ISelectionService</code>
+ * (optional).</li>
+ * </ol>
+ *
+ * @param parent the parent control
+ */
void createPartControl(Composite parent);
/**
diff --git a/bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/part/DrillDownAdapter.java b/bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/part/DrillDownAdapter.java
index f638099..c6648fc 100644
--- a/bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/part/DrillDownAdapter.java
+++ b/bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/part/DrillDownAdapter.java
@@ -97,13 +97,13 @@
}
/**
- * Returns whether expansion is possible for the current selection. This
- * will only be true if it has children.
- *
- * @param element the object to test for expansion
- * @return <code>true</code> if expansion is possible; otherwise
- * return <code>false</code
- */
+ * Returns whether expansion is possible for the current selection. This will
+ * only be true if it has children.
+ *
+ * @param element the object to test for expansion
+ * @return <code>true</code> if expansion is possible; otherwise return
+ * <code>false</code>
+ */
public boolean canExpand(Object element) {
return fChildTree.isExpandable(element);
}
diff --git a/bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/progress/IProgressService.java b/bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/progress/IProgressService.java
index 1d3f237..418e943 100644
--- a/bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/progress/IProgressService.java
+++ b/bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/progress/IProgressService.java
@@ -34,7 +34,7 @@
* <p>
* This service can be acquired from your service locator:
* </p>
- *
+ *
* <pre>
* IProgressService service = (IProgressService) getSite().getService(IProgressService.class);
* </pre>
@@ -77,36 +77,38 @@
void registerIconForFamily(ImageDescriptor icon, Object family);
/**
- * Runs the given operation in the UI thread using the given runnable context.
- * The given scheduling rule, if any, will be acquired for the duration of the operation.
- * If the rule is not available when this method is called, a progress dialog will be
- * displayed that gives users control over the background processes that may
- * be blocking the runnable from proceeding.
- * <p>
- * This method can act as a wrapper for uses of <tt>IRunnableContext</tt>
- * where the <tt>fork</tt> parameter was <tt>false</tt>.
- * <p>
- * Note: Running long operations in the UI thread is generally not
- * recommended. This can result in the UI becoming unresponsive for
- * the duration of the operation. Where possible, <tt>busyCursorWhile</tt>
- * should be used instead.
- * </p>
- * <p>
- * Modal dialogs should also be avoided in the runnable as there will already
- * be a modal progress dialog open when this operation runs.
- * </p>
- * @see org.eclipse.jface.dialogs.Dialog
- * @see org.eclipse.swt.SWT#APPLICATION_MODAL
- *
- * @param context The runnable context to run the operation in
- * @param runnable The operation to run
- * @param rule A scheduling rule, or <code>null</code>
- * @throws InvocationTargetException wraps any exception or error which occurs
- * while running the runnable
- * @throws InterruptedException propagated by the context if the runnable
- * acknowledges cancelation by throwing this exception.
- *
- */
+ * Runs the given operation in the UI thread using the given runnable context.
+ * The given scheduling rule, if any, will be acquired for the duration of the
+ * operation. If the rule is not available when this method is called, a
+ * progress dialog will be displayed that gives users control over the
+ * background processes that may be blocking the runnable from proceeding.
+ * <p>
+ * This method can act as a wrapper for uses of <code>IRunnableContext</code>
+ * where the <code>fork</code> parameter was <code>false</code>.
+ * <p>
+ * Note: Running long operations in the UI thread is generally not recommended.
+ * This can result in the UI becoming unresponsive for the duration of the
+ * operation. Where possible, <code>busyCursorWhile</code> should be used
+ * instead.
+ * </p>
+ * <p>
+ * Modal dialogs should also be avoided in the runnable as there will already be
+ * a modal progress dialog open when this operation runs.
+ * </p>
+ *
+ * @see org.eclipse.jface.dialogs.Dialog
+ * @see org.eclipse.swt.SWT#APPLICATION_MODAL
+ *
+ * @param context The runnable context to run the operation in
+ * @param runnable The operation to run
+ * @param rule A scheduling rule, or <code>null</code>
+ * @throws InvocationTargetException wraps any exception or error which occurs
+ * while running the runnable
+ * @throws InterruptedException propagated by the context if the runnable
+ * acknowledges cancelation by throwing this
+ * exception.
+ *
+ */
void runInUI(IRunnableContext context,
IRunnableWithProgress runnable, ISchedulingRule rule)
throws InvocationTargetException, InterruptedException;
diff --git a/bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/services/IEvaluationService.java b/bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/services/IEvaluationService.java
index 9894263..a33ad3c 100644
--- a/bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/services/IEvaluationService.java
+++ b/bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/services/IEvaluationService.java
@@ -56,7 +56,7 @@
* <p>
* This service can be acquired from your service locator:
* </p>
- *
+ *
* <pre>
* IEvaluationService service = (IEvaluationService) getSite().getService(IEvaluationService.class);
* </pre>
@@ -169,25 +169,23 @@
IEvaluationContext getCurrentState();
/**
- * Request that this service re-evaluate all registered core expressions
- * that contain a property tester for the given property name. This will
- * fire a {@link #PROP_NOTIFYING} property change event to service
- * listeners.
+ * Request that this service re-evaluate all registered core expressions that
+ * contain a property tester for the given property name. This will fire a
+ * {@link #PROP_NOTIFYING} property change event to service listeners.
* <p>
* Notes:
+ * </p>
* <ul>
* <li>the property must be able to return the new value before this
* re-evaluation is requested</li>
* <li>limit calls to this method to avoid unnecessary churn</li>
- * <li>A re-evaluation that does not change the value of an expression will
- * not fire a property change event</li>
+ * <li>A re-evaluation that does not change the value of an expression will not
+ * fire a property change event</li>
* </ul>
- * </p>
*
- * @param propertyName
- * The fully qualified property name, like
- * <code>org.eclipse.core.resources.name</code>. Must not be
- * <code>null</code>.
+ * @param propertyName The fully qualified property name, like
+ * <code>org.eclipse.core.resources.name</code>. Must not be
+ * <code>null</code>.
* @since 3.4
*/
void requestEvaluation(String propertyName);
diff --git a/bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/statushandlers/StatusManager.java b/bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/statushandlers/StatusManager.java
index 8528281..edbe809 100644
--- a/bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/statushandlers/StatusManager.java
+++ b/bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/statushandlers/StatusManager.java
@@ -276,15 +276,17 @@
/**
* Handles given CoreException. This method has been introduced to prevent
- * anti-pattern: <br/><code>
+ * anti-pattern:
+ *
+ * <pre>
+ * <code>
* StatusManager.getManager().handle(coreException.getStatus());
- * </code><br/>
+ * </code>
+ * </pre>
* that does not print the stack trace to the log.
*
- * @param coreException
- * a CoreException to be handled.
- * @param pluginId
- * the unique identifier of the relevant plug-in
+ * @param coreException a CoreException to be handled.
+ * @param pluginId the unique identifier of the relevant plug-in
* @see StatusManager#handle(IStatus)
* @since 3.4
*
@@ -401,7 +403,7 @@
* <ul>
* <li>all statuses has been handled</li>
* </ul>
- *
+ *
* @since 3.5
*
*/
diff --git a/bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/statushandlers/WorkbenchStatusDialogManager.java b/bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/statushandlers/WorkbenchStatusDialogManager.java
index e2f06e3..d0bd2a4 100644
--- a/bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/statushandlers/WorkbenchStatusDialogManager.java
+++ b/bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/statushandlers/WorkbenchStatusDialogManager.java
@@ -130,28 +130,26 @@
/**
* <p>
- * Adds a new {@link StatusAdapter} to the status adapters list in the
- * dialog.
+ * Adds a new {@link StatusAdapter} to the status adapters list in the dialog.
* </p>
* <p>
* If the dialog is already visible, the status adapter will be shown
- * immediately. Otherwise, the dialog with the added status adapter will
- * show up, if all conditions below are false.
+ * immediately. Otherwise, the dialog with the added status adapter will show
+ * up, if all conditions below are false.
+ * </p>
* <ul>
* <li>the status adapter has
- * {@link IProgressConstants#NO_IMMEDIATE_ERROR_PROMPT_PROPERTY} set to true</li>
+ * {@link IProgressConstants#NO_IMMEDIATE_ERROR_PROMPT_PROPERTY} set to
+ * true</li>
* </ul>
- * </p>
* <p>
- * All not shown status adapters will be displayed as soon as the dialog
- * shows up.
+ * All not shown status adapters will be displayed as soon as the dialog shows
+ * up.
* </p>
*
- * @param modal
- * <code>true</code> if the dialog should be modal,
- * <code>false</code> otherwise
- * @param statusAdapter
- * the status adapter
+ * @param modal <code>true</code> if the dialog should be modal,
+ * <code>false</code> otherwise
+ * @param statusAdapter the status adapter
*/
public void addStatusAdapter(final StatusAdapter statusAdapter,
final boolean modal) {
