Skip to content

Commit af620de

Browse files
committed
Align Javadoc to User Guide
1 parent 177bbb6 commit af620de

3 files changed

Lines changed: 12 additions & 0 deletions

File tree

src/main/java/io/github/scordio/junit/converters/Base64.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,8 @@
2626
/**
2727
* {@link ConvertWith} composed annotation that decodes Base64-encoded instances of type
2828
* {@code byte[]} or {@link String} into {@code byte[]} instances.
29+
* <p>
30+
* The {@link #encoding} attribute configures the desired encoding scheme.
2931
*/
3032
@Target({ ElementType.ANNOTATION_TYPE, ElementType.PARAMETER, ElementType.FIELD })
3133
@Retention(RetentionPolicy.RUNTIME)

src/main/java/io/github/scordio/junit/converters/Bytes.java

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,14 @@
2626
/**
2727
* {@link ConvertWith} composed annotation that converts {@link String} or number
2828
* instances into {@code byte[]} instances.
29+
* <p>
30+
* When converting strings, the input instance is encoded into a sequence of bytes. The
31+
* {@link #charset} attribute configures the charset to use for conversion. If not
32+
* specified, the JVM default charset is used.
33+
* <p>
34+
* When converting numbers, the input instance is converted into a sequence of bytes using
35+
* its binary representation. The {@link #order} attribute configures the byte order to
36+
* use for conversion.
2937
*/
3038
@Target({ ElementType.ANNOTATION_TYPE, ElementType.PARAMETER, ElementType.FIELD })
3139
@Retention(RetentionPolicy.RUNTIME)

src/main/java/io/github/scordio/junit/converters/Hex.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,8 @@
2626
/**
2727
* {@link ConvertWith} composed annotation that decodes hexadecimal {@link String}
2828
* instances into {@code byte[]} instances.
29+
* <p>
30+
* The input strings are treated as case-insensitive and can be prefixed by {@code 0x}.
2931
*/
3032
@Target({ ElementType.ANNOTATION_TYPE, ElementType.PARAMETER, ElementType.FIELD })
3133
@Retention(RetentionPolicy.RUNTIME)

0 commit comments

Comments
 (0)