clarify docs

LearnLib · Jan 4, 2024 · 6d5b1da · 6d5b1da
1 parent 5acbd3b
commit 6d5b1da
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 4 deletions.
diff --git a/annotations/src/main/java/de/learnlib/tooling/annotation/DocGenType.java b/annotations/src/main/java/de/learnlib/tooling/annotation/DocGenType.java
@@ -15,7 +15,7 @@
 package de.learnlib.tooling.annotation;
 
 /**
- * An enum that describes different types of generation of documentation.
+ * An enum that describes different types of document generation.
  */
 public enum DocGenType {
     /**

diff --git a/annotations/src/main/java/de/learnlib/tooling/annotation/refinement/GenerateRefinement.java b/annotations/src/main/java/de/learnlib/tooling/annotation/refinement/GenerateRefinement.java
@@ -93,9 +93,10 @@
     boolean constructorPublic() default true;
 
     /**
-     * Specifies how the documentation of the generated class should be constructed. Only concerns the documentation of
-     * constructors. For the class doc (especially the documentation of type variables) also see
-     * {@link Generic#desc()}.
+     * Specifies how the documentation of the generated class should be constructed. In case of {@link DocGenType#COPY},
+     * the constructor documentation is copied as-is, but for the class documentation only the main documentation
+     * (without any tags) is considered. You may use {@link Generic#desc()} to provide additional documentation for the
+     * {@link #generics() specified type parameters}.
      *
      * @return the generation type for the documentation
      */