diff options
author | Eike Stepper | 2016-09-05 16:40:21 +0000 |
---|---|---|
committer | Eike Stepper | 2016-09-05 16:40:21 +0000 |
commit | 1451fb0c470b36f1afcd6a83f1efd6cf8eff58cf (patch) | |
tree | 076fc3412e3edc305d4853c71cd5a0948c91192f /plugins/org.eclipse.net4j.util/src/org | |
parent | 09bac6a84cc74853a80ed1c257aba5e3106b4199 (diff) | |
download | cdo-1451fb0c470b36f1afcd6a83f1efd6cf8eff58cf.tar.gz cdo-1451fb0c470b36f1afcd6a83f1efd6cf8eff58cf.tar.xz cdo-1451fb0c470b36f1afcd6a83f1efd6cf8eff58cf.zip |
[Releng] Regenerate documentation
Diffstat (limited to 'plugins/org.eclipse.net4j.util/src/org')
8 files changed, 43 insertions, 42 deletions
diff --git a/plugins/org.eclipse.net4j.util/src/org/eclipse/net4j/util/ObjectUtil.java b/plugins/org.eclipse.net4j.util/src/org/eclipse/net4j/util/ObjectUtil.java index 7f12b4f986..3167ecb870 100644 --- a/plugins/org.eclipse.net4j.util/src/org/eclipse/net4j/util/ObjectUtil.java +++ b/plugins/org.eclipse.net4j.util/src/org/eclipse/net4j/util/ObjectUtil.java @@ -57,7 +57,7 @@ public final class ObjectUtil } /** - * A collision-free hash code for small sets (<=4) of small, positive integers (<=128) + * A collision-free hash code for small sets (<=4) of small, positive integers (<=128) * * @since 3.2 */ diff --git a/plugins/org.eclipse.net4j.util/src/org/eclipse/net4j/util/concurrent/RWOLockManager.java b/plugins/org.eclipse.net4j.util/src/org/eclipse/net4j/util/concurrent/RWOLockManager.java index 565ba7925d..15d29abeb6 100644 --- a/plugins/org.eclipse.net4j.util/src/org/eclipse/net4j/util/concurrent/RWOLockManager.java +++ b/plugins/org.eclipse.net4j.util/src/org/eclipse/net4j/util/concurrent/RWOLockManager.java @@ -437,12 +437,14 @@ public class RWOLockManager<OBJECT, CONTEXT> extends Lifecycle implements IRWOLo * enum {@link IRWLockManager.LockType} * <p> * The locking semantics established by this class are as follows: - * <li>a read lock prevents a write lock by another, but allows read locks by others and allows a write option by - * another, and is therefore <b>non-exclusive</b></li> - * <li>a write lock prevents read locks by others, a write lock by another, and a write option by another, and is - * therefore <b>exclusive</b></li> - * <li>a write option prevents write locks by others and a write option by another, but allows read locks by others, - * and is therefore <b>exclusive</b></li>. + * <ul> + * <li>A read lock prevents a write lock by another, but allows read locks by others and allows a write option by + * another, and is therefore <b>non-exclusive</b>. + * <li>A write lock prevents read locks by others, a write lock by another, and a write option by another, and is + * therefore <b>exclusive</b>. + * <li>A write option prevents write locks by others and a write option by another, but allows read locks by others, + * and is therefore <b>exclusive</b>. + * </ul> * * @author Caspar De Groot * @since 3.2 diff --git a/plugins/org.eclipse.net4j.util/src/org/eclipse/net4j/util/factory/FactoryDescriptor.java b/plugins/org.eclipse.net4j.util/src/org/eclipse/net4j/util/factory/FactoryDescriptor.java index 8559671935..ea043a7556 100644 --- a/plugins/org.eclipse.net4j.util/src/org/eclipse/net4j/util/factory/FactoryDescriptor.java +++ b/plugins/org.eclipse.net4j.util/src/org/eclipse/net4j/util/factory/FactoryDescriptor.java @@ -21,12 +21,12 @@ import org.eclipse.core.runtime.IExtensionRegistry; * * <pre> * <extension - * point="org.eclipse.net4j.util.factories"> + * point="org.eclipse.net4j.util.factories"> * <factory * class="org.eclipse.net4j.util.concurrent.TimerLifecycle$DaemonFactory" * productGroup="org.eclipse.net4j.util.timers" - * type="daemon"/> - * </extension> + * type="daemon"/> + * </extension> * </pre> * * @author Eike Stepper diff --git a/plugins/org.eclipse.net4j.util/src/org/eclipse/net4j/util/om/monitor/ProbingSubMonitor.java b/plugins/org.eclipse.net4j.util/src/org/eclipse/net4j/util/om/monitor/ProbingSubMonitor.java index 8267e0bcf1..c79c4693e0 100644 --- a/plugins/org.eclipse.net4j.util/src/org/eclipse/net4j/util/om/monitor/ProbingSubMonitor.java +++ b/plugins/org.eclipse.net4j.util/src/org/eclipse/net4j/util/om/monitor/ProbingSubMonitor.java @@ -72,11 +72,11 @@ import java.util.concurrent.atomic.AtomicInteger; * <p> * Example of the probing mode {@link SubMonitor.ProbingMode#STANDARD STANDARD}: * <p> - * <img src="doc-files/standard.png"> + * <img src="doc-files/standard.png" alt="standard.png"> * <p> * Example of the probing mode {@link SubMonitor.ProbingMode#FULL FULL}: * <p> - * <img src="doc-files/full.png"> + * <img src="doc-files/full.png" alt="full.png"> * <p> * The tables in the two examples above have smooth borders that can only be displayed correctly in consoles with UTF-8 encoding. The console encoding * can be configured on the <i>Common</i> tab of the launch configuration dialog. In addition the rendering of smooth table borders must be explicitly enabled diff --git a/plugins/org.eclipse.net4j.util/src/org/eclipse/net4j/util/om/monitor/SubMonitor.java b/plugins/org.eclipse.net4j.util/src/org/eclipse/net4j/util/om/monitor/SubMonitor.java index 34d76762e6..1926c46aa5 100644 --- a/plugins/org.eclipse.net4j.util/src/org/eclipse/net4j/util/om/monitor/SubMonitor.java +++ b/plugins/org.eclipse.net4j.util/src/org/eclipse/net4j/util/om/monitor/SubMonitor.java @@ -708,7 +708,7 @@ public 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) { @@ -724,7 +724,7 @@ public class SubMonitor implements IProgressMonitorWithBlocking * void myMethod(IProgressMonitor parent) { * SubMonitor progress = SubMonitor.convert(parent, 100); * - * for (int i = 0; i < 100; i++) { + * for (int i = 0; i < 100; i++) { * // Creating the next child monitor will clean up the previous one, * // causing progress to be reported smoothly even if we don't do anything * // with the monitors we create @@ -749,7 +749,7 @@ public 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 * @return new sub progress monitor that may be used in place of a new SubMonitor @@ -773,7 +773,7 @@ public 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) { @@ -789,7 +789,7 @@ public class SubMonitor implements IProgressMonitorWithBlocking * void myMethod(IProgressMonitor parent) { * SubMonitor progress = SubMonitor.convert(parent, 100); * - * for (int i = 0; i < 100; i++) { + * for (int i = 0; i < 100; i++) { * // Creating the next child monitor will clean up the previous one, * // causing progress to be reported smoothly even if we don't do anything * // with the monitors we create @@ -814,7 +814,7 @@ public 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 * @return new sub progress monitor that may be used in place of a new SubMonitor diff --git a/plugins/org.eclipse.net4j.util/src/org/eclipse/net4j/util/om/trace/PrintTraceHandler.java b/plugins/org.eclipse.net4j.util/src/org/eclipse/net4j/util/om/trace/PrintTraceHandler.java index bf5af4ca97..37904ed082 100644 --- a/plugins/org.eclipse.net4j.util/src/org/eclipse/net4j/util/om/trace/PrintTraceHandler.java +++ b/plugins/org.eclipse.net4j.util/src/org/eclipse/net4j/util/om/trace/PrintTraceHandler.java @@ -58,16 +58,16 @@ public class PrintTraceHandler implements OMTraceHandler * Pattern arguments: * <p> * <ul> - * <li>{0} --> String <b>tracerName</b> - * <li>{1} --> String <b>tracerShort</b> - * <li>{2} --> String <b>contextName</b> - * <li>{3} --> String <b>contextShort</b> - * <li>{4} --> long <b>timeStamp</b> - * <li>{5} --> String <b>message</b> - * <li>{6} --> String <b>threadName</b> - * <li>{7} --> long <b>threadID</b> - * <li>{8} --> int <b>threadPriority</b> - * <li>{9} --> Thread.State <b>threadState</b> + * <li>{0} → String <b>tracerName</b> + * <li>{1} → String <b>tracerShort</b> + * <li>{2} → String <b>contextName</b> + * <li>{3} → String <b>contextShort</b> + * <li>{4} → long <b>timeStamp</b> + * <li>{5} → String <b>message</b> + * <li>{6} → String <b>threadName</b> + * <li>{7} → long <b>threadID</b> + * <li>{8} → int <b>threadPriority</b> + * <li>{9} → Thread.State <b>threadState</b> * </ul> */ public void setPattern(String pattern) @@ -106,16 +106,16 @@ public class PrintTraceHandler implements OMTraceHandler * Pattern arguments: * <p> * <ul> - * <li>{0} --> String <b>tracerName</b> - * <li>{1} --> String <b>tracerShort</b> - * <li>{2} --> String <b>contextName</b> - * <li>{3} --> String <b>contextShort</b> - * <li>{4} --> long <b>timeStamp</b> - * <li>{5} --> String <b>message</b> - * <li>{6} --> String <b>threadName</b> - * <li>{7} --> long <b>threadID</b> - * <li>{8} --> int <b>threadPriority</b> - * <li>{9} --> Thread.State <b>threadState</b> + * <li>{0} → String <b>tracerName</b> + * <li>{1} → String <b>tracerShort</b> + * <li>{2} → String <b>contextName</b> + * <li>{3} → String <b>contextShort</b> + * <li>{4} → long <b>timeStamp</b> + * <li>{5} → String <b>message</b> + * <li>{6} → String <b>threadName</b> + * <li>{7} → long <b>threadID</b> + * <li>{8} → int <b>threadPriority</b> + * <li>{9} → Thread.State <b>threadState</b> * </ul> */ public static String format(String pattern, OMTraceHandlerEvent event) diff --git a/plugins/org.eclipse.net4j.util/src/org/eclipse/net4j/util/ref/Interner.java b/plugins/org.eclipse.net4j.util/src/org/eclipse/net4j/util/ref/Interner.java index c888d28828..316f1ca161 100644 --- a/plugins/org.eclipse.net4j.util/src/org/eclipse/net4j/util/ref/Interner.java +++ b/plugins/org.eclipse.net4j.util/src/org/eclipse/net4j/util/ref/Interner.java @@ -20,7 +20,7 @@ import java.lang.ref.WeakReference; public class Interner<E> { private static final int[] PRIME_CAPACITIES = new int[] { 17, 37, 67, 131, 257, 521, 1031, 2053, 4099, 8209, 16411, - 32771, 65537, 131101, 262147, 524309, 1048583, 2097169, 4194319, 8388617, 16777259, 33554467, 67108879, 134217757, + 32771, 65537, 131101, 262147, 524309, 1048583, 2097169, 4194319, 8388617, 16777259, 33554467, 67108879, 134217757, 268435459, 536870923, 1073741827, 2147483629 }; private int size; @@ -119,8 +119,7 @@ public class Interner<E> /** * Returns true if the two objects are to be considered equal. - * The first object will always be the one passed in as an argument to {@link #add(Object) add}, - * {@link #contains(Object) contains}, {@link #get(Object) get}, {@link #intern(Object)}, {@link #remove(Object)}. + * The first object will always be the one passed in as an argument to {@link #intern(Object)}. */ protected boolean equals(E object, E otherObject) { diff --git a/plugins/org.eclipse.net4j.util/src/org/eclipse/net4j/util/registry/package-info.java b/plugins/org.eclipse.net4j.util/src/org/eclipse/net4j/util/registry/package-info.java index c9f4f973ce..969df1ca4d 100644 --- a/plugins/org.eclipse.net4j.util/src/org/eclipse/net4j/util/registry/package-info.java +++ b/plugins/org.eclipse.net4j.util/src/org/eclipse/net4j/util/registry/package-info.java @@ -13,6 +13,6 @@ * are to be instantiated lazily * <li>It provides a notification framework that enables clients to * react on events (including the resolution of a lazy descriptor) - * <ul> + * </ul> */ package org.eclipse.net4j.util.registry; |