Add more documentation.

io7m-com · Dec 8, 2023 · f53fda0 · f53fda0
1 parent 1710ceb
commit f53fda0
Show file tree

Hide file tree

Showing 8 changed files with 498 additions and 63 deletions.
diff --git a/...o7m.jsycamore.api/src/main/java/com/io7m/jsycamore/api/themes/SyThemeClassNameCustom.java b/...o7m.jsycamore.api/src/main/java/com/io7m/jsycamore/api/themes/SyThemeClassNameCustom.java
@@ -22,22 +22,29 @@
 /**
  * A custom class name.
  *
- * @param className The actual class name
+ * @param className   The actual class name
+ * @param description The description
  */
 
-public record SyThemeClassNameCustom(String className)
+public record SyThemeClassNameCustom(
+  String className,
+  String description)
   implements SyThemeClassNameType
 {
   private static final Pattern VALID_CLASS_NAME =
     Pattern.compile("([A-Z][a-z0-9]*)+");
 
   /**
    * A custom class name.
+   *
+   * @param className   The actual class name
+   * @param description The description
    */
 
   public SyThemeClassNameCustom
   {
     Objects.requireNonNull(className, "name");
+    Objects.requireNonNull(description, "description");
 
     if (!VALID_CLASS_NAME.matcher(className).matches()) {
       throw new IllegalArgumentException(