doc: even more javadoc fixes

Author: bogovicj

src/main/java/org/janelia/saalfeldlab/n5/Compression.java

@@ -68,8 +68,8 @@
 /**
  * Deprecated: {@link Compression}s are no longer a special case.
  * <br>
- * Use {@link Codec.BytesCodec} for implementing compressors
- * <p> </p>
+ * Use {@link Codec.BytesCodec} for implementing compressors.
+ * <p>
  * Compression scheme interface.
  *
  * @author Stephan Saalfeld

src/main/java/org/janelia/saalfeldlab/n5/readdata/ReadData.java

@@ -126,12 +126,17 @@ default ByteBuffer toByteBuffer() throws IOException, IllegalStateException {
 	}
 
 	/**
-	 * Read the underlying data into a {@code byte[]} array, and return it as a {@code ReadData}.
-	 * (If this {@code ReadData} is already in a {@code byte[]} array or {@code
+	 * Read the underlying data into a {@code byte[]} array, and return it as a
+	 * {@code ReadData}. (If this {@code ReadData} is already in a
+	 * {@code byte[]} array or {@code
 	 * ByteBuffer}, just return {@code this}.)
 	 * <p>
 	 * The returned {@code ReadData} has a known {@link #length} and multiple
 	 * {@link #inputStream InputStreams} can be opened on it.
+	 * 
+	 * @return a materialized ReadData
+	 * @throws IOException
+	 *             if any I/O error occurs
 	 */
 	ReadData materialize() throws IOException;
 

src/main/java/org/janelia/saalfeldlab/n5/serialization/N5Annotations.java

@@ -27,8 +27,8 @@ public interface N5Annotations extends Serializable {
 	 * <p>
 	 * Example usage:
 	 * <pre>{@code
-	 * &#64;ReverseArray
-	 * &#64;Parameter("chunk_shape")
+	 * @N5Annotations.ReverseArray
+	 * @NameConfig.Parameter("chunk_shape")
 	 * private final int[] shape;  // Will be reversed when serializing
 	 * }</pre>
 	 * <p>

src/main/java/org/janelia/saalfeldlab/n5/serialization/NameConfig.java

@@ -39,7 +39,7 @@ public interface NameConfig extends Serializable {
 	 * <p>
 	 * Example usage:
 	 * <pre>{@code
-	 * @Prefix("codec")
+	 * @NameConfig.Prefix("codec")
 	 * public interface Codec extends NameConfig {
 	 *     // ...
 	 * }
@@ -63,7 +63,7 @@ public interface NameConfig extends Serializable {
 	 * <p>
 	 * Example usage:
 	 * <pre>{@code
-	 * @Name("gzip")
+	 * @NameConfig.Name("gzip")
 	 * public class GzipCompression implements Compression {
 	 *     // ...
 	 * }
@@ -91,10 +91,10 @@ public interface NameConfig extends Serializable {
 	 * Example usage:
 	 * <pre>{@code
 	 * public class GzipCompression implements Compression {
-	 *     @Parameter
+	 *     @NameConfig.Parameter
 	 *     private final int level;
 	 *     
-	 *     @Parameter(optional = true)
+	 *     @NameConfig.Parameter(optional = true)
 	 *     private final boolean useZlib;
 	 * }
 	 * }</pre>