Skip to content

Commit b191e30

Browse files
committed
doc: assorted javadoc fixes
1 parent 8d1d105 commit b191e30

4 files changed

Lines changed: 14 additions & 1 deletion

File tree

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,9 @@
5454
* T adapter, auto-discovers annotated T implementations in the classpath.
5555
*
5656
* @author Caleb Hulbert
57+
*
58+
* @param <T>
59+
* the class this adapter (de)serializes
5760
*/
5861
public class NameConfigAdapter<T> implements JsonDeserializer<T>, JsonSerializer<T> {
5962

src/main/java/org/janelia/saalfeldlab/n5/codec/DatasetCodec.java

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,14 @@ public interface DatasetCodec<S, T> {
2727
* datasetCodec} and then {@code blockCodec} (and does the same in reverse
2828
* order for decoding).
2929
*
30+
* @param <S>
31+
* the source type of this codec
32+
* @param <T>
33+
* the target type of this codec
34+
* @param datasetCodec
35+
* the DatasetCodec to apply
36+
* @param blockCodec
37+
* the wrapped BlockCodec
3038
* @return the concatenated BlockCodec
3139
*/
3240
static <S, T> BlockCodec<S> concatenate(final DatasetCodec<S, T> datasetCodec, final BlockCodec<T> blockCodec) {

src/main/java/org/janelia/saalfeldlab/n5/codec/DatasetCodecInfo.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@
2828
*/
2929
package org.janelia.saalfeldlab.n5.codec;
3030

31+
import org.janelia.saalfeldlab.n5.DataBlock;
3132
import org.janelia.saalfeldlab.n5.DatasetAttributes;
3233
import org.janelia.saalfeldlab.n5.codec.transpose.TransposeCodec;
3334
import org.janelia.saalfeldlab.n5.serialization.NameConfig;

src/main/java/org/janelia/saalfeldlab/n5/shard/Nesting.java

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,8 @@
4141
* into higher-level containers called shards, which can themselves be nested
4242
* within parent shards, creating a multi-level hierarchy.
4343
* <p>
44-
* <b>Nesting levels:</b> <ul
44+
* <b>Nesting levels:</b>
45+
* <ul>
4546
* <li><b>Level 0:</b> The finest granularity - individual data blocks
4647
* containing actual pixel data
4748
* <li><b>Level 1:</b> First-level shards, which contain multiple level-0 data

0 commit comments

Comments
 (0)