docs(yaml): add javadoc for constructors

Siroshun09 · Feb 23, 2024 · bdde9dd · bdde9dd
1 parent 4cf36b4
commit bdde9dd
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 0 deletions.
diff --git a/...l/src/main/java/com/github/siroshun09/configapi/format/yaml/comment/YamlBlockComment.java b/...l/src/main/java/com/github/siroshun09/configapi/format/yaml/comment/YamlBlockComment.java
@@ -34,6 +34,10 @@ public record YamlBlockComment(@NotNull String content, int prependBlankLines) i
      */
     public static final String TYPE = "block";
 
+    /**
+     * @param content           the content of the comment
+     * @param prependBlankLines the number of blank lines before the block comments
+     */
     public YamlBlockComment {
         Objects.requireNonNull(content);
         if (prependBlankLines < 0) {

diff --git a/.../src/main/java/com/github/siroshun09/configapi/format/yaml/comment/YamlInlineComment.java b/.../src/main/java/com/github/siroshun09/configapi/format/yaml/comment/YamlInlineComment.java
@@ -33,6 +33,9 @@ public record YamlInlineComment(@NotNull String content) implements SimpleCommen
      */
     public static final String TYPE = "inline";
 
+    /**
+     * @param content the content of the comment
+     */
     public YamlInlineComment {
         Objects.requireNonNull(content);
     }