Skip to main content
aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAlexander Kurtakov2019-02-18 16:22:44 +0000
committerAlexander Kurtakov2019-02-18 16:22:44 +0000
commitca85b91fc5f5d1064bfd7da06f922359b6d4d2d1 (patch)
tree4135245549de9cc066de1250331b69e3a6c267d0
parenteb84eadefbf9507041ac4597d107f9cf23ab5f70 (diff)
downloadrt.equinox.framework-ca85b91fc5f5d1064bfd7da06f922359b6d4d2d1.tar.gz
rt.equinox.framework-ca85b91fc5f5d1064bfd7da06f922359b6d4d2d1.tar.xz
rt.equinox.framework-ca85b91fc5f5d1064bfd7da06f922359b6d4d2d1.zip
Fix javadoc warnings catched by Java 11 tool with XDoclint:html. Change-Id: I19a1c991d5653ac032507dd53c79c1e96ff5e23f Signed-off-by: Alexander Kurtakov <akurtako@redhat.com>
-rw-r--r--bundles/org.eclipse.osgi/container/src/org/eclipse/core/runtime/adaptor/package.html4
-rw-r--r--bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/service/resolver/Resolver.java4
-rw-r--r--bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/service/resolver/State.java7
-rw-r--r--bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/service/resolver/VersionRange.java4
-rw-r--r--bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/util/TextProcessor.java6
-rw-r--r--bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/framework/log/package.html4
-rw-r--r--bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/service/datalocation/package.html4
-rw-r--r--bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/service/debug/package.html4
-rw-r--r--bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/service/environment/package.html4
-rw-r--r--bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/service/localization/package.html4
-rw-r--r--bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/util/ManifestElement.java2
-rw-r--r--bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/util/NLS.java9
12 files changed, 30 insertions, 26 deletions
diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/core/runtime/adaptor/package.html b/bundles/org.eclipse.osgi/container/src/org/eclipse/core/runtime/adaptor/package.html
index 65b481997..c801ee0cc 100644
--- a/bundles/org.eclipse.osgi/container/src/org/eclipse/core/runtime/adaptor/package.html
+++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/core/runtime/adaptor/package.html
@@ -10,8 +10,8 @@ Provides API to start the platform.
Package Specification</h2>
This package specifies API to start the platform.
<p>
-Clients may use the <tt>EclipseStarter</tt> loader class to start the platform. The
-<tt>EclipseStarter</tt> class is the only defined API in this package.
+Clients may use the <code>EclipseStarter</code> loader class to start the platform. The
+<code>EclipseStarter</code> class is the only defined API in this package.
</p>
</body>
</html>
diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/service/resolver/Resolver.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/service/resolver/Resolver.java
index a92c48268..1544f1f42 100644
--- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/service/resolver/Resolver.java
+++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/service/resolver/Resolver.java
@@ -43,10 +43,10 @@ public interface Resolver {
* resolution.
* </p>
* @param discard the list of bundles to discard the resolve status and
- * reresolve. A <tt>null</tt> value indicates that all currently unresolved
+ * reresolve. A <code>null</code> value indicates that all currently unresolved
* bundles in the state should be resolved.
* @param platformProperties the platform properties used to match platform filters
- * against. A <tt>null</tt> value indicates that the system properties should
+ * against. A <code>null</code> value indicates that the system properties should
* be used to match against
*/
public void resolve(BundleDescription[] discard, Dictionary<Object, Object>[] platformProperties);
diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/service/resolver/State.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/service/resolver/State.java
index f58efa436..7608abe69 100644
--- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/service/resolver/State.java
+++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/service/resolver/State.java
@@ -309,12 +309,12 @@ public interface State {
* To ensure that this state and the given resovler are properly linked,
* the following expression must be included in this method if the given
* resolver (value) is not identical to the result of this.getResolver().
+ * </p>
*
* <pre>
* if (this.getResolver() != value) value.setState(this);
* </pre>
*
- * </p>
*/
// TODO what happens if you set the Resolver after some bundles have
// been added to the state but it is not resolved? Should setting
@@ -510,9 +510,8 @@ public interface State {
* <li>org.osgi.framework.language - the language being used. This property is used to resolve the language attribute
* of bundle native code (i.e. Bundle-NativeCode).</li>
* </ul>
- * <p>
- * The values used for the supported properties can be <tt>String</tt> type
- * to specify a single value for the property or they can by <tt>String[]</tt>
+ * The values used for the supported properties can be <code>String</code> type
+ * to specify a single value for the property or they can by <code>String[]</code>
* to specify a list of values for the property.
* @param platformProperties the platform properties of the state
* @return false if the platformProperties specified do not change any of the
diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/service/resolver/VersionRange.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/service/resolver/VersionRange.java
index 87e25f9be..ec61c4088 100644
--- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/service/resolver/VersionRange.java
+++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/service/resolver/VersionRange.java
@@ -42,7 +42,7 @@ public class VersionRange extends org.osgi.framework.VersionRange {
* is used.
*/
public VersionRange(Version minVersion, boolean includeMin, Version maxVersion, boolean includeMax) {
- super(includeMin ? INCLUDE_MIN : EXCLUDE_MIN, minVersion == null ? Version.emptyVersion : minVersion, versionMax.equals(maxVersion) ? null : maxVersion, includeMax ? INCLUDE_MAX : EXCLUDE_MAX);
+ super(includeMin ? INCLUDE_MIN : EXCLUDE_MIN, minVersion == null ? Version.emptyVersion : minVersion, versionMax.equals(maxVersion) ? null : maxVersion, includeMax ? INCLUDE_MAX : EXCLUDE_MAX);
}
/**
@@ -50,6 +50,7 @@ public class VersionRange extends org.osgi.framework.VersionRange {
*
* <p>
* Here is the grammar for version range strings.
+ * </p>
* <pre>
* version-range ::= interval | atleast
* interval ::= ( include-min | exclude-min ) min-version ',' max-version ( include-max | exclude-max )
@@ -61,7 +62,6 @@ public class VersionRange extends org.osgi.framework.VersionRange {
* include-max ::= ']'
* exclude-max ::= ')'
* </pre>
- * </p>
*
* @param versionRange string representation of the version range or <code>null</code>
* for the empty range "0.0.0"
diff --git a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/util/TextProcessor.java b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/util/TextProcessor.java
index 66e79e80e..4b6706597 100644
--- a/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/util/TextProcessor.java
+++ b/bundles/org.eclipse.osgi/container/src/org/eclipse/osgi/util/TextProcessor.java
@@ -111,14 +111,15 @@ public class TextProcessor {
* to the provided delimiters. Each segment has the Unicode BiDi algorithm
* applied to it, but as a whole, the string is oriented left to right.
* <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> when using the Unicode BiDi
+ * <code>d:\myFolder\REDLOF\ELIFYM.java</code> when using the Unicode BiDi
* algorithm and segmenting the string according to the specified delimiter
* set.
* </p>
* <p>
* The following algorithm is used:
+ * </p>
* <ol>
* <li>Scan the string to locate the delimiters.</li>
* <li>While scanning, note the direction of the last strong character
@@ -135,7 +136,6 @@ public class TextProcessor {
* LRE/PDF if the string begins with an LTR letter, contains no RTL letter,
* and ends with either a LTR letter or a digit.</li>
* </ol>
- * </p>
* <p>
* NOTE: this method will change the shape of the original string passed in
* by inserting punctuation characters into the text in order to make it
diff --git a/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/framework/log/package.html b/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/framework/log/package.html
index a4db43cbc..bcfa10ae7 100644
--- a/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/framework/log/package.html
+++ b/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/framework/log/package.html
@@ -5,10 +5,10 @@
<title>Package-level Javadoc</title>
</head>
<body>
-Provides the <tt>FrameworkLog</tt> service.
+Provides the <code>FrameworkLog</code> service.
<h2>
Package Specification</h2>
-This package specifies the API for the <tt>FrameworkLog</tt> service.
+This package specifies the API for the <code>FrameworkLog</code> service.
<p>
Clients needing to log entries to the eclipse log will likely be interested
in the types provided by this package.
diff --git a/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/service/datalocation/package.html b/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/service/datalocation/package.html
index 35cb61c5e..2f2b8ff38 100644
--- a/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/service/datalocation/package.html
+++ b/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/service/datalocation/package.html
@@ -5,10 +5,10 @@
<title>Package-level Javadoc</title>
</head>
<body>
-Provides the <tt>Location</tt> service.
+Provides the <code>Location</code> service.
<h2>
Package Specification</h2>
-This package specifies the API for the <tt>Location</tt> service.
+This package specifies the API for the <code>Location</code> service.
<p>
Clients accessing the configuration, install, instance or user locations will likely be interested
in the types provided by this package.
diff --git a/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/service/debug/package.html b/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/service/debug/package.html
index 8c32c76e5..f07fd5108 100644
--- a/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/service/debug/package.html
+++ b/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/service/debug/package.html
@@ -5,10 +5,10 @@
<title>Package-level Javadoc</title>
</head>
<body>
-Provides the <tt>DebugOptions</tt> service.
+Provides the <code>DebugOptions</code> service.
<h2>
Package Specification</h2>
-This package specifies the API for the <tt>DebugOptions</tt> service.
+This package specifies the API for the <code>DebugOptions</code> service.
<p>
Clients accessing debug and trace options will likely be interested
in the types provided by this package.
diff --git a/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/service/environment/package.html b/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/service/environment/package.html
index ef6f90466..0e5415630 100644
--- a/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/service/environment/package.html
+++ b/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/service/environment/package.html
@@ -5,10 +5,10 @@
<title>Package-level Javadoc</title>
</head>
<body>
-Provides the <tt>EnvironmentInfo</tt> service.
+Provides the <code>EnvironmentInfo</code> service.
<h2>
Package Specification</h2>
-This package specifies the API for the <tt>EnvironmentInfo</tt> service.
+This package specifies the API for the <code>EnvironmentInfo</code> service.
<p>
Clients accessing the command line used to start the running framework
as well as information about the environment will likely be interested
diff --git a/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/service/localization/package.html b/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/service/localization/package.html
index 07ddb0021..1a354a226 100644
--- a/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/service/localization/package.html
+++ b/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/service/localization/package.html
@@ -8,8 +8,8 @@
Provides bundle localization and local provider service APIs.
<h2>
Package Specification</h2>
-This package specifies the API for the <tt>BundleLocalization</tt> and
-<tt>LocalePrivder</tt> services.
+This package specifies the API for the <code>BundleLocalization</code> and
+<code>LocalePrivder</code> services.
<p>
Clients accessing the localization resource bundles use to localize
OSGi bundle manifests will likely be interested in the types provided
diff --git a/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/util/ManifestElement.java b/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/util/ManifestElement.java
index 0e1e2e97c..fed59f10b 100644
--- a/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/util/ManifestElement.java
+++ b/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/util/ManifestElement.java
@@ -125,7 +125,7 @@ public class ManifestElement {
* test1.jar;test2.jar;test3.jar;selection-filter="(os.name=Windows XP)"
* </pre>
* <p>
- * This manifest element has a value of <tt>test1.jar;test2.jar;test3.jar</tt>
+ * This manifest element has a value of <code>test1.jar;test2.jar;test3.jar</code>
* </p>
*
* @return the value of the manifest element.
diff --git a/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/util/NLS.java b/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/util/NLS.java
index 3e2e5069b..6660e46f0 100644
--- a/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/util/NLS.java
+++ b/bundles/org.eclipse.osgi/supplement/src/org/eclipse/osgi/util/NLS.java
@@ -19,7 +19,12 @@ import java.lang.reflect.Field;
import java.lang.reflect.Modifier;
import java.security.AccessController;
import java.security.PrivilegedAction;
-import java.util.*;
+import java.util.ArrayList;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Locale;
+import java.util.Map;
+import java.util.Properties;
import org.eclipse.osgi.framework.log.FrameworkLog;
import org.eclipse.osgi.framework.log.FrameworkLogEntry;
import org.eclipse.osgi.internal.util.SupplementDebug;
@@ -131,12 +136,12 @@ public abstract class NLS {
* For example, if the locale is set to en_US and <code>org.eclipse.example.nls.messages</code>
* is used as the base name then the following resources will be searched using the class
* loader of the specified class:
+ * </p>
* <pre>
* org/eclipse/example/nls/messages_en_US.properties
* org/eclipse/example/nls/messages_en.properties
* org/eclipse/example/nls/messages.properties
* </pre>
- * </p>
*
* @param baseName the base name of a fully qualified message properties file.
* @param clazz the class where the constants will exist

Back to the top