Skip to content

Commit 59aa8ee

Browse files
committed
Fix Java 11's new javadoc lint errors
1 parent 3579c62 commit 59aa8ee

4 files changed

Lines changed: 51 additions & 51 deletions

File tree

src/main/java/org/scijava/event/bushe/ThreadSafeEventService.java

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -110,21 +110,21 @@
110110
* Cleanup is pretty rare in general. Not only are stale subscribers cleaned up with regular usage, stale
111111
* subscribers on abandoned topics and classes do not take up a lot of memory, hence, they are allowed to build up to a certain degree.
112112
* Cleanup does not occur until the number of WeakReferences and SubscriptionsProxy's with WeakReference strength
113-
* subscribed to an EventService for all the EventService's subscriptions in total exceed the <tt>cleanupStartThreshhold</tt>,
114-
* which is set to <tt>CLEANUP_START_THRESHOLD_DEFAULT</tt> (500) by default. The default is overridable in the constructor
113+
* subscribed to an EventService for all the EventService's subscriptions in total exceed the <code>cleanupStartThreshhold</code>,
114+
* which is set to <code>CLEANUP_START_THRESHOLD_DEFAULT</code> (500) by default. The default is overridable in the constructor
115115
* or via #setCleanupStartThreshhold(Integer). If set to null, cleanup will never start.
116116
* </p>
117117
* <p>
118-
* Once the cleanup start threshold is exceeded, a <tt>java.util.Timer</tt> is started to clean up stale subscribers periodically
119-
* in another thread. The timer will fire every <tt>cleanupPeriodMS</tt> milliseconds, which is set to the
120-
* <tt>CLEANUP_PERIOD_MS_DEFAULT</tt> (20 minutes) by default. The default is overridable in the constructor or
121-
* via #setCleanupPeriodMS(Integer). If set to null, cleanup will not start. This is implemented with a <tt>java.util.Timer</tt>,
118+
* Once the cleanup start threshold is exceeded, a <code>java.util.Timer</code> is started to clean up stale subscribers periodically
119+
* in another thread. The timer will fire every <code>cleanupPeriodMS</code> milliseconds, which is set to the
120+
* <code>CLEANUP_PERIOD_MS_DEFAULT</code> (20 minutes) by default. The default is overridable in the constructor or
121+
* via #setCleanupPeriodMS(Integer). If set to null, cleanup will not start. This is implemented with a <code>java.util.Timer</code>,
122122
* so Timer's warnings apply - setting this too low will cause cleanups to bunch up and hog the cleanup thread.
123123
* </p>
124124
* <p>
125-
* After a cleanup cycle completes, if the number of stale subscribers falls at or below the <tt>cleanupStopThreshhold</tt>
126-
* cleanup stops until the <tt>cleanupStartThreshhold</tt> is exceeded again. The <tt>cleanupStopThreshhold</tt> is set
127-
* to <tt>CLEANUP_STOP_THRESHOLD_DEFAULT</tt> (100) by default. The default is overridable in the constructor or via
125+
* After a cleanup cycle completes, if the number of stale subscribers falls at or below the <code>cleanupStopThreshhold</code>
126+
* cleanup stops until the <code>cleanupStartThreshhold</code> is exceeded again. The <code>cleanupStopThreshhold</code> is set
127+
* to <code>CLEANUP_STOP_THRESHOLD_DEFAULT</code> (100) by default. The default is overridable in the constructor or via
128128
* #setCleanupStopThreshhold(Integer). If set to null or 0, cleanup will not stop if it is ever started.
129129
* </p>
130130
* <p>

src/main/java/org/scijava/util/FileUtils.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -465,7 +465,7 @@ public static File createTemporaryDirectory(final String prefix,
465465
* see {@link File#createTempFile(String, String, File)}
466466
* @param directory The directory in which the file is to be created, or null
467467
* if the default temporary-file directory is to be used
468-
* @return: An abstract pathname denoting a newly-created empty directory
468+
* @return An abstract pathname denoting a newly-created empty directory
469469
* @throws IOException
470470
*/
471471
public static File createTemporaryDirectory(final String prefix,

src/main/java/org/scijava/util/MersenneTwisterFast.java

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -521,8 +521,8 @@ public final boolean nextBoolean()
521521

522522

523523

524-
/** This generates a coin flip with a probability <tt>probability</tt>
525-
of returning true, else returning false. <tt>probability</tt> must
524+
/** This generates a coin flip with a probability <code>probability</code>
525+
of returning true, else returning false. <code>probability</code> must
526526
be between 0.0 and 1.0, inclusive. Not as precise a random real
527527
event as nextBoolean(double), but twice as fast. To explicitly
528528
use this, remember you may need to cast to float first. */
@@ -567,8 +567,8 @@ public final boolean nextBoolean(final float probability)
567567
}
568568

569569

570-
/** This generates a coin flip with a probability <tt>probability</tt>
571-
of returning true, else returning false. <tt>probability</tt> must
570+
/** This generates a coin flip with a probability <code>probability</code>
571+
of returning true, else returning false. <code>probability</code> must
572572
be between 0.0 and 1.0, inclusive. */
573573

574574
public final boolean nextBoolean(final double probability)
@@ -928,7 +928,7 @@ public final double nextDouble()
928928

929929
/** Returns a double in the range from 0.0 to 1.0, possibly inclusive of 0.0 and 1.0 themselves. Thus:
930930
931-
<table border=0 summary="Table">
931+
<table><caption>Table</caption>
932932
<tr><th>Expression</th><th>Interval</th></tr>
933933
<tr><td>nextDouble(false, false)</td><td>(0.0, 1.0)</td></tr>
934934
<tr><td>nextDouble(true, false)</td><td>[0.0, 1.0)</td></tr>
@@ -1141,7 +1141,7 @@ public final float nextFloat()
11411141

11421142
/** Returns a float in the range from 0.0f to 1.0f, possibly inclusive of 0.0f and 1.0f themselves. Thus:
11431143
1144-
<table border=0 summary="Table">
1144+
<table><caption>Table</caption>
11451145
<tr><th>Expression</th><th>Interval</th></tr>
11461146
<tr><td>nextFloat(false, false)</td><td>(0.0f, 1.0f)</td></tr>
11471147
<tr><td>nextFloat(true, false)</td><td>[0.0f, 1.0f)</td></tr>

src/main/java/org/scijava/util/Types.java

Lines changed: 35 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -3257,8 +3257,8 @@ else if (type instanceof ParameterizedType) {
32573257
/**
32583258
* Returns a type representing the class, with all type parameters the
32593259
* unbound wildcard ("?"). For example,
3260-
* <tt>addWildcardParameters(Map.class)</tt> returns a type representing
3261-
* <tt>Map&lt;?,?&gt;</tt>.
3260+
* <code>addWildcardParameters(Map.class)</code> returns a type representing
3261+
* <code>Map&lt;?,?&gt;</code>.
32623262
*
32633263
* @return
32643264
* <ul>
@@ -3288,27 +3288,27 @@ else if (isMissingTypeParameters(clazz)) {
32883288
}
32893289

32903290
/**
3291-
* Finds the most specific supertype of <tt>type</tt> whose erasure is
3292-
* <tt>searchClass</tt>. In other words, returns a type representing the
3293-
* class <tt>searchClass</tt> plus its exact type parameters in
3294-
* <tt>type</tt>.
3291+
* Finds the most specific supertype of <code>type</code> whose erasure is
3292+
* <code>searchClass</code>. In other words, returns a type representing the
3293+
* class <code>searchClass</code> plus its exact type parameters in
3294+
* <code>type</code>.
32953295
* <ul>
32963296
* <li>Returns an instance of {@link ParameterizedType} if
3297-
* <tt>searchClass</tt> is a real class or interface and <tt>type</tt> has
3297+
* <code>searchClass</code> is a real class or interface and <code>type</code> has
32983298
* parameters for it</li>
32993299
* <li>Returns an instance of {@link GenericArrayType} if
3300-
* <tt>searchClass</tt> is an array type, and <tt>type</tt> has type
3300+
* <code>searchClass</code> is an array type, and <code>type</code> has type
33013301
* parameters for it</li>
3302-
* <li>Returns an instance of {@link Class} if <tt>type</tt> is a raw type,
3303-
* or has no type parameters for <tt>searchClass</tt></li>
3304-
* <li>Returns null if <tt>searchClass</tt> is not a superclass of type.
3302+
* <li>Returns an instance of {@link Class} if <code>type</code> is a raw type,
3303+
* or has no type parameters for <code>searchClass</code></li>
3304+
* <li>Returns null if <code>searchClass</code> is not a superclass of type.
33053305
* </li>
33063306
* </ul>
33073307
* <p>
33083308
* For example, with
3309-
* <tt>class StringList implements List&lt;String&gt;</tt>,
3310-
* <tt>getExactSuperType(StringList.class, Collection.class)</tt> returns a
3311-
* {@link ParameterizedType} representing <tt>Collection&lt;String&gt;</tt>.
3309+
* <code>class StringList implements List&lt;String&gt;</code>,
3310+
* <code>getExactSuperType(StringList.class, Collection.class)</code> returns a
3311+
* {@link ParameterizedType} representing <code>Collection&lt;String&gt;</code>.
33123312
* </p>
33133313
*/
33143314
public static Type getExactSuperType(final Type type,
@@ -3337,9 +3337,9 @@ public static Type getExactSuperType(final Type type,
33373337
/**
33383338
* Gets the type parameter for a given type that is the value for a given
33393339
* type variable. For example, with
3340-
* <tt>class StringList implements List&lt;String&gt;</tt>,
3341-
* <tt>getTypeParameter(StringList.class, Collection.class.getTypeParameters()[0])</tt>
3342-
* returns <tt>String</tt>.
3340+
* <code>class StringList implements List&lt;String&gt;</code>,
3341+
* <code>getTypeParameter(StringList.class, Collection.class.getTypeParameters()[0])</code>
3342+
* returns <code>String</code>.
33433343
*
33443344
* @param type The type to inspect.
33453345
* @param variable The type variable to find the value for.
@@ -3569,9 +3569,9 @@ private static Type[] getArrayExactDirectSuperTypes(final Type arrayType) {
35693569

35703570
/**
35713571
* Returns the exact return type of the given method in the given type. This
3572-
* may be different from <tt>m.getGenericReturnType()</tt> when the method
3573-
* was declared in a superclass, or <tt>type</tt> has a type parameter that
3574-
* is used in the return type, or <tt>type</tt> is a raw type.
3572+
* may be different from <code>m.getGenericReturnType()</code> when the method
3573+
* was declared in a superclass, or <code>type</code> has a type parameter that
3574+
* is used in the return type, or <code>type</code> is a raw type.
35753575
*/
35763576
public static Type getExactReturnType(final Method m, final Type type) {
35773577
final Type returnType = m.getGenericReturnType();
@@ -3587,9 +3587,9 @@ public static Type getExactReturnType(final Method m, final Type type) {
35873587

35883588
/**
35893589
* Returns the exact type of the given field in the given type. This may be
3590-
* different from <tt>f.getGenericType()</tt> when the field was declared in
3591-
* a superclass, or <tt>type</tt> has a type parameter that is used in the
3592-
* type of the field, or <tt>type</tt> is a raw type.
3590+
* different from <code>f.getGenericType()</code> when the field was declared in
3591+
* a superclass, or <code>type</code> has a type parameter that is used in the
3592+
* type of the field, or <code>type</code> is a raw type.
35933593
*/
35943594
public static Type getExactFieldType(final Field f, final Type type) {
35953595
final Type returnType = f.getGenericType();
@@ -3605,9 +3605,9 @@ public static Type getExactFieldType(final Field f, final Type type) {
36053605

36063606
/**
36073607
* Returns the exact parameter types of the given method in the given type.
3608-
* This may be different from <tt>m.getGenericParameterTypes()</tt> when the
3609-
* method was declared in a superclass, or <tt>type</tt> has a type
3610-
* parameter that is used in one of the parameters, or <tt>type</tt> is a
3608+
* This may be different from <code>m.getGenericParameterTypes()</code> when the
3609+
* method was declared in a superclass, or <code>type</code> has a type
3610+
* parameter that is used in one of the parameters, or <code>type</code> is a
36113611
* raw type.
36123612
*/
36133613
public static Type[] getExactParameterTypes(final Method m,
@@ -3666,14 +3666,14 @@ public static Type capture(final Type type) {
36663666
/**
36673667
* Returns list of classes and interfaces that are supertypes of the given
36683668
* type. For example given this class:
3669-
* <tt>class Foo&lt;A extends Number & Iterable&lt;A&gt;, B extends A&gt;</tt>
3669+
* <code>class Foo&lt;A extends Number & Iterable&lt;A&gt;, B extends A&gt;</code>
36703670
* <br>
3671-
* calling this method on type parameters <tt>B</tt>
3672-
* (<tt>Foo.class.getTypeParameters()[1]</tt>) returns a list containing
3673-
* <tt>Number</tt> and <tt>Iterable</tt>.
3671+
* calling this method on type parameters <code>B</code>
3672+
* (<code>Foo.class.getTypeParameters()[1]</code>) returns a list containing
3673+
* <code>Number</code> and <code>Iterable</code>.
36743674
* <p>
36753675
* This is mostly useful if you get a type from one of the other methods in
3676-
* <tt>GenericTypeReflector</tt>, but you don't want to deal with all the
3676+
* <code>GenericTypeReflector</code>, but you don't want to deal with all the
36773677
* different sorts of types, and you are only really interested in concrete
36783678
* classes and interfaces.
36793679
* </p>
@@ -3719,17 +3719,17 @@ private static void buildUpperBoundClassAndInterfaces(final Type type,
37193719
private interface CaptureType extends Type {
37203720

37213721
/**
3722-
* Returns an array of <tt>Type</tt> objects representing the upper bound(s)
3722+
* Returns an array of <code>Type</code> objects representing the upper bound(s)
37233723
* of this capture. This includes both the upper bound of a
3724-
* <tt>? extends</tt> wildcard, and the bounds declared with the type
3724+
* <code>? extends</code> wildcard, and the bounds declared with the type
37253725
* variable. References to other (or the same) type variables in bounds
37263726
* coming from the type variable are replaced by their matching capture.
37273727
*/
37283728
Type[] getUpperBounds();
37293729

37303730
/**
3731-
* Returns an array of <tt>Type</tt> objects representing the lower bound(s)
3732-
* of this type variable. This is the bound of a <tt>? super</tt> wildcard.
3731+
* Returns an array of <code>Type</code> objects representing the lower bound(s)
3732+
* of this type variable. This is the bound of a <code>? super</code> wildcard.
37333733
* This normally contains only one or no types; it is an array for
37343734
* consistency with {@link WildcardType#getLowerBounds()}.
37353735
*/

0 commit comments

Comments
 (0)