diff options
Diffstat (limited to 'bundles/org.eclipse.equinox.common')
9 files changed, 29 insertions, 24 deletions
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 f86500b40..0e5919aaa 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 121326028..9d7795e78 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 39f39e84d..3055d0dc8 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 1a826da97..f84e39118 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 19c00dd26..f6f1b3b92 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 be8daf44e..5119f7cf6 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 e01ab91e1..92ca4ca66 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 548c27ce7..83928adb5 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 d81771f3d..8178f1379 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> |