Merge pull request #20 from kim-junggi/docs/refined-wrapper-javadoc

docs: add one-line Javadoc to refined wrapper classes

Author: JunggiKim

src/main/java/io/github/junggikim/refined/refined/character/DigitChar.java

@@ -7,6 +7,7 @@
 import io.github.junggikim.refined.validation.Validation;
 import io.github.junggikim.refined.violation.Violation;
 
+/** Wraps a {@code char} that is a Unicode digit ({@code Character.isDigit}). */
 public final class DigitChar extends AbstractRefined<Character> implements Newtype<Character> {
 
     private static final Constraint<Character> CONSTRAINT = RefinedSupport.digitChar();

src/main/java/io/github/junggikim/refined/refined/character/LetterChar.java

@@ -7,6 +7,7 @@
 import io.github.junggikim.refined.validation.Validation;
 import io.github.junggikim.refined.violation.Violation;
 
+/** Wraps a {@code char} that is a Unicode letter ({@code Character.isLetter}). */
 public final class LetterChar extends AbstractRefined<Character> implements Newtype<Character> {
 
     private static final Constraint<Character> CONSTRAINT = RefinedSupport.letterChar();

src/main/java/io/github/junggikim/refined/refined/character/LetterOrDigitChar.java

@@ -7,6 +7,7 @@
 import io.github.junggikim.refined.validation.Validation;
 import io.github.junggikim.refined.violation.Violation;
 
+/** Wraps a {@code char} that is a Unicode letter or digit ({@code Character.isLetterOrDigit}). */
 public final class LetterOrDigitChar extends AbstractRefined<Character> implements Newtype<Character> {
 
     private static final Constraint<Character> CONSTRAINT = RefinedSupport.letterOrDigitChar();

src/main/java/io/github/junggikim/refined/refined/character/LowerCaseChar.java

@@ -7,6 +7,7 @@
 import io.github.junggikim.refined.validation.Validation;
 import io.github.junggikim.refined.violation.Violation;
 
+/** Wraps a {@code char} that is a lowercase letter ({@code Character.isLowerCase}). */
 public final class LowerCaseChar extends AbstractRefined<Character> implements Newtype<Character> {
 
     private static final Constraint<Character> CONSTRAINT = RefinedSupport.lowerCaseChar();

src/main/java/io/github/junggikim/refined/refined/character/SpecialChar.java

@@ -7,6 +7,7 @@
 import io.github.junggikim.refined.validation.Validation;
 import io.github.junggikim.refined.violation.Violation;
 
+/** Wraps a {@code char} that is a special character (not a letter, digit, or whitespace). */
 public final class SpecialChar extends AbstractRefined<Character> implements Newtype<Character> {
 
     private static final Constraint<Character> CONSTRAINT = RefinedSupport.specialChar();

src/main/java/io/github/junggikim/refined/refined/character/UpperCaseChar.java

@@ -7,6 +7,7 @@
 import io.github.junggikim.refined.validation.Validation;
 import io.github.junggikim.refined.violation.Violation;
 
+/** Wraps a {@code char} that is an uppercase letter ({@code Character.isUpperCase}). */
 public final class UpperCaseChar extends AbstractRefined<Character> implements Newtype<Character> {
 
     private static final Constraint<Character> CONSTRAINT = RefinedSupport.upperCaseChar();

src/main/java/io/github/junggikim/refined/refined/character/WhitespaceChar.java

@@ -7,6 +7,7 @@
 import io.github.junggikim.refined.validation.Validation;
 import io.github.junggikim.refined.violation.Violation;
 
+/** Wraps a {@code char} that is whitespace ({@code Character.isWhitespace}). */
 public final class WhitespaceChar extends AbstractRefined<Character> implements Newtype<Character> {
 
     private static final Constraint<Character> CONSTRAINT = RefinedSupport.whitespaceChar();

src/main/java/io/github/junggikim/refined/refined/collection/NonEmptyDeque.java

@@ -11,6 +11,7 @@
 import io.github.junggikim.refined.violation.Violation;
 import java.util.Deque;
 
+/** A non-empty immutable {@code Deque} snapshot with no null elements. */
 public final class NonEmptyDeque<T> extends AbstractList<T> implements Deque<T> {
 
     private final List<T> elements;

src/main/java/io/github/junggikim/refined/refined/collection/NonEmptyIterable.java

@@ -8,6 +8,7 @@
 import io.github.junggikim.refined.validation.Validation;
 import io.github.junggikim.refined.violation.Violation;
 
+/** A non-empty immutable {@code Iterable} snapshot with no null elements. */
 public final class NonEmptyIterable<T> extends AbstractList<T> {
 
     private final List<T> elements;

src/main/java/io/github/junggikim/refined/refined/collection/NonEmptyList.java

@@ -8,6 +8,7 @@
 import io.github.junggikim.refined.validation.Validation;
 import io.github.junggikim.refined.violation.Violation;
 
+/** A non-empty immutable {@code List} snapshot with no null elements. */
 public final class NonEmptyList<T> extends AbstractList<T> {
 
     private final List<T> elements;