Skip to content

Commit aeda49d

Browse files
committed
Fix javadoc warnings
1 parent f294507 commit aeda49d

File tree

5 files changed

+19
-13
lines changed

5 files changed

+19
-13
lines changed

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -122,8 +122,8 @@ private void log(final String msg) {
122122
// -- Helper Class --
123123

124124
/**
125-
* {@link StreamFactory} implementation for writing an annotation.
126-
*
125+
* {@link AbstractIndexWriter.StreamFactory} implementation for writing an
126+
* annotation.
127127
*/
128128
private static class AnnotationStreamFactory implements StreamFactory {
129129

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

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,6 @@ public class Index<A extends Annotation> implements Iterable<IndexItem<A>> {
6666
*
6767
* @param annotation the annotation type
6868
* @return the index
69-
* @throws IOException
7069
*/
7170
public static <A extends Annotation> Index<A> load(final Class<A> annotation)
7271
{
@@ -82,7 +81,6 @@ public static <A extends Annotation> Index<A> load(final Class<A> annotation)
8281
* @param loader the class loader to use when loading {@link Class}-type
8382
* annotation fields
8483
* @return the index
85-
* @throws IOException
8684
*/
8785
public static <A extends Annotation> Index<A> load(final Class<A> annotation,
8886
final ClassLoader loader)

src/main/java/org/scijava/annotations/legacy/LegacyReader.java

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -314,8 +314,10 @@ protected final Object readWithoutClassDesc() throws IOException {
314314
return o;
315315
}
316316

317+
/**
318+
* @throws IOException If something goes wrong reading the map.
319+
*/
317320
protected Object readExtra(Map<String, Object> o) throws IOException {
318-
319321
return o;
320322
}
321323
}

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ private CheckSezpoz() {
7878
* @param checkJars whether to inspect .jar components of the CLASSPATH
7979
* @return false, when the annotation processor had to be run
8080
* @throws IOException
81-
* @see {@link EclipseHelper}
81+
* @see EclipseHelper
8282
*/
8383
@Deprecated
8484
public static boolean check(final boolean checkJars) throws IOException {
@@ -92,7 +92,7 @@ public static boolean check(final boolean checkJars) throws IOException {
9292
* @param file the CLASSPATH component (.jar file or directory)
9393
* @return false, when the annotation processor had to be run
9494
* @throws IOException
95-
* @see {@link EclipseHelper}
95+
* @see EclipseHelper
9696
*/
9797
@Deprecated
9898
public static boolean check(final File file) throws IOException {
@@ -107,7 +107,7 @@ public static boolean check(final File file) throws IOException {
107107
* @param classes the CLASSPATH component directory
108108
* @return false, when the annotation processor had to be run
109109
* @throws IOException
110-
* @see {@link EclipseHelper}
110+
* @see EclipseHelper
111111
*/
112112
@Deprecated
113113
public static boolean checkDirectory(final File classes) throws IOException {
@@ -127,7 +127,7 @@ public static boolean checkDirectory(final File classes) throws IOException {
127127
* @param source the <i>src/main/java/<i> directory where Maven expects the
128128
* <i>.java</i> files
129129
* @param youngerThan the date/time when we last checked
130-
* @see {@link EclipseHelper}
130+
* @see EclipseHelper
131131
*/
132132
@Deprecated
133133
public static boolean checkDirectory(final File classes, final File source,
@@ -144,7 +144,7 @@ public static boolean checkDirectory(final File classes, final File source,
144144
* </p>
145145
*
146146
* @param file the <i>.jar</i> file
147-
* @see {@link EclipseHelper}
147+
* @see EclipseHelper
148148
*/
149149
@Deprecated
150150
public static void checkJar(final File file) throws IOException {
@@ -158,7 +158,7 @@ public static void checkJar(final File file) throws IOException {
158158
* @param classes the output directory
159159
* @param sources the directory containing the source files
160160
* @return whether anything in {@code META-INF/annotations/*} changed
161-
* @see {@link EclipseHelper}
161+
* @see EclipseHelper
162162
*/
163163
@Deprecated
164164
public static boolean fix(final File classes, final File sources) {

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

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,14 +45,20 @@ public class CombineAnnotations
4545
{
4646

4747
/**
48-
* @deprecated Use {@link org.scijava.annotations.AnnotationCombiner#CombineAnnotations()} instead.
48+
* @deprecated Use
49+
* {@link org.scijava.annotations.AnnotationCombiner#AnnotationCombiner()}
50+
* instead.
51+
* @throws IOException
4952
*/
5053
@Deprecated
5154
public CombineAnnotations() throws IOException {}
5255

5356
private AnnotationCombiner combiner = new AnnotationCombiner();
57+
5458
/**
55-
* @deprecated Use {@link org.scijava.annotations.AnnotationCombiner#combine()} instead.
59+
* @deprecated Use
60+
* {@link org.scijava.annotations.AnnotationCombiner#combine(File)}
61+
* instead.
5662
*/
5763
@Deprecated
5864
public void combine() throws IOException, ClassNotFoundException {

0 commit comments

Comments
 (0)