Skip to main content
aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAlexander Kurtakov2019-02-15 16:39:18 -0500
committerAlexander Kurtakov2019-02-15 16:39:18 -0500
commit390f85a7da40e1561c668fb025ef26d50a5e8e84 (patch)
tree6516976eae820921ed4b8f4f1d89e12b0e794beb
parentfe3657653eca42e6987aa004bbc3f755182e5fa3 (diff)
downloadrt.equinox.bundles-390f85a7da40e1561c668fb025ef26d50a5e8e84.tar.gz
rt.equinox.bundles-390f85a7da40e1561c668fb025ef26d50a5e8e84.tar.xz
rt.equinox.bundles-390f85a7da40e1561c668fb025ef26d50a5e8e84.zip
Fix javadoc warnings catched by Java 11 tool with XDoclint:html. Change-Id: I3dd3376c9d4bdbb7a61a04eadf943a0e6f56fe5c Signed-off-by: Alexander Kurtakov <akurtako@redhat.com>
-rw-r--r--bundles/org.eclipse.equinox.app/src/org/eclipse/equinox/app/IApplicationContext.java2
-rw-r--r--bundles/org.eclipse.equinox.bidi/src/org/eclipse/equinox/bidi/StructuredTextProcessor.java4
-rw-r--r--bundles/org.eclipse.equinox.bidi/src/org/eclipse/equinox/bidi/advanced/StructuredTextEnvironment.java4
-rw-r--r--bundles/org.eclipse.equinox.common/src/org/eclipse/core/runtime/CoreException.java2
-rw-r--r--bundles/org.eclipse.equinox.common/src/org/eclipse/core/runtime/FileLocator.java19
-rw-r--r--bundles/org.eclipse.equinox.common/src/org/eclipse/core/runtime/IAdapterManager.java6
-rw-r--r--bundles/org.eclipse.equinox.common/src/org/eclipse/core/runtime/IPath.java2
-rw-r--r--bundles/org.eclipse.equinox.common/src/org/eclipse/core/runtime/IProgressMonitor.java2
-rw-r--r--bundles/org.eclipse.equinox.common/src/org/eclipse/core/runtime/PluginVersionIdentifier.java1
-rw-r--r--bundles/org.eclipse.equinox.common/src/org/eclipse/core/runtime/SubMonitor.java12
-rw-r--r--bundles/org.eclipse.equinox.common/src/org/eclipse/core/runtime/URIUtil.java3
-rw-r--r--bundles/org.eclipse.equinox.common/src/org/eclipse/core/runtime/package.html6
-rw-r--r--bundles/org.eclipse.equinox.http.jetty/src/org/eclipse/equinox/http/jetty/JettyConstants.java4
-rw-r--r--bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/runtime/preferences/AbstractPreferenceStorage.java2
-rw-r--r--bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/runtime/preferences/IPreferenceFilter.java2
-rw-r--r--bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/runtime/preferences/IPreferencesService.java30
-rw-r--r--bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/runtime/preferences/PreferenceFilterEntry.java4
-rw-r--r--bundles/org.eclipse.equinox.registry/src/org/eclipse/core/runtime/IConfigurationElement.java15
-rw-r--r--bundles/org.eclipse.equinox.registry/src/org/eclipse/core/runtime/IExecutableExtension.java15
-rw-r--r--bundles/org.eclipse.equinox.registry/src/org/eclipse/core/runtime/IExtensionRegistry.java2
-rw-r--r--bundles/org.eclipse.equinox.registry/src/org/eclipse/core/runtime/spi/RegistryStrategy.java4
-rw-r--r--bundles/org.eclipse.equinox.security/src/org/eclipse/equinox/security/storage/ISecurePreferences.java2
-rw-r--r--bundles/org.eclipse.equinox.security/src/org/eclipse/equinox/security/storage/SecurePreferencesFactory.java2
23 files changed, 77 insertions, 68 deletions
diff --git a/bundles/org.eclipse.equinox.app/src/org/eclipse/equinox/app/IApplicationContext.java b/bundles/org.eclipse.equinox.app/src/org/eclipse/equinox/app/IApplicationContext.java
index f9164e66..40441b29 100644
--- a/bundles/org.eclipse.equinox.app/src/org/eclipse/equinox/app/IApplicationContext.java
+++ b/bundles/org.eclipse.equinox.app/src/org/eclipse/equinox/app/IApplicationContext.java
@@ -37,6 +37,7 @@ public interface IApplicationContext {
* while launching or running an application then the launcher will set this property
* automatically in order to display a message to the end user. An application may
* set this property for the following reasons:
+ * </p>
* <ul>
* <li>To provide the command line arguments to relaunch the eclipse platform. See
* {@link IApplication#EXIT_RELAUNCH}</li>
@@ -47,7 +48,6 @@ public interface IApplicationContext {
* set to the empty <code>String</code>. This is useful for
* headless applications where error dialogs must never be displayed.</li>
* </ul>
- * </p>
* @since 1.3
*/
public static final String EXIT_DATA_PROPERTY = "eclipse.exitdata"; //$NON-NLS-1$
diff --git a/bundles/org.eclipse.equinox.bidi/src/org/eclipse/equinox/bidi/StructuredTextProcessor.java b/bundles/org.eclipse.equinox.bidi/src/org/eclipse/equinox/bidi/StructuredTextProcessor.java
index 718fb11d..944c025f 100644
--- a/bundles/org.eclipse.equinox.bidi/src/org/eclipse/equinox/bidi/StructuredTextProcessor.java
+++ b/bundles/org.eclipse.equinox.bidi/src/org/eclipse/equinox/bidi/StructuredTextProcessor.java
@@ -70,9 +70,9 @@ public final class StructuredTextProcessor {
* Each segment has the Unicode Bidi Algorithm applied to it,
* but as a whole, the string is oriented left to right.
* </p><p>
- * For example, a file path such as <tt>d:\myfolder\FOLDER\MYFILE.java</tt>
+ * For example, a file path such as <code>d:\myfolder\FOLDER\MYFILE.java</code>
* (where capital letters indicate RTL text) should render as
- * <tt>d:\myfolder\REDLOF\ELIFYM.java</tt>.
+ * <code>d:\myfolder\REDLOF\ELIFYM.java</code>.
* </p>
*
* @param str the <i>lean</i> text to process
diff --git a/bundles/org.eclipse.equinox.bidi/src/org/eclipse/equinox/bidi/advanced/StructuredTextEnvironment.java b/bundles/org.eclipse.equinox.bidi/src/org/eclipse/equinox/bidi/advanced/StructuredTextEnvironment.java
index 3b749bb4..64d1d1b0 100644
--- a/bundles/org.eclipse.equinox.bidi/src/org/eclipse/equinox/bidi/advanced/StructuredTextEnvironment.java
+++ b/bundles/org.eclipse.equinox.bidi/src/org/eclipse/equinox/bidi/advanced/StructuredTextEnvironment.java
@@ -153,15 +153,15 @@ public class StructuredTextEnvironment {
* will be displayed.
* <p>
* The orientation value is one of the following:
+ * </p>
* <ul>
* <li>{@link #ORIENT_LTR ORIENT_LTR},</li>
* <li>{@link #ORIENT_LTR ORIENT_RTL},</li>
* <li>{@link #ORIENT_CONTEXTUAL_LTR ORIENT_CONTEXTUAL_LTR},</li>
* <li>{@link #ORIENT_CONTEXTUAL_RTL ORIENT_CONTEXTUAL_RTL},</li>
* <li>{@link #ORIENT_UNKNOWN ORIENT_UNKNOWN}, or</li>
- * <li>{@link #ORIENT_IGNORE ORIENT_IGNORE}</li>.
+ * <li>{@link #ORIENT_IGNORE ORIENT_IGNORE}</li>
* </ul>
- * </p>
*/
public int getOrientation() {
return orientation;
diff --git a/bundles/org.eclipse.equinox.common/src/org/eclipse/core/runtime/CoreException.java b/bundles/org.eclipse.equinox.common/src/org/eclipse/core/runtime/CoreException.java
index f86500b4..0e5919aa 100644
--- a/bundles/org.eclipse.equinox.common/src/org/eclipse/core/runtime/CoreException.java
+++ b/bundles/org.eclipse.equinox.common/src/org/eclipse/core/runtime/CoreException.java
@@ -67,6 +67,7 @@ public class CoreException extends Exception {
* create a new {@link Status} with your plug-in ID and this
* <code>CoreException</code>, and use that new status for error reporting
* or as a method return value. For example, instead of:
+ * </p>
* <pre>
* yourPlugin.getLog().log(exception.getStatus());
* </pre>
@@ -75,7 +76,6 @@ public class CoreException extends Exception {
* IStatus result = new Status(exception.getStatus().getSeverity(), pluginId, message, exception);
* yourPlugin.getLog().log(result);
* </pre>
- * </p>
*
* @return a status object
*/
diff --git a/bundles/org.eclipse.equinox.common/src/org/eclipse/core/runtime/FileLocator.java b/bundles/org.eclipse.equinox.common/src/org/eclipse/core/runtime/FileLocator.java
index 12132602..9d7795e7 100644
--- a/bundles/org.eclipse.equinox.common/src/org/eclipse/core/runtime/FileLocator.java
+++ b/bundles/org.eclipse.equinox.common/src/org/eclipse/core/runtime/FileLocator.java
@@ -44,16 +44,17 @@ public final class FileLocator {
* <code>null</code> is returned if no such entry is found. Note that
* there is no specific order to the fragments.
* </p><p>
- * The following variables may also be used as entries in the provided path:
+ * The following variables may also be used as entries in the provided path:</p>
* <ul>
* <li>$nl$ - for language specific information</li>
* <li>$os$ - for operating system specific information</li>
* <li>$ws$ - for windowing system specific information</li>
* </ul>
- * </p><p>
+ * <p>
* A path of "$nl$/about.properties" in an environment with a default
* locale of en_CA will return a URL corresponding to the first location
* about.properties is found according to the following order:
+ * </p>
* <pre>
* plugin root/nl/en/CA/about.properties
* fragment1 root/nl/en/CA/about.properties
@@ -68,7 +69,7 @@ public final class FileLocator {
* fragment2 root/about.properties
* ...
* </pre>
- * </p><p>
+ * <p>
* The current environment variable values can be overridden using
* the override map argument or <code>null</code> can be specified
* if this is not desired.
@@ -97,16 +98,17 @@ public final class FileLocator {
* <code>null</code> is returned if no such entry is found. Note that
* there is no specific order to the fragments.
* </p><p>
- * The following variables may also be used as entries in the provided path:
+ * The following variables may also be used as entries in the provided path:</p>
* <ul>
* <li>$nl$ - for language specific information</li>
* <li>$os$ - for operating system specific information</li>
* <li>$ws$ - for windowing system specific information</li>
* </ul>
- * </p><p>
+ * <p>
* A path of "$nl$/about.properties" in an environment with a default
* locale of en_CA will return a URL corresponding to the first location
* about.properties is found according to the following order:
+ * </p>
* <pre>
* plugin root/nl/en/CA/about.properties
* fragment1 root/nl/en/CA/about.properties
@@ -121,7 +123,7 @@ public final class FileLocator {
* fragment2 root/about.properties
* ...
* </pre>
- * </p><p>
+ * <p>
* @see FileLocator#find(Bundle, IPath, Map) for the option to override the current environment variables
* </p>
*
@@ -168,15 +170,17 @@ public final class FileLocator {
* there is no specific order to the fragments.
* </p><p>
* The following variables may also be used as segments in the path of the provided URL:
+ * </p>
* <ul>
* <li>$nl$ - for language specific information</li>
* <li>$os$ - for operating system specific information</li>
* <li>$ws$ - for windowing system specific information</li>
* </ul>
- * </p><p>
+ * <p>
* For example, a URL of "platform:/plugin/org.eclipse.core.runtime/$nl$/about.properties" in an
* environment with a default locale of en_CA will return a URL corresponding to
* the first location about.properties is found according to the following order:
+ * </p>
* <pre>
* plugin root/nl/en/CA/about.properties
* fragment1 root/nl/en/CA/about.properties
@@ -191,7 +195,6 @@ public final class FileLocator {
* fragment2 root/about.properties
* ...
* </pre>
- * </p>
*
* @param url The location of a bundle entry that potentially includes the above
* environment variables
diff --git a/bundles/org.eclipse.equinox.common/src/org/eclipse/core/runtime/IAdapterManager.java b/bundles/org.eclipse.equinox.common/src/org/eclipse/core/runtime/IAdapterManager.java
index 39f39e84..3055d0dc 100644
--- a/bundles/org.eclipse.equinox.common/src/org/eclipse/core/runtime/IAdapterManager.java
+++ b/bundles/org.eclipse.equinox.common/src/org/eclipse/core/runtime/IAdapterManager.java
@@ -203,11 +203,13 @@ public interface IAdapterManager {
* Returns a status of an adapter factory registered that may be able
* to convert <code>adaptable</code> to an object of type <code>adapterTypeName</code>.
* <p>
- * One of the following values can be returned:<ul>
+ * One of the following values can be returned:</p>
+ * <ul>
* <li>{@link org.eclipse.core.runtime.IAdapterManager#NONE} if no applicable adapter factory was found;</li>
* <li>{@link org.eclipse.core.runtime.IAdapterManager#NOT_LOADED} if an adapter factory was found, but has not been loaded;</li>
* <li>{@link org.eclipse.core.runtime.IAdapterManager#LOADED} if an adapter factory was found, and it is loaded.</li>
- * </ul></p>
+ * </ul>
+ *
* @param adaptable the adaptable object being queried (usually an instance
* of <code>IAdaptable</code>)
* @param adapterTypeName the fully qualified class name of an adapter to
diff --git a/bundles/org.eclipse.equinox.common/src/org/eclipse/core/runtime/IPath.java b/bundles/org.eclipse.equinox.common/src/org/eclipse/core/runtime/IPath.java
index 1a826da9..f84e3911 100644
--- a/bundles/org.eclipse.equinox.common/src/org/eclipse/core/runtime/IPath.java
+++ b/bundles/org.eclipse.equinox.common/src/org/eclipse/core/runtime/IPath.java
@@ -493,6 +493,7 @@ public interface IPath extends Cloneable {
* device id. The same separator, "/", is used on all platforms.
* <p>
* Example result strings (without and with device id):
+ * </p>
* <pre>
* "/foo/bar.txt"
* "bar.txt"
@@ -508,7 +509,6 @@ public interface IPath extends Cloneable {
* "C:/"
* </pre>
* This string is suitable for passing to <code>Path(String)</code>.
- * </p>
*
* @return a string representation of this path
* @see Path
diff --git a/bundles/org.eclipse.equinox.common/src/org/eclipse/core/runtime/IProgressMonitor.java b/bundles/org.eclipse.equinox.common/src/org/eclipse/core/runtime/IProgressMonitor.java
index 19c00dd2..f6f1b3b9 100644
--- a/bundles/org.eclipse.equinox.common/src/org/eclipse/core/runtime/IProgressMonitor.java
+++ b/bundles/org.eclipse.equinox.common/src/org/eclipse/core/runtime/IProgressMonitor.java
@@ -118,7 +118,7 @@ public interface IProgressMonitor {
/**
* Internal method to handle scaling correctly. This method
* must not be called by a client. Clients should
- * always use the method </code>worked(int)</code>.
+ * always use the method <code>worked(int)</code>.
*
* @param work the amount of work done
*/
diff --git a/bundles/org.eclipse.equinox.common/src/org/eclipse/core/runtime/PluginVersionIdentifier.java b/bundles/org.eclipse.equinox.common/src/org/eclipse/core/runtime/PluginVersionIdentifier.java
index be8daf44..5119f7cf 100644
--- a/bundles/org.eclipse.equinox.common/src/org/eclipse/core/runtime/PluginVersionIdentifier.java
+++ b/bundles/org.eclipse.equinox.common/src/org/eclipse/core/runtime/PluginVersionIdentifier.java
@@ -114,7 +114,6 @@ public final class PluginVersionIdentifier {
* <li><code>1.9</code> (interpreted as <code>1.9.0</code>)</li>
* <li><code>3</code> (interpreted as <code>3.0.0</code>)</li>
* </ul>
- * </p>
*
* @param versionId string representation of the version identifier.
* Qualifier characters that are not a letter or a digit are replaced.
diff --git a/bundles/org.eclipse.equinox.common/src/org/eclipse/core/runtime/SubMonitor.java b/bundles/org.eclipse.equinox.common/src/org/eclipse/core/runtime/SubMonitor.java
index e01ab91e..92ca4ca6 100644
--- a/bundles/org.eclipse.equinox.common/src/org/eclipse/core/runtime/SubMonitor.java
+++ b/bundles/org.eclipse.equinox.common/src/org/eclipse/core/runtime/SubMonitor.java
@@ -714,7 +714,7 @@ public final class SubMonitor implements IProgressMonitorWithBlocking {
* <p>This is property makes it unnecessary to call done() on a SubMonitor instance, since child
* monitors are automatically cleaned up the next time the parent is touched.</p>
*
- * <code><pre>
+ * <pre> <code>
* ////////////////////////////////////////////////////////////////////////////
* // Example 1: Typical usage of newChild
* void myMethod(IProgressMonitor parent) {
@@ -755,7 +755,7 @@ public final class SubMonitor implements IProgressMonitorWithBlocking {
* Object someValue = computeValue(progress.newChild(50));
* callMethod(progress.newChild(50), someValue);
* }
- * </pre></code>
+ * </code></pre>
*
* @param totalWork number of ticks to consume from the receiver
* @param suppressFlags a bitwise combination of SUPPRESS_* flags. They can be used to suppress
@@ -843,7 +843,7 @@ public final class SubMonitor implements IProgressMonitorWithBlocking {
* <p>This makes it unnecessary to call done() on a SubMonitor instance, since child
* monitors are automatically cleaned up the next time the parent is touched.</p>
*
- * <code><pre>
+ * <pre><code>
* ////////////////////////////////////////////////////////////////////////////
* // Example 1: Typical usage of split
* void myMethod(IProgressMonitor parent) {
@@ -884,7 +884,7 @@ public final class SubMonitor implements IProgressMonitorWithBlocking {
* Object someValue = computeValue(progress.split(50));
* callMethod(progress.split(50), someValue);
* }
- * </pre></code>
+ * </code></pre>
*
* @param totalWork number of ticks to consume from the receiver
* @return a new SubMonitor instance
@@ -914,7 +914,7 @@ public final class SubMonitor implements IProgressMonitorWithBlocking {
* <p>This is property makes it unnecessary to call done() on a SubMonitor instance, since child
* monitors are automatically cleaned up the next time the parent is touched.</p>
*
- * <code><pre>
+ * <pre> <code>
* ////////////////////////////////////////////////////////////////////////////
* // Example 1: Typical usage of split
* void myMethod(IProgressMonitor parent) {
@@ -955,7 +955,7 @@ public final class SubMonitor implements IProgressMonitorWithBlocking {
* Object someValue = computeValue(progress.split(50));
* callMethod(progress.split(50), someValue);
* }
- * </pre></code>
+ * </code></pre>
*
* @param totalWork number of ticks to consume from the receiver
* @param suppressFlags a bitwise combination of SUPPRESS_* flags. They can be used to suppress
diff --git a/bundles/org.eclipse.equinox.common/src/org/eclipse/core/runtime/URIUtil.java b/bundles/org.eclipse.equinox.common/src/org/eclipse/core/runtime/URIUtil.java
index 548c27ce..83928adb 100644
--- a/bundles/org.eclipse.equinox.common/src/org/eclipse/core/runtime/URIUtil.java
+++ b/bundles/org.eclipse.equinox.common/src/org/eclipse/core/runtime/URIUtil.java
@@ -329,11 +329,12 @@ public final class URIUtil {
/**
* Returns an absolute URI that is created by appending the given relative URI to
- * the given base. If the <tt>relative</tt> URI is already absolute it is simply returned.
+ * the given base. If the <code>relative</code> URI is already absolute it is simply returned.
* <p>
* This method is guaranteed to be the inverse of {@link #makeRelative(URI, URI)}.
* That is, if R = makeRelative(O, B), then makeAbsolute(R, B), will return the original
* URI O.
+ * </p>
*
* @param relative the relative URI
* @param baseURI the base URI
diff --git a/bundles/org.eclipse.equinox.common/src/org/eclipse/core/runtime/package.html b/bundles/org.eclipse.equinox.common/src/org/eclipse/core/runtime/package.html
index d81771f3..8178f137 100644
--- a/bundles/org.eclipse.equinox.common/src/org/eclipse/core/runtime/package.html
+++ b/bundles/org.eclipse.equinox.common/src/org/eclipse/core/runtime/package.html
@@ -9,9 +9,9 @@ Provides support for the runtime platform, core utility methods and the extensio
<h2>
Package Specification</h2>
This package contains three components:<ul>
-<li>APIs related to the runtime platform itself (provided by the <tt>org.eclipse.core.runtime</tt> plug-in)</li>
-<li>Various utility types such as <tt>Path</tt>, <tt>IPath</tt> and various flavours of progress monitors (provided by the <tt>org.eclipse.equinox.common</tt> plug-in)</li>
-<li>Extension registry mechanism (provided by the <tt>org.eclipse.equinox.registry</tt> plug-in)</li>
+<li>APIs related to the runtime platform itself (provided by the <code>org.eclipse.core.runtime</code> plug-in)</li>
+<li>Various utility types such as <code>Path</code>, <code>IPath</code> and various flavours of progress monitors (provided by the <code>org.eclipse.equinox.common</code> plug-in)</li>
+<li>Extension registry mechanism (provided by the <code>org.eclipse.equinox.registry</code> plug-in)</li>
</ul>
</body>
</html>
diff --git a/bundles/org.eclipse.equinox.http.jetty/src/org/eclipse/equinox/http/jetty/JettyConstants.java b/bundles/org.eclipse.equinox.http.jetty/src/org/eclipse/equinox/http/jetty/JettyConstants.java
index ca30b546..0d1c3ecc 100644
--- a/bundles/org.eclipse.equinox.http.jetty/src/org/eclipse/equinox/http/jetty/JettyConstants.java
+++ b/bundles/org.eclipse.equinox.http.jetty/src/org/eclipse/equinox/http/jetty/JettyConstants.java
@@ -157,10 +157,10 @@ public interface JettyConstants {
public static final String HOUSEKEEPER_INTERVAL = "housekeeper.interval"; //$NON-NLS-1$
/**
- * name="customizer.class" type="String" <br />
+ * name="customizer.class" type="String" <br>
* (full qualified name of the class that implements
* <code>org.eclipse.equinox.http.jetty.JettyCustomizer</code> and has a public no-arg constructor;
- * the class must be supplied via a fragment to this bundle's classpath)</code>
+ * the class must be supplied via a fragment to this bundle's classpath)
* @since 1.1
*/
public static final String CUSTOMIZER_CLASS = "customizer.class"; //$NON-NLS-1$
diff --git a/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/runtime/preferences/AbstractPreferenceStorage.java b/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/runtime/preferences/AbstractPreferenceStorage.java
index 2d41b774..1140a454 100644
--- a/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/runtime/preferences/AbstractPreferenceStorage.java
+++ b/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/runtime/preferences/AbstractPreferenceStorage.java
@@ -33,10 +33,10 @@ public abstract class AbstractPreferenceStorage {
* <p>
* The table keys consist of an optional child node path and separator, followed by
* the property key. The table values are the values of the properties.
+ * </p>
* <pre>
* [childNodePath/]propertyKey=propertyValue
* </pre>
- * </p>
* <p>
* Note: Whether they are absolute or relative, the paths in the returned Properties
* object are always interpreted as relative to the node specified by nodePath.
diff --git a/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/runtime/preferences/IPreferenceFilter.java b/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/runtime/preferences/IPreferenceFilter.java
index cefa3a9d..9254f4af 100644
--- a/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/runtime/preferences/IPreferenceFilter.java
+++ b/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/runtime/preferences/IPreferenceFilter.java
@@ -64,13 +64,13 @@ public interface IPreferenceFilter {
* </p>
* <p>
* For example:
+ * </p>
* <pre>
* "org.eclipse.core.resources" -> null
* "org.eclipse.ui" -> new PreferenceFilterEntry[] {
* new PreferenceFilterEntry("DEFAULT_PERSPECTIVE_LOCATION"),
* new PreferenceFilterEntry("SHOW_INTRO_ON_STARTUP")}
* </pre>
- * </p>
*
* @return the mapping table
* @see PreferenceFilterEntry
diff --git a/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/runtime/preferences/IPreferencesService.java b/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/runtime/preferences/IPreferencesService.java
index f1fcf795..23f4539a 100644
--- a/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/runtime/preferences/IPreferencesService.java
+++ b/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/runtime/preferences/IPreferencesService.java
@@ -68,7 +68,7 @@ public interface IPreferencesService {
* path of a child node and key. If the key contains a slash ("/") character, then a
* double-slash must be used to denote the end of they child path and the beginning
* of the key. Otherwise it is assumed that the key is the last segment of the path.
- * The following are some examples of keys and their meanings:
+ * The following are some examples of keys and their meanings:</p>
* <ul>
* <li>"a" - look for a value for the property "a"
* <li>"//a" - look for a value for the property "a"
@@ -81,7 +81,7 @@ public interface IPreferencesService {
* <li>"/a/b//c/d" - look in the child node "a/b" for the property "c/d"
* <li>"/a/b//c//d" - look in the child node "a/b" for the property "c//d"
* </ul>
- * </p><p>
+ * <p>
* The scope look-up order is determined by the preference service default
* lookup order, not by the order of the scope contexts that are being passed in.
* The context objects are only consulted to help determine which nodes to
@@ -123,7 +123,7 @@ public interface IPreferencesService {
* path of a child node and key. If the key contains a slash ("/") character, then a
* double-slash must be used to denote the end of they child path and the beginning
* of the key. Otherwise it is assumed that the key is the last segment of the path.
- * The following are some examples of keys and their meanings:
+ * The following are some examples of keys and their meanings:</p>
* <ul>
* <li>"a" - look for a value for the property "a"
* <li>"//a" - look for a value for the property "a"
@@ -136,7 +136,7 @@ public interface IPreferencesService {
* <li>"/a/b//c/d" - look in the child node "a/b" for the property "c/d"
* <li>"/a/b//c//d" - look in the child node "a/b" for the property "c//d"
* </ul>
- * </p><p>
+ * <p>
* The scope look-up order is determined by the preference service default
* lookup order, not by the order of the scope contexts that are being passed in.
* The context objects are only consulted to help determine which nodes to
@@ -178,7 +178,7 @@ public interface IPreferencesService {
* path of a child node and key. If the key contains a slash ("/") character, then a
* double-slash must be used to denote the end of they child path and the beginning
* of the key. Otherwise it is assumed that the key is the last segment of the path.
- * The following are some examples of keys and their meanings:
+ * The following are some examples of keys and their meanings:</p>
* <ul>
* <li>"a" - look for a value for the property "a"
* <li>"//a" - look for a value for the property "a"
@@ -191,7 +191,7 @@ public interface IPreferencesService {
* <li>"/a/b//c/d" - look in the child node "a/b" for the property "c/d"
* <li>"/a/b//c//d" - look in the child node "a/b" for the property "c//d"
* </ul>
- * </p><p>
+ * <p>
* The scope look-up order is determined by the preference service default
* lookup order, not by the order of the scope contexts that are being passed in.
* The context objects are only consulted to help determine which nodes to
@@ -233,7 +233,7 @@ public interface IPreferencesService {
* path of a child node and key. If the key contains a slash ("/") character, then a
* double-slash must be used to denote the end of they child path and the beginning
* of the key. Otherwise it is assumed that the key is the last segment of the path.
- * The following are some examples of keys and their meanings:
+ * The following are some examples of keys and their meanings:</p>
* <ul>
* <li>"a" - look for a value for the property "a"
* <li>"//a" - look for a value for the property "a"
@@ -246,7 +246,7 @@ public interface IPreferencesService {
* <li>"/a/b//c/d" - look in the child node "a/b" for the property "c/d"
* <li>"/a/b//c//d" - look in the child node "a/b" for the property "c//d"
* </ul>
- * </p><p>
+ * <p>
* The scope look-up order is determined by the preference service default
* lookup order, not by the order of the scope contexts that are being passed in.
* The context objects are only consulted to help determine which nodes to
@@ -288,7 +288,7 @@ public interface IPreferencesService {
* path of a child node and key. If the key contains a slash ("/") character, then a
* double-slash must be used to denote the end of they child path and the beginning
* of the key. Otherwise it is assumed that the key is the last segment of the path.
- * The following are some examples of keys and their meanings:
+ * The following are some examples of keys and their meanings:</p>
* <ul>
* <li>"a" - look for a value for the property "a"
* <li>"//a" - look for a value for the property "a"
@@ -301,7 +301,7 @@ public interface IPreferencesService {
* <li>"/a/b//c/d" - look in the child node "a/b" for the property "c/d"
* <li>"/a/b//c//d" - look in the child node "a/b" for the property "c//d"
* </ul>
- * </p><p>
+ * <p>
* The scope look-up order is determined by the preference service default
* lookup order, not by the order of the scope contexts that are being passed in.
* The context objects are only consulted to help determine which nodes to
@@ -343,7 +343,7 @@ public interface IPreferencesService {
* path of a child node and key. If the key contains a slash ("/") character, then a
* double-slash must be used to denote the end of they child path and the beginning
* of the key. Otherwise it is assumed that the key is the last segment of the path.
- * The following are some examples of keys and their meanings:
+ * The following are some examples of keys and their meanings:</p>
* <ul>
* <li>"a" - look for a value for the property "a"
* <li>"//a" - look for a value for the property "a"
@@ -356,7 +356,7 @@ public interface IPreferencesService {
* <li>"/a/b//c/d" - look in the child node "a/b" for the property "c/d"
* <li>"/a/b//c//d" - look in the child node "a/b" for the property "c//d"
* </ul>
- * </p><p>
+ * <p>
* The scope look-up order is determined by the preference service default
* lookup order, not by the order of the scope contexts that are being passed in.
* The context objects are only consulted to help determine which nodes to
@@ -398,7 +398,7 @@ public interface IPreferencesService {
* path of a child node and key. If the key contains a slash ("/") character, then a
* double-slash must be used to denote the end of they child path and the beginning
* of the key. Otherwise it is assumed that the key is the last segment of the path.
- * The following are some examples of keys and their meanings:
+ * The following are some examples of keys and their meanings:</p>
* <ul>
* <li>"a" - look for a value for the property "a"
* <li>"//a" - look for a value for the property "a"
@@ -411,7 +411,7 @@ public interface IPreferencesService {
* <li>"/a/b//c/d" - look in the child node "a/b" for the property "c/d"
* <li>"/a/b//c//d" - look in the child node "a/b" for the property "c//d"
* </ul>
- * </p><p>
+ * <p>
* The scope look-up order is determined by the preference service default
* lookup order, not by the order of the scope contexts that are being passed in.
* The context objects are only consulted to help determine which nodes to
@@ -455,12 +455,12 @@ public interface IPreferencesService {
* the preference is not exported. The exclusion can also occur at a per-node level.
* Wild cards are <em>not</em> accepted in the excludes list as a basic String compare
* is done. The basic algorithm is similar to the following:
+ * </p>
* <pre>
* String fullPath = node.absolutePath() + '/' + key;
* if (!fullPath.startsWith(excludesList[i]))
* // export preference
* </pre>
- * </p>
* <p>
* The values stored in the resulting stream are suitable for later being read by the
* by {@link #importPreferences(InputStream)} or {@link #readPreferences(InputStream)} methods.
diff --git a/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/runtime/preferences/PreferenceFilterEntry.java b/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/runtime/preferences/PreferenceFilterEntry.java
index 2d88241b..5ce6f195 100644
--- a/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/runtime/preferences/PreferenceFilterEntry.java
+++ b/bundles/org.eclipse.equinox.preferences/src/org/eclipse/core/runtime/preferences/PreferenceFilterEntry.java
@@ -23,7 +23,7 @@ package org.eclipse.core.runtime.preferences;
*/
public final class PreferenceFilterEntry {
- private String key;
+ private final String key;
private String matchType;
/**
@@ -48,7 +48,7 @@ public final class PreferenceFilterEntry {
* an exact match.
* </p>
* @param key the name of the preference key
- * @param matchType specifies key match type, may be <code>null</null> to indicate
+ * @param matchType specifies key match type, may be <code>null</code> to indicate
* that exact match is required
* @since 3.3
*/
diff --git a/bundles/org.eclipse.equinox.registry/src/org/eclipse/core/runtime/IConfigurationElement.java b/bundles/org.eclipse.equinox.registry/src/org/eclipse/core/runtime/IConfigurationElement.java
index 31b5c5e9..9114c194 100644
--- a/bundles/org.eclipse.equinox.registry/src/org/eclipse/core/runtime/IConfigurationElement.java
+++ b/bundles/org.eclipse.equinox.registry/src/org/eclipse/core/runtime/IConfigurationElement.java
@@ -89,10 +89,11 @@ public interface IConfigurationElement {
* <p>
* The names of configuration element attributes
* are the same as the attribute names of the corresponding XML element.
- * For example, the configuration markup
+ * For example, the configuration markup</p>
* <pre>
* &lt;bg pattern="stripes"/&gt;
* </pre>
+ * <p>
* corresponds to a configuration element named <code>"bg"</code>
* with an attribute named <code>"pattern"</code>
* with attribute value <code>"stripes"</code>.
@@ -134,10 +135,11 @@ public interface IConfigurationElement {
* <p>
* The names of configuration element attributes
* are the same as the attribute names of the corresponding XML element.
- * For example, the configuration markup
+ * For example, the configuration markup</p>
* <pre>
* &lt;bg pattern="stripes"/&gt;
* </pre>
+ * <p>
* corresponds to a configuration element named <code>"bg"</code>
* with an attribute named <code>"pattern"</code>
* with attribute value <code>"stripes"</code>.
@@ -162,10 +164,11 @@ public interface IConfigurationElement {
* <p>
* The names of configuration element attributes
* are the same as the attribute names of the corresponding XML element.
- * For example, the configuration markup
+ * For example, the configuration markup</p>
* <pre>
* &lt;bg color="blue" pattern="stripes"/&gt;
* </pre>
+ * <p>
* corresponds to a configuration element named <code>"bg"</code>
* with attributes named <code>"color"</code>
* and <code>"pattern"</code>.
@@ -183,13 +186,14 @@ public interface IConfigurationElement {
* <p>
* Each child corresponds to a nested
* XML element in the configuration markup.
- * For example, the configuration markup
+ * For example, the configuration markup</p>
* <pre>
* &lt;view&gt;
* &nbsp&nbsp&nbsp&nbsp&lt;verticalHint&gt;top&lt;/verticalHint&gt;
* &nbsp&nbsp&nbsp&nbsp&lt;horizontalHint&gt;left&lt;/horizontalHint&gt;
* &lt;/view&gt;
* </pre>
+ * <p>
* corresponds to a configuration element, named <code>"view"</code>,
* with two children.
* </p>
@@ -302,10 +306,11 @@ public interface IConfigurationElement {
* <p>
* Note that translation specified in the plug-in manifest
* file is <b>not</b> automatically applied.
- * For example, the configuration markup
+ * For example, the configuration markup</p>
* <pre>
* &lt;tooltip&gt;#hattip&lt;/tooltip&gt;
* </pre>
+ * <p>
* corresponds to a configuration element, named <code>"tooltip"</code>,
* with value <code>"#hattip"</code>.
* </p>
diff --git a/bundles/org.eclipse.equinox.registry/src/org/eclipse/core/runtime/IExecutableExtension.java b/bundles/org.eclipse.equinox.registry/src/org/eclipse/core/runtime/IExecutableExtension.java
index 69d5f2ea..7595c3eb 100644
--- a/bundles/org.eclipse.equinox.registry/src/org/eclipse/core/runtime/IExecutableExtension.java
+++ b/bundles/org.eclipse.equinox.registry/src/org/eclipse/core/runtime/IExecutableExtension.java
@@ -13,8 +13,6 @@
*******************************************************************************/
package org.eclipse.core.runtime;
-import org.eclipse.core.runtime.CoreException;
-
/**
* Interface for executable extension classes that require access to
* their configuration element, or implement an extension adapter.
@@ -44,10 +42,11 @@ public interface IExecutableExtension {
* <p>
* Regular executable extensions specify their Java implementation
* class name as an attribute of the configuration element for the
- * extension. For example
+ * extension. For example</p>
* <pre>
* &lt;action run="com.example.BaseAction"/&gt;
* </pre>
+ * <p>
* In the above example, this method would be called with a reference
* to the <code>&lt;action&gt;</code> element (first argument), and
* <code>"run"</code> as the name of the attribute that defined
@@ -69,24 +68,24 @@ public interface IExecutableExtension {
* form. For example, if the extension point specifies an attribute
* <code>"run"</code> to contain the name of the extension implementation,
* an adapter can be configured as
+ * </p>
* <pre>
* &lt;action run="com.example.ExternalAdapter:./cmds/util.exe -opt 3"/&gt;
* </pre>
- * </p>
* <p>
* (2) by converting the attribute used to specify the executable
* extension to a child element of the original configuration element,
* and specifying the adapter data in the form of xml markup.
* Using this form, the example above would become
+ * </p>
* <pre>
* &lt;action&gt;
- * &lt;<it>run</it> class="com.xyz.ExternalAdapter"&gt;
+ * &lt;run class="com.xyz.ExternalAdapter"&gt;
* &lt;parameter name="exec" value="./cmds/util.exe"/&gt;
* &lt;parameter name="opt" value="3"/&gt;
- * &lt;/<it>run</it>&gt;
+ * &lt;/run&gt;
* &lt;/action&gt;
* </pre>
- * </p>
* <p>
* Form (2) will typically only be
* used for extension points that anticipate the majority of
@@ -98,6 +97,7 @@ public interface IExecutableExtension {
* 0-argument public constructor. The adapter data is passed as the
* last argument of this method. The data argument is defined as Object.
* It can have the following values:
+ * </p>
* <ul>
* <li><code>null</code>, if no adapter data was supplied</li>
* <li>in case (1), the initialization data
@@ -106,7 +106,6 @@ public interface IExecutableExtension {
* as a <code>Hashtable</code> containing the actual
* parameter names and values (both <code>String</code>s)</li>
* </ul>
- * </p>
*
* @param config the configuration element used to trigger this execution.
* It can be queried by the executable extension for specific
diff --git a/bundles/org.eclipse.equinox.registry/src/org/eclipse/core/runtime/IExtensionRegistry.java b/bundles/org.eclipse.equinox.registry/src/org/eclipse/core/runtime/IExtensionRegistry.java
index 3cfd56dc..5ec344b1 100644
--- a/bundles/org.eclipse.equinox.registry/src/org/eclipse/core/runtime/IExtensionRegistry.java
+++ b/bundles/org.eclipse.equinox.registry/src/org/eclipse/core/runtime/IExtensionRegistry.java
@@ -89,10 +89,10 @@ public interface IExtensionRegistry {
*
* </p><p>
* This method is equivalent to:
+ * </p>
* <pre>
* addRegistryChangeListener(listener,null);
* </pre>
- * </p>
*
* @param listener the listener
* @see IRegistryChangeListener
diff --git a/bundles/org.eclipse.equinox.registry/src/org/eclipse/core/runtime/spi/RegistryStrategy.java b/bundles/org.eclipse.equinox.registry/src/org/eclipse/core/runtime/spi/RegistryStrategy.java
index aa43b341..0e207487 100644
--- a/bundles/org.eclipse.equinox.registry/src/org/eclipse/core/runtime/spi/RegistryStrategy.java
+++ b/bundles/org.eclipse.equinox.registry/src/org/eclipse/core/runtime/spi/RegistryStrategy.java
@@ -117,13 +117,13 @@ public class RegistryStrategy {
* to the registry. The method adds a log entry based on the supplied status.
* <p>
* This method writes a message to <code>System.out</code>
- * in the following format:
+ * in the following format:</p>
* <pre>
* [Error|Warning|Log]: Main error message
* [Error|Warning|Log]: Child error message 1
* ...
* [Error|Warning|Log]: Child error message N
- * </pre></p>
+ * </pre>
*
* @param status the status to log
*/
diff --git a/bundles/org.eclipse.equinox.security/src/org/eclipse/equinox/security/storage/ISecurePreferences.java b/bundles/org.eclipse.equinox.security/src/org/eclipse/equinox/security/storage/ISecurePreferences.java
index 97f1a2d3..cc06d75e 100644
--- a/bundles/org.eclipse.equinox.security/src/org/eclipse/equinox/security/storage/ISecurePreferences.java
+++ b/bundles/org.eclipse.equinox.security/src/org/eclipse/equinox/security/storage/ISecurePreferences.java
@@ -140,13 +140,13 @@ public interface ISecurePreferences {
* <p>
* If the node path is invalid, an {@link IllegalArgumentException} will be thrown
* by this method. The valid node path:
+ * </p>
* <ul>
* <li>contains only ASCII characters between 32 and 126 (ASCII alphanumeric and printable
* characters);</li>
* <li>can not contain two or more consecutive forward slashes;</li>
* <li>can not end with a trailing forward slash.</li>
* </ul>
- * </p>
* @see org.osgi.service.prefs.Preferences
* @see org.osgi.service.prefs.Preferences#node(String)
* @param pathName absolute or relative path to the node
diff --git a/bundles/org.eclipse.equinox.security/src/org/eclipse/equinox/security/storage/SecurePreferencesFactory.java b/bundles/org.eclipse.equinox.security/src/org/eclipse/equinox/security/storage/SecurePreferencesFactory.java
index af29f65c..91ee7f4e 100644
--- a/bundles/org.eclipse.equinox.security/src/org/eclipse/equinox/security/storage/SecurePreferencesFactory.java
+++ b/bundles/org.eclipse.equinox.security/src/org/eclipse/equinox/security/storage/SecurePreferencesFactory.java
@@ -35,6 +35,7 @@ final public class SecurePreferencesFactory {
* The framework will attempt to open secure preferences in a user-specific location.
* As a result, the information stored can be shared among all programs run by the user.
* The location is determined as follows:
+ * </p>
* <ol>
* <li>&quot;-equinox.keyring&quot; command line arguments</li>
* <li>Java's &quot;user.home&quot; environment variable. On Windows system it usually
@@ -44,7 +45,6 @@ final public class SecurePreferencesFactory {
* <li>if it fails, preferences will use configuration location of the current Eclipse
* instance.</li>
* </ol>
- * </p>
* @return default instance of secure preferences, <code>null</code> if application
* was unable to create secure preferences using default location
*/

Back to the top