Bug 548250 - Javadoc problems in platform.runtime Change-Id: I53b971799d139d4ed393a8a82947f18bf4c02712 Signed-off-by: Paul Pazderski <paul-eclipse@ppazderski.de>
diff --git a/bundles/org.eclipse.core.expressions/src/org/eclipse/core/internal/expressions/Expressions.java b/bundles/org.eclipse.core.expressions/src/org/eclipse/core/internal/expressions/Expressions.java index 0f6de72..cd65153 100644 --- a/bundles/org.eclipse.core.expressions/src/org/eclipse/core/internal/expressions/Expressions.java +++ b/bundles/org.eclipse.core.expressions/src/org/eclipse/core/internal/expressions/Expressions.java
@@ -41,7 +41,7 @@ public class Expressions { /** - * Cache to optimize instanceof computation. Weak Map of Class->Map(String, Boolean). Avoid + * Cache to optimize instanceof computation. Weak Map of Class->Map(String, Boolean). Avoid * conflicts caused by multiple classloader contributions with the same class name. It's a rare * occurrence but is supported by the OSGi classloader. */ @@ -211,7 +211,7 @@ * @param var the variable to turn into an <code>IIterable</code> * @param expression the expression referring to the variable * - * @return the <code>IIterable</code> or <code>null<code> if a corresponding adapter isn't loaded yet + * @return the <code>IIterable</code> or <code>null</code> if a corresponding adapter isn't loaded yet * * @throws CoreException if the var can't be adapted to an <code>IIterable</code> */ @@ -240,7 +240,7 @@ * @param var the variable to turn into an <code>ICountable</code> * @param expression the expression referring to the variable * - * @return the <code>ICountable</code> or <code>null<code> if a corresponding adapter isn't loaded yet + * @return the <code>ICountable</code> or <code>null</code> if a corresponding adapter isn't loaded yet * * @throws CoreException if the var can't be adapted to an <code>ICountable</code> */
diff --git a/bundles/org.eclipse.core.expressions/src/org/eclipse/core/internal/expressions/propertytester/PlatformPropertyTester.java b/bundles/org.eclipse.core.expressions/src/org/eclipse/core/internal/expressions/propertytester/PlatformPropertyTester.java index 944c39e..7c36e9d 100644 --- a/bundles/org.eclipse.core.expressions/src/org/eclipse/core/internal/expressions/propertytester/PlatformPropertyTester.java +++ b/bundles/org.eclipse.core.expressions/src/org/eclipse/core/internal/expressions/propertytester/PlatformPropertyTester.java
@@ -25,11 +25,13 @@ * not a given bundle is installed in the running environment, as well as * the id of the currently active product. * <p> - * For example:<br /> - * <test property="org.eclipse.core.runtime.product" value="org.eclipse.sdk.ide"/> <br /> - * <test property="org.eclipse.core.runtime.isBundleInstalled" args="org.eclipse.core.expressions"/> <br /> + * For example: + * </p> + * <pre> + * <test property="org.eclipse.core.runtime.product" value="org.eclipse.sdk.ide"/> + * <test property="org.eclipse.core.runtime.isBundleInstalled" args="org.eclipse.core.expressions"/> * <test property="org.eclipse.core.runtime.bundleState" args="org.eclipse.core.expressions" value="ACTIVE"/> - * <p> + * </pre> */ public class PlatformPropertyTester extends PropertyTester {
diff --git a/bundles/org.eclipse.core.jobs/src/org/eclipse/core/internal/jobs/ImplicitJobs.java b/bundles/org.eclipse.core.jobs/src/org/eclipse/core/internal/jobs/ImplicitJobs.java index 1a6e309..95fb897 100644 --- a/bundles/org.eclipse.core.jobs/src/org/eclipse/core/internal/jobs/ImplicitJobs.java +++ b/bundles/org.eclipse.core.jobs/src/org/eclipse/core/internal/jobs/ImplicitJobs.java
@@ -41,7 +41,7 @@ private final Set<ISchedulingRule> suspendedRules = new HashSet<>(20); /** - * Maps (Thread->ThreadJob), threads to the currently running job for that + * Maps (Thread->ThreadJob), threads to the currently running job for that * thread. * @GuardedBy("this") */
diff --git a/bundles/org.eclipse.core.jobs/src/org/eclipse/core/internal/jobs/JobManager.java b/bundles/org.eclipse.core.jobs/src/org/eclipse/core/internal/jobs/JobManager.java index 9015b58..f9dece3 100644 --- a/bundles/org.eclipse.core.jobs/src/org/eclipse/core/internal/jobs/JobManager.java +++ b/bundles/org.eclipse.core.jobs/src/org/eclipse/core/internal/jobs/JobManager.java
@@ -43,7 +43,7 @@ * never happen, or a deadlock will occur. To prevent deadlocks, this is the * order that locks must be acquired. * - * WorkerPool -> JobManager.implicitJobs -> JobManager.lock -> + * WorkerPool -> JobManager.implicitJobs -> JobManager.lock -> * InternalJob.jobStateLock or InternalJobGroup.jobGroupStateLock * * @ThreadSafe
diff --git a/bundles/org.eclipse.core.jobs/src/org/eclipse/core/internal/jobs/ThreadJob.java b/bundles/org.eclipse.core.jobs/src/org/eclipse/core/internal/jobs/ThreadJob.java index ddaed08..5b2d7cb 100644 --- a/bundles/org.eclipse.core.jobs/src/org/eclipse/core/internal/jobs/ThreadJob.java +++ b/bundles/org.eclipse.core.jobs/src/org/eclipse/core/internal/jobs/ThreadJob.java
@@ -62,7 +62,7 @@ private ISchedulingRule[] ruleStack; /** * Rule stack pointer. - * INV: 0 <= top <= ruleStack.length + * INV: {@code 0 <= top <= ruleStack.length} * @GuardedBy("JobManager.implicitJobs") */ private int top; @@ -164,15 +164,15 @@ /** * A reentrant method which will run given <code>ThreadJob</code> immediately if there * are no existing jobs with conflicting rules, or block until the rule can be acquired. - * <p> + * <ul> * <li>If given job must block, the <code>LockListener</code> is given a chance to override. * <li>If override is not granted, then this method will block until the rule is available. - * <li>If <code>LockListener#canBlock</code> returns <tt>true</tt>, then the <code>monitor</code> + * <li>If <code>LockListener#canBlock</code> returns <code>true</code>, then the <code>monitor</code> * <i>will not</i> be periodically checked for cancellation. It will only be rechecked if this * thread is interrupted. - * <li>If <code>LockListener#canBlock</code> returns <tt>false</tt> the + * <li>If <code>LockListener#canBlock</code> returns <code>false</code> the * <code>monitor</code> <i>will</i> be checked periodically for cancellation. - * <p> + * </ul> * When a UI is present, it is recommended that the <code>LockListener</code> * should not allow the UI thread to block without checking the <code>monitor</code>. This * ensures that the UI remains responsive.
diff --git a/bundles/org.eclipse.core.runtime/src/org/eclipse/core/internal/runtime/InternalPlatform.java b/bundles/org.eclipse.core.runtime/src/org/eclipse/core/internal/runtime/InternalPlatform.java index 66c13a3..3bdf4cd 100644 --- a/bundles/org.eclipse.core.runtime/src/org/eclipse/core/internal/runtime/InternalPlatform.java +++ b/bundles/org.eclipse.core.runtime/src/org/eclipse/core/internal/runtime/InternalPlatform.java
@@ -633,7 +633,7 @@ /** * Shutdown runtime pieces in this order: - * Content[auto shutdown] -> Preferences[auto shutdown] -> Registry -> Jobs + * Content[auto shutdown] -> Preferences[auto shutdown] -> Registry -> Jobs. * The "auto" shutdown takes place before this code is executed */ public void stop(BundleContext bundleContext) {
diff --git a/bundles/org.eclipse.core.runtime/src/org/eclipse/core/internal/runtime/PerformanceStatsProcessor.java b/bundles/org.eclipse.core.runtime/src/org/eclipse/core/internal/runtime/PerformanceStatsProcessor.java index 514fc93..80e9589 100644 --- a/bundles/org.eclipse.core.runtime/src/org/eclipse/core/internal/runtime/PerformanceStatsProcessor.java +++ b/bundles/org.eclipse.core.runtime/src/org/eclipse/core/internal/runtime/PerformanceStatsProcessor.java
@@ -40,7 +40,7 @@ /** * Event failures that have occurred but have not yet been broadcast. - * Maps (PerformanceStats -> Long). + * Maps (PerformanceStats -> Long). */ private final HashMap<PerformanceStats,Long> failures = new HashMap<>();
diff --git a/bundles/org.eclipse.core.runtime/src/org/eclipse/core/runtime/PerformanceStats.java b/bundles/org.eclipse.core.runtime/src/org/eclipse/core/runtime/PerformanceStats.java index 9d5c8e5..3adce7e 100644 --- a/bundles/org.eclipse.core.runtime/src/org/eclipse/core/runtime/PerformanceStats.java +++ b/bundles/org.eclipse.core.runtime/src/org/eclipse/core/runtime/PerformanceStats.java
@@ -113,7 +113,7 @@ /** * Maximum allowed durations for each event. - * Maps String (event name) -> Long (threshold) + * Maps String (event name) -> Long (threshold) */ private final static Map<String, Long> thresholdMap = Collections.synchronizedMap(new HashMap<String, Long>());
diff --git a/bundles/org.eclipse.core.tools/src/org/eclipse/core/tools/AbstractTreeContentProvider.java b/bundles/org.eclipse.core.tools/src/org/eclipse/core/tools/AbstractTreeContentProvider.java index 80ca866..c7f2adb 100644 --- a/bundles/org.eclipse.core.tools/src/org/eclipse/core/tools/AbstractTreeContentProvider.java +++ b/bundles/org.eclipse.core.tools/src/org/eclipse/core/tools/AbstractTreeContentProvider.java
@@ -77,7 +77,7 @@ * Returns the parent for the given element, or <code>null</code> * indicating that the parent can't be computed. * - * @return <coded>element</code>'s parent node or null, if it is a root node + * @return <code>element</code>'s parent node or null, if it is a root node * @see org.eclipse.jface.viewers.ITreeContentProvider#getParent( * java.lang.Object) * @see org.eclipse.core.tools.TreeContentProviderNode#getParent() @@ -97,7 +97,7 @@ * @return true, if <code>element</code> has children, false otherwise * @see org.eclipse.jface.viewers.ITreeContentProvider#hasChildren( * java.lang.Object) - * @see org.eclipse.core.tools.TreeContentProviderNode#hasChildren() * + * @see org.eclipse.core.tools.TreeContentProviderNode#hasChildren() */ @Override public boolean hasChildren(Object element) {
diff --git a/bundles/org.eclipse.core.tools/src/org/eclipse/core/tools/DeepSize.java b/bundles/org.eclipse.core.tools/src/org/eclipse/core/tools/DeepSize.java index 3187d18..219dd40 100644 --- a/bundles/org.eclipse.core.tools/src/org/eclipse/core/tools/DeepSize.java +++ b/bundles/org.eclipse.core.tools/src/org/eclipse/core/tools/DeepSize.java
@@ -19,15 +19,21 @@ /** * How to use DeepSize: + * + * <pre> + * {@code * DeepSize result= DeepSize.deepSize(anObject); * int size= result.getSize(); // accumulated size of transitive closure of anObject * Hashtable sizes= result.getSizes(); // hashtable of internal results: class name-> sum of shallowsize of instances of class * Hashtable counts= result.getCounts(); // hashtable of internal results: class name -> instances of class + * }</pre> * Additional function + * <pre> * DeepSize d= new DeepSize(); * d.setIgnoreTypeNames(aSet); // don't consider instances of classes named in aSet as part of the size * d.ignore(anObject); // don't consider anObject as part of the size * d.deepCompute(anObject); // advanced compute method - computes the size given the additional ignore configuration + * </pre> */ public class DeepSize { /**
diff --git a/bundles/org.eclipse.e4.core.di.extensions/src/org/eclipse/e4/core/di/extensions/EventTopic.java b/bundles/org.eclipse.e4.core.di.extensions/src/org/eclipse/e4/core/di/extensions/EventTopic.java index d068ded..dcc5eaa 100644 --- a/bundles/org.eclipse.e4.core.di.extensions/src/org/eclipse/e4/core/di/extensions/EventTopic.java +++ b/bundles/org.eclipse.e4.core.di.extensions/src/org/eclipse/e4/core/di/extensions/EventTopic.java
@@ -30,15 +30,14 @@ * </p> * <p> * Example usage: - * + * </p> * <pre> * public class Car { - * @Inject - * @void handle(@Optional @EventTopic("org/eclipse/e4/some/event/topic") Payload payload); + * @Inject + * void handle(@Optional @EventTopic("org/eclipse/e4/some/event/topic") Payload payload); * ... * } * </pre> - * </p> * <p> * The value stored under the event's "org.eclipse.e4.data" property is injected unless * the class of the injected variable is org.osgi.service.event.Event. In that case the whole event
diff --git a/bundles/org.eclipse.e4.core.di.extensions/src/org/eclipse/e4/core/di/extensions/OSGiBundle.java b/bundles/org.eclipse.e4.core.di.extensions/src/org/eclipse/e4/core/di/extensions/OSGiBundle.java index 752cecf..4150452 100644 --- a/bundles/org.eclipse.e4.core.di.extensions/src/org/eclipse/e4/core/di/extensions/OSGiBundle.java +++ b/bundles/org.eclipse.e4.core.di.extensions/src/org/eclipse/e4/core/di/extensions/OSGiBundle.java
@@ -33,6 +33,7 @@ * The {@link org.osgi.framework.Bundle} injected will be the * {@link org.osgi.framework.Bundle} that supplied the class of the object * instance. For example, in: + * </p> * * <pre> * class A { @@ -49,7 +50,6 @@ * {@link org.osgi.framework.BundleContext} for the bundle that supplies class * B, not class A. * - * </p> */ @Qualifier @Documented
diff --git a/bundles/org.eclipse.e4.core.services/src/org/eclipse/e4/core/internal/services/MessageFactoryServiceImpl.java b/bundles/org.eclipse.e4.core.services/src/org/eclipse/e4/core/internal/services/MessageFactoryServiceImpl.java index d2ff300..b772770 100644 --- a/bundles/org.eclipse.e4.core.services/src/org/eclipse/e4/core/internal/services/MessageFactoryServiceImpl.java +++ b/bundles/org.eclipse.e4.core.services/src/org/eclipse/e4/core/internal/services/MessageFactoryServiceImpl.java
@@ -126,15 +126,15 @@ * {@link ResourceBundle}. As there are several options to specify the location of the * {@link ResourceBundle} to load, the following search order is used: * <ol> - * <li>URI location<br/> + * <li>URI location<br> * If the message class is annotated with <code>@Message</code> and the <i>contributorURI</i> * attribute is set, the {@link ResourceBundle} is searched at the specified location</li> - * <li>Relative location<br/> + * <li>Relative location<br> * If the message class is not annotated with <code>@Message</code> and a contributorURI * attribute value or there is no {@link ResourceBundle} found at the specified location, a * {@link ResourceBundle} with the same name in the same package as the message class is * searched.</li> - * <li>Bundle localization<br/> + * <li>Bundle localization<br> * If there is no {@link ResourceBundle} found by URI or relative location, the OSGi * {@link ResourceBundle} configured in the MANIFEST.MF is tried to load.</li> * </ol>
diff --git a/bundles/org.eclipse.e4.core.services/src/org/eclipse/e4/core/internal/services/ResourceBundleHelper.java b/bundles/org.eclipse.e4.core.services/src/org/eclipse/e4/core/internal/services/ResourceBundleHelper.java index 2541840..e780736 100644 --- a/bundles/org.eclipse.e4.core.services/src/org/eclipse/e4/core/internal/services/ResourceBundleHelper.java +++ b/bundles/org.eclipse.e4.core.services/src/org/eclipse/e4/core/internal/services/ResourceBundleHelper.java
@@ -118,6 +118,7 @@ * {@link Locale} out of an OSGi {@link Bundle}. * <p> * Following URIs are supported: + * </p> * <ul> * <li>platform:/[plugin|fragment]/[Bundle-SymbolicName]<br> * Load the OSGi resource bundle out of the bundle/fragment named [Bundle-SymbolicName]</li> @@ -129,7 +130,6 @@ * named [Bundle-SymbolicName]. Note that the class needs to be a subtype of * {@link ResourceBundle}.</li> * </ul> - * </p> * * @param contributionURI * The URI that points to a {@link ResourceBundle} @@ -233,6 +233,7 @@ * <p> * If the value for this system property is set to an empty String the default search order for * ResourceBundles is used: + * </p> * <ul> * <li>bn + Ls + "_" + Cs + "_" + Vs</li> * <li>bn + Ls + "_" + Cs</li> @@ -242,6 +243,7 @@ * <li>bn + Ld</li> * <li>bn</li> * </ul> + * <p> * Where bn is this bundle's localization basename, Ls, Cs and Vs are the specified locale * (language, country, variant) and Ld, Cd and Vd are the default locale (language, country, * variant). @@ -249,6 +251,7 @@ * <p> * If Ls equals the value of <code>equinox.root.locale</code> then the following search order is * used: + * </p> * <ul> * <li>bn + Ls + "_" + Cs + "_" + Vs</li> * <li>bn + Ls + "_" + Cs</li> @@ -259,9 +262,10 @@ * <li>bn + Ld</li> * <li>bn</li> * </ul> - * </p> + * <p> * If <code>equinox.root.locale=en</code> and en_XX or en is asked for then this allows the root * file to be used instead of falling back to the default locale. + * </p> * * @param baseName * the base name of the resource bundle, a fully qualified class name @@ -326,6 +330,7 @@ * <p> * If the value for this system property is set to an empty String the default search order for * ResourceBundles is used: + * </p> * <ul> * <li>bn + Ls + "_" + Cs + "_" + Vs</li> * <li>bn + Ls + "_" + Cs</li> @@ -335,6 +340,7 @@ * <li>bn + Ld</li> * <li>bn</li> * </ul> + * <p> * Where bn is this bundle's localization basename, Ls, Cs and Vs are the specified locale * (language, country, variant) and Ld, Cd and Vd are the default locale (language, country, * variant). @@ -342,6 +348,7 @@ * <p> * If Ls equals the value of <code>equinox.root.locale</code> then the following search order is * used: + * </p> * <ul> * <li>bn + Ls + "_" + Cs + "_" + Vs</li> * <li>bn + Ls + "_" + Cs</li> @@ -352,9 +359,10 @@ * <li>bn + Ld</li> * <li>bn</li> * </ul> - * </p> + * <p> * If <code>equinox.root.locale=en</code> and en_XX or en is asked for then this allows the root * file to be used instead of falling back to the default locale. + * </p> * * @param baseName * the base name of the resource bundle, a fully qualified class name @@ -381,6 +389,7 @@ * <p> * If the value for this system property is set to an empty String the default search order for * ResourceBundles is used: + * </p> * <ul> * <li>bn + Ls + "_" + Cs + "_" + Vs</li> * <li>bn + Ls + "_" + Cs</li> @@ -390,6 +399,7 @@ * <li>bn + Ld</li> * <li>bn</li> * </ul> + * <p> * Where bn is this bundle's localization basename, Ls, Cs and Vs are the specified locale * (language, country, variant) and Ld, Cd and Vd are the default locale (language, country, * variant). @@ -397,6 +407,7 @@ * <p> * If Ls equals the value of <code>equinox.root.locale</code> then the following search order is * used: + * </p> * <ul> * <li>bn + Ls + "_" + Cs + "_" + Vs</li> * <li>bn + Ls + "_" + Cs</li> @@ -407,9 +418,10 @@ * <li>bn + Ld</li> * <li>bn</li> * </ul> - * </p> + * <p> * If <code>equinox.root.locale=en</code> and en_XX or en is asked for then this allows the root * file to be used instead of falling back to the default locale. + * </p> * * @param baseName * the base name of the resource bundle, a fully qualified class name
diff --git a/tests/org.eclipse.core.tests.runtime/src/org/eclipse/core/tests/runtime/jobs/ReadWriteMonitor.java b/tests/org.eclipse.core.tests.runtime/src/org/eclipse/core/tests/runtime/jobs/ReadWriteMonitor.java index 8e2b5bf..ad019e2 100644 --- a/tests/org.eclipse.core.tests.runtime/src/org/eclipse/core/tests/runtime/jobs/ReadWriteMonitor.java +++ b/tests/org.eclipse.core.tests.runtime/src/org/eclipse/core/tests/runtime/jobs/ReadWriteMonitor.java
@@ -25,9 +25,9 @@ private final Set<Thread> blockedThreads = Collections.synchronizedSet(new HashSet<>()); private ILock lock; /** - * <0 : writing (cannot go beyond -1, i.e one concurrent writer) - * =0 : idle - * >0 : reading (number of concurrent readers) + * <0 : writing (cannot go beyond -1, i.e one concurrent writer)<br> + * =0 : idle<br> + * >0 : reading (number of concurrent readers) */ private int status = 0;