Skip to content

Commit b20ebdf

Browse files
committed
doc: fix errors
* remove example usage due to @code block issues with annotations * other minor fixes
1 parent 2a72632 commit b20ebdf

3 files changed

Lines changed: 2 additions & 35 deletions

File tree

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,13 +62,14 @@
6262
import java.lang.annotation.Target;
6363

6464
import org.janelia.saalfeldlab.n5.codec.Codec;
65+
import org.janelia.saalfeldlab.n5.codec.Codec.BytesCodec;
6566
import org.janelia.saalfeldlab.n5.readdata.ReadData;
6667
import org.scijava.annotations.Indexable;
6768

6869
/**
6970
* Deprecated: {@link Compression}s are no longer a special case.
7071
* <br>
71-
* Use {@link Codec.BytesCodec} for implementing compressors.
72+
* Use the {@link BytesCodec} interface for implementing compressors.
7273
* <p>
7374
* Compression scheme interface.
7475
*

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

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -25,13 +25,6 @@ public interface N5Annotations extends Serializable {
2525
* For example, Zarr uses C-order (row-major) dimension ordering [Z, Y, X], while N5 uses
2626
* F-order (column-major) dimension ordering [X, Y, Z].
2727
* <p>
28-
* Example usage:
29-
* <pre>{@code
30-
* @N5Annotations.ReverseArray
31-
* @NameConfig.Parameter("chunk_shape")
32-
* private final int[] shape; // Will be reversed when serializing
33-
* }</pre>
34-
* <p>
3528
* This ensures that dimension-related arrays maintain the correct semantic meaning
3629
* across different storage format conventions.
3730
*/

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

Lines changed: 0 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -36,14 +36,6 @@ public interface NameConfig extends Serializable {
3636
* type name, creating a namespaced identifier. This is useful for organizing
3737
* related components into logical groups, usually all the components implementing
3838
* a particular interface.
39-
* <p>
40-
* Example usage:
41-
* <pre>{@code
42-
* @NameConfig.Prefix("codec")
43-
* public interface Codec extends NameConfig {
44-
* // ...
45-
* }
46-
* }</pre>
4739
*
4840
* @see Name
4941
*/
@@ -60,14 +52,6 @@ public interface NameConfig extends Serializable {
6052
* This annotation defines the string identifier used during serialization and
6153
* deserialization to identify the type. The name should be unique within its
6254
* namespace and is typically a short, descriptive identifier.
63-
* <p>
64-
* Example usage:
65-
* <pre>{@code
66-
* @NameConfig.Name("gzip")
67-
* public class GzipCompression implements Compression {
68-
* // ...
69-
* }
70-
* }</pre>
7155
*
7256
* @see Prefix
7357
*/
@@ -87,17 +71,6 @@ public interface NameConfig extends Serializable {
8771
* <p>
8872
* The {@code value} attribute can be used to specify an alternative name for
8973
* the parameter during serialization. If not specified, the field name is used.
90-
* <p>
91-
* Example usage:
92-
* <pre>{@code
93-
* public class GzipCompression implements Compression {
94-
* @NameConfig.Parameter
95-
* private final int level;
96-
*
97-
* @NameConfig.Parameter(optional = true)
98-
* private final boolean useZlib;
99-
* }
100-
* }</pre>
10174
*
10275
* @see Name
10376
*/

0 commit comments

Comments
 (0)