Skip to main content
aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAlexander Kurtakov2019-02-14 15:44:21 +0000
committerAlexander Kurtakov2019-02-14 17:13:14 +0000
commit9fdf973fb0b9646f922124543c4322caab3d4219 (patch)
tree8e89fd06ea1060adb09df73824eaa3c8a45b740f
parent4ff90b5fd966edfb4d8933fa9d245b3b8b19e174 (diff)
downloadeclipse.platform.runtime-9fdf973fb0b9646f922124543c4322caab3d4219.tar.gz
eclipse.platform.runtime-9fdf973fb0b9646f922124543c4322caab3d4219.tar.xz
eclipse.platform.runtime-9fdf973fb0b9646f922124543c4322caab3d4219.zip
Bug 543933 - Build javadocs with Java 11I20190215-0630I20190215-0055I20190214-1800
Fix javadoc warnings catched by Java 11 tool with XDoclint:html and missed in the previous round. Change-Id: Ic90ab89c2c6365019d8ba490e33ae6cc8fe3d110 Signed-off-by: Alexander Kurtakov <akurtako@redhat.com>
-rw-r--r--bundles/org.eclipse.core.contenttype/src/org/eclipse/core/runtime/content/IContentType.java2
-rw-r--r--bundles/org.eclipse.e4.core.contexts/src/org/eclipse/e4/core/contexts/ContextInjectionFactory.java44
-rw-r--r--bundles/org.eclipse.e4.core.di.annotations/META-INF/MANIFEST.MF2
-rw-r--r--bundles/org.eclipse.e4.core.di.annotations/pom.xml2
-rw-r--r--bundles/org.eclipse.e4.core.di.annotations/src/org/eclipse/e4/core/di/annotations/Optional.java28
5 files changed, 43 insertions, 35 deletions
diff --git a/bundles/org.eclipse.core.contenttype/src/org/eclipse/core/runtime/content/IContentType.java b/bundles/org.eclipse.core.contenttype/src/org/eclipse/core/runtime/content/IContentType.java
index e2ca55870..c0946681f 100644
--- a/bundles/org.eclipse.core.contenttype/src/org/eclipse/core/runtime/content/IContentType.java
+++ b/bundles/org.eclipse.core.contenttype/src/org/eclipse/core/runtime/content/IContentType.java
@@ -46,7 +46,7 @@ public interface IContentType extends IContentTypeSettings {
int FILE_EXTENSION_SPEC = 0b1000;
/**
* File spec type constant, indicating a file name pattern specification.
- * <code>?</code> represents any single character, <code>*<code> represent any
+ * <code>?</code> represents any single character, <code>*</code> represent any
* string.
*
* @since 3.7
diff --git a/bundles/org.eclipse.e4.core.contexts/src/org/eclipse/e4/core/contexts/ContextInjectionFactory.java b/bundles/org.eclipse.e4.core.contexts/src/org/eclipse/e4/core/contexts/ContextInjectionFactory.java
index 21105f2f2..c44e834f6 100644
--- a/bundles/org.eclipse.e4.core.contexts/src/org/eclipse/e4/core/contexts/ContextInjectionFactory.java
+++ b/bundles/org.eclipse.e4.core.contexts/src/org/eclipse/e4/core/contexts/ContextInjectionFactory.java
@@ -25,34 +25,40 @@ import org.eclipse.e4.core.internal.contexts.ContextObjectSupplier;
import org.eclipse.e4.core.internal.contexts.EclipseContext;
/**
- * An injection factory is used to inject data and services from a context into a domain object. The
- * injection will try to find fields and methods in the user objects that correspond to the names of
- * the services present in the context. Subsequent changes to the context after injection will cause
- * the affected items to be re-injected into the object. Thus the object will remain synchronized
- * with the context once it has been injected.
+ * An injection factory is used to inject data and services from a context into
+ * a domain object. The injection will try to find fields and methods in the
+ * user objects that correspond to the names of the services present in the
+ * context. Subsequent changes to the context after injection will cause the
+ * affected items to be re-injected into the object. Thus the object will remain
+ * synchronized with the context once it has been injected.
* <p>
- * If annotations are supported by the runtime, matching of methods and fields to be injected is
- * also performed using the annotations defined in packages javax.inject and
- * org.eclipse.e4.core.di.annotations.
+ * If annotations are supported by the runtime, matching of methods and fields
+ * to be injected is also performed using the annotations defined in packages
+ * javax.inject and org.eclipse.e4.core.di.annotations.
* </p>
* <p>
- * The injection of values is generally done as a number of calls. User objects that want to
- * finalize the injected data (for instance, to perform calculations based on multiple injected
- * values) can place such calculations in a method with the <tt>javax.annotation.PostConstruct</tt> annotation.
+ * The injection of values is generally done as a number of calls. User objects
+ * that want to finalize the injected data (for instance, to perform
+ * calculations based on multiple injected values) can place such calculations
+ * in a method with the <code>javax.annotation.PostConstruct</code> annotation.
* </p>
* <p>
- * When injecting values, all fields are injected prior to injection of methods. When values are
- * removed from the context or the context is disposed, injection of null values occurs in the
- * reverse order: methods and then fields. As a result, injection methods can safely make use of
- * injected field values. The order in which methods are injected is undefined, so
- * injection methods should not rely on other injection methods having been run already. Methods
- * and field on superclasses are injected before methods in fields on the subclasses.
+ * When injecting values, all fields are injected prior to injection of methods.
+ * When values are removed from the context or the context is disposed,
+ * injection of null values occurs in the reverse order: methods and then
+ * fields. As a result, injection methods can safely make use of injected field
+ * values. The order in which methods are injected is undefined, so injection
+ * methods should not rely on other injection methods having been run already.
+ * Methods and field on superclasses are injected before methods in fields on
+ * the subclasses.
* </p>
* <p>
- * When a context is disposed, the injection factory will attempt to notify all injected objects by
- * calling methods with the <tt>javax.annotation.PreDestroy</tt> annotation.
+ * When a context is disposed, the injection factory will attempt to notify all
+ * injected objects by calling methods with the
+ * <code>javax.annotation.PreDestroy</code> annotation.
*
* This class is not intended to be extended by clients.
+ *
* @noinstantiate This class is not intended to be instantiated by clients.
* @since 1.3
*/
diff --git a/bundles/org.eclipse.e4.core.di.annotations/META-INF/MANIFEST.MF b/bundles/org.eclipse.e4.core.di.annotations/META-INF/MANIFEST.MF
index e337bfaeb..103542843 100644
--- a/bundles/org.eclipse.e4.core.di.annotations/META-INF/MANIFEST.MF
+++ b/bundles/org.eclipse.e4.core.di.annotations/META-INF/MANIFEST.MF
@@ -2,7 +2,7 @@ Manifest-Version: 1.0
Bundle-ManifestVersion: 2
Bundle-Name: %Bundle-Name
Bundle-SymbolicName: org.eclipse.e4.core.di.annotations
-Bundle-Version: 1.6.200.qualifier
+Bundle-Version: 1.6.300.qualifier
Bundle-RequiredExecutionEnvironment: JavaSE-1.8
Export-Package: org.eclipse.e4.core.di.annotations;version="1.6.0"
Import-Package: javax.inject;version="1.0.0"
diff --git a/bundles/org.eclipse.e4.core.di.annotations/pom.xml b/bundles/org.eclipse.e4.core.di.annotations/pom.xml
index 827440114..d81a6c4e0 100644
--- a/bundles/org.eclipse.e4.core.di.annotations/pom.xml
+++ b/bundles/org.eclipse.e4.core.di.annotations/pom.xml
@@ -19,6 +19,6 @@
</parent>
<groupId>org.eclipse.e4</groupId>
<artifactId>org.eclipse.e4.core.di.annotations</artifactId>
- <version>1.6.200-SNAPSHOT</version>
+ <version>1.6.300-SNAPSHOT</version>
<packaging>eclipse-plugin</packaging>
</project>
diff --git a/bundles/org.eclipse.e4.core.di.annotations/src/org/eclipse/e4/core/di/annotations/Optional.java b/bundles/org.eclipse.e4.core.di.annotations/src/org/eclipse/e4/core/di/annotations/Optional.java
index 9cb82ea4a..8046465a5 100644
--- a/bundles/org.eclipse.e4.core.di.annotations/src/org/eclipse/e4/core/di/annotations/Optional.java
+++ b/bundles/org.eclipse.e4.core.di.annotations/src/org/eclipse/e4/core/di/annotations/Optional.java
@@ -24,31 +24,33 @@ import java.lang.annotation.Target;
import javax.inject.Qualifier;
/**
- * This annotation can be applied to methods, fields, and parameters to
- * mark them as optional for the dependency injection. Typically, if the injector is
- * unable to find a value to inject, then injection will fail. However if a value cannot be found
- * and if this annotation is specified, then:
+ * This annotation can be applied to methods, fields, and parameters to mark
+ * them as optional for the dependency injection. Typically, if the injector is
+ * unable to find a value to inject, then injection will fail. However if a
+ * value cannot be found and if this annotation is specified, then:
* <ul>
- * <li> for parameters: a <code>null</code> value will be injected; </li>
- * <li> for methods: the method calls will be skipped; </li>
- * <li> for fields: the values will not be injected. </li>
+ * <li>for parameters: a <code>null</code> value will be injected;</li>
+ * <li>for methods: the method calls will be skipped;</li>
+ * <li>for fields: the values will not be injected.</li>
* </ul>
*
* <p>
* Note that {@code null} is as an acceptable value and is not the same as a
- * value not being found. For example, the {@code IEclipseContext}-based supplier distinguishes
- * between a value being set to null (i.e., {@code context.set(SOMEKEY, null)})
- * and the value not found (i.e., {@code context.remove(SOMEKEY)}).
+ * value not being found. For example, the {@code IEclipseContext}-based
+ * supplier distinguishes between a value being set to null (i.e.,
+ * {@code context.set(SOMEKEY, null)}) and the value not found (i.e.,
+ * {@code context.remove(SOMEKEY)}).
* </p>
*
- * <p>Example usage:
+ * Example usage:
+ *
* <pre>
* public class Car {
* &#064;Inject &#064;Optional void setOverdrive(OverdriveMode mode);
* ...
* }
- * </pre>
- * </p>
+ * </pre>
+ *
* @since 1.3
*/
@Qualifier

Back to the top