Skip to content

Commit 2b24daf

Browse files
committed
Fix javadoc errors
1 parent 4990fc0 commit 2b24daf

File tree

17 files changed

+231
-233
lines changed

17 files changed

+231
-233
lines changed

src/main/java/org/scijava/Context.java

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -141,8 +141,9 @@ public Context(final boolean noServices, final boolean noPlugins) {
141141
* {@code new Context(DisplayService.class)}) yield the potentially confusing
142142
* warning:
143143
* </p>
144-
* <blockquote>Type safety: A generic array of Class<? extends Service> is
145-
* created for a varargs parameter</blockquote>
144+
* <blockquote>Type safety: A generic array of
145+
* {@code Class<? extends Service>} is created for a varargs
146+
* parameter</blockquote>
146147
* <p>
147148
* To avoid this, we have opted to use raw types and suppress the relevant
148149
* warnings here instead.
@@ -351,7 +352,7 @@ public Service getService(final String className) {
351352
/**
352353
* Injects the application context into the given object. This does three
353354
* distinct things:
354-
* <ul>
355+
* <ol>
355356
* <li>If the given object has any non-final {@link Context} fields annotated
356357
* with @{@link Parameter}, sets the value of those fields to this context.
357358
* </li>
@@ -360,8 +361,8 @@ public Service getService(final String className) {
360361
* corresponding service available from this context.</li>
361362
* <li>Calls {@link EventService#subscribe(Object)} with the object to
362363
* register any @{@link EventHandler} annotated methods as event subscribers.
363-
* </li> .</li>
364-
* </ul>
364+
* </li>
365+
* </ol>
365366
*
366367
* @param o The object to which the context should be assigned.
367368
* @throws IllegalStateException If the object already has a context.

src/main/java/org/scijava/Identifiable.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@
4949
* <p>
5050
* In this way, objects themselves do not need to be {@link Serializable}, nor
5151
* do multiple potentially equivalent objects need to be synthesized and then
52-
* compared using {@link #equals}.
52+
* compared using {@link Object#equals}.
5353
* </p>
5454
*
5555
* @author Curtis Rueden

src/main/java/org/scijava/SciJava.java

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -74,8 +74,9 @@ public SciJava(final boolean empty) {
7474
* {@code new SciJava(LogService.class)}) yield the potentially confusing
7575
* warning:
7676
* </p>
77-
* <blockquote>Type safety: A generic array of Class<? extends Service> is
78-
* created for a varargs parameter</blockquote>
77+
* <blockquote>Type safety: A generic array of
78+
* {@code Class<? extends Service>} is created for a varargs
79+
* parameter</blockquote>
7980
* <p>
8081
* To avoid this, we have opted to use raw types and suppress the relevant
8182
* warning here instead.

src/main/java/org/scijava/annotations/Index.java

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -45,14 +45,15 @@
4545
/**
4646
* Makes the annotation indexes accessible.
4747
* <p>
48-
* You would call it like this:<br />
49-
* <code>
50-
* for (IndexItem<MyAnnotation> item : Index.load(MyAnnotation.class)) {<br />
51-
* // do something with item.annotation() and/or item.className()<br />
52-
* }<br />
53-
* </code>
48+
* You would call it like this:
5449
* </p>
5550
*
51+
* <pre>
52+
* for (IndexItem&lt;MyAnnotation&gt; item : Index.load(MyAnnotation.class)) {
53+
* // do something with item.annotation() and/or item.className()
54+
* }
55+
* </pre>
56+
*
5657
* @author Johannes Schindelin
5758
*/
5859
public class Index<A extends Annotation> implements Iterable<IndexItem<A>> {
@@ -74,8 +75,6 @@ public static <A extends Annotation> Index<A> load(final Class<A> annotation)
7475

7576
/**
7677
* Loads the index of all classes annotated with the specified annotation.
77-
* <p>
78-
* </p>
7978
*
8079
* @param annotation the annotation type
8180
* @param loader the class loader to use when loading {@link Class}-type

src/main/java/org/scijava/convert/ConversionRequest.java

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -33,29 +33,27 @@
3333

3434
import java.lang.reflect.Type;
3535

36+
import org.scijava.plugin.HandlerService;
3637
import org.scijava.util.GenericUtils;
3738

3839
/**
39-
* Currency for use in {@link Converter} and {@link ConvertService}
40-
* methods.
40+
* Currency for use in {@link Converter} and {@link ConvertService} methods.
4141
* <p>
4242
* {@link #ConversionRequest} provides a variety of constructors. Note that only
4343
* one destination type needs to be set (e.g. either a {@link Type} or a
4444
* {@link Class}).
4545
* </p>
4646
* <p>
47-
* Only the {@link Class} source needs to be set for {@link Converter}
48-
* lookup, such as through
49-
* {@link ConvertService#getHandler(ConversionRequest)}. However, to perform
50-
* an actual conversion, e.g. using
47+
* Only the {@link Class} source needs to be set for {@link Converter} lookup,
48+
* such as through {@link HandlerService#getHandler(Object)}. However, to
49+
* perform an actual conversion, e.g. using
5150
* {@link Converter#convert(ConversionRequest)}, you must provide an
5251
* {@link Object} source.
5352
* </p>
5453
* <p>
55-
* NB: once a {@link Converter} has been acquired, the
56-
* {@code ConversionRequest} used for lookup can be reused to cast to the same
57-
* destination type, simply by updating the source object using the
58-
* {@link #setSourceObject(Object)} method.
54+
* NB: once a {@link Converter} has been acquired, the {@code ConversionRequest}
55+
* used for lookup can be reused to cast to the same destination type, simply by
56+
* updating the source object using the {@link #setSourceObject(Object)} method.
5957
* </p>
6058
*
6159
* @author Mark Hiner

src/main/java/org/scijava/convert/ConvertService.java

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -66,22 +66,22 @@ public interface ConvertService extends
6666
Object convert(ConversionRequest request);
6767

6868
/**
69-
* @see #getHandler(ConversionRequest)
69+
* @see HandlerService#supports(Object)
7070
*/
7171
Converter<?, ?> getHandler(Object src, Class<?> dest);
7272

7373
/**
74-
* @see #getHandler(ConversionRequest)
74+
* @see HandlerService#supports(Object)
7575
*/
7676
Converter<?, ?> getHandler(Object src, Type dest);
7777

7878
/**
79-
* @see #supports(ConversionRequest)
79+
* @see HandlerService#supports(Object)
8080
*/
8181
boolean supports(Object src, Class<?> dest);
8282

8383
/**
84-
* @see #supports(ConversionRequest)
84+
* @see HandlerService#supports(Object)
8585
*/
8686
boolean supports(Object src, Type dest);
8787

@@ -106,28 +106,28 @@ public interface ConvertService extends
106106
// -- Deprecated API --
107107

108108
/**
109-
* @see #getHandler(ConversionRequest)
109+
* @see HandlerService#getHandler(Object)
110110
* @deprecated Use {@link #getHandler(Object, Class)}
111111
*/
112112
@Deprecated
113113
Converter<?, ?> getHandler(Class<?> src, Class<?> dest);
114114

115115
/**
116-
* @see #getHandler(ConversionRequest)
116+
* @see HandlerService#getHandler(Object)
117117
* @deprecated Use {@link #getHandler(Object, Type)}
118118
*/
119119
@Deprecated
120120
Converter<?, ?> getHandler(Class<?> src, Type dest);
121121

122122
/**
123-
* @see #supports(ConversionRequest)
123+
* @see HandlerService#supports(Object)
124124
* @deprecated Use {@link #supports(Object, Class)}
125125
*/
126126
@Deprecated
127127
boolean supports(Class<?> src, Class<?> dest);
128128

129129
/**
130-
* @see #supports(ConversionRequest)
130+
* @see HandlerService#supports(Object)
131131
* @deprecated Use {@link #supports(Object, Type)}
132132
*/
133133
@Deprecated

src/main/java/org/scijava/convert/Converter.java

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -50,9 +50,8 @@
5050
public interface Converter<I, O> extends HandlerPlugin<ConversionRequest> {
5151

5252
/**
53-
* Checks whether a given {@ConversionRequest} can be
54-
* processed, by converting the desired
55-
* {@link ConversionRequest#sourceClass()} to its
53+
* Checks whether a given {@link ConversionRequest} can be processed, by
54+
* converting the desired {@link ConversionRequest#sourceClass()} to its
5655
* {@link ConversionRequest#destClass()} or
5756
* {@link ConversionRequest#destType()}.
5857
*

src/main/java/org/scijava/input/KeyCode.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -442,7 +442,7 @@ public enum KeyCode {
442442
/** TODO. */
443443
DEAD_SEMIVOICED_SOUND(0x8f),
444444

445-
/** Ampersand ('&'). */
445+
/** Ampersand ('&amp;'). */
446446
AMPERSAND(0x96),
447447

448448
/** Asterisk ('*'). */

src/main/java/org/scijava/menu/ShadowMenu.java

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -172,7 +172,8 @@ public MenuEntry getMenuEntry() {
172172

173173
/**
174174
* Gets how deep into the menu structure this node is. For example, "File"
175-
* would be at depth 1, whereas "Exit" (of "File>Exit") would be at depth 2.
175+
* would be at depth 1, whereas "Exit" (of "File&gt;Exit") would be at depth
176+
* 2.
176177
*/
177178
public int getMenuDepth() {
178179
return menuDepth;

src/main/java/org/scijava/plugin/Plugin.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -79,10 +79,10 @@
7979

8080
/**
8181
* Abbreviated menu path defining where the plugin is shown in the menu
82-
* structure. Uses greater than signs (>) as a separator; e.g.:
83-
* "Image > Overlay > Properties..." defines a "Properties..." menu item
84-
* within the "Overlay" submenu of the "Image" menu. Use either
85-
* {@link #menuPath} or {@link #menu} but not both.
82+
* structure. Uses greater than signs ({@code >}) as a separator; e.g.: "Image
83+
* &gt; Overlay &gt; Properties..." defines a "Properties..." menu item within
84+
* the "Overlay" submenu of the "Image" menu. Use either {@link #menuPath} or
85+
* {@link #menu} but not both.
8686
*/
8787
String menuPath() default "";
8888

0 commit comments

Comments
 (0)