diff --git a/src/main/java/rife/bld/extension/CompileKotlinOperation.java b/src/main/java/rife/bld/extension/CompileKotlinOperation.java index d474094..333f200 100644 --- a/src/main/java/rife/bld/extension/CompileKotlinOperation.java +++ b/src/main/java/rife/bld/extension/CompileKotlinOperation.java @@ -50,7 +50,7 @@ public class CompileKotlinOperation extends AbstractOperation getKotlinFileList(File directory) { if (directory == null) { return Collections.emptyList(); @@ -167,7 +173,7 @@ public class CompileKotlinOperation extends AbstractOperation * Such a file can contain compiler options with values and paths to the source files. * Options and paths should be separated by whitespaces. For example: - *

- * {@code -include-runtime -d hello.jar hello.kt} - *

+ *

* To pass values that contain whitespaces, surround them with single ({@code '}) or double ({@code "}) quotes. * If a value contains quotation marks in it, escape them with a backslash (\). - *

- * {@code -include-runtime -d 'My folder'} - *

+ *

* If the files reside in locations different from the current directory, use relative paths. * * @param files one or more files @@ -298,8 +298,7 @@ public class CompileKotlinOptions { } /** - * Use a custom JDK home directory to include into the classpath if it differs from the default JAVA_HOME.Use a - * custom JDK home directory to include into the classpath if it differs from the default {@code JAVA_HOME}. + * Use a custom JDK home directory to include into the classpath if it differs from the default {@code JAVA_HOME}. * * @param jdkHome the JDK home path * @return this class instance @@ -310,9 +309,12 @@ public class CompileKotlinOptions { } /** - * Specify the target version of the generated JVM bytecode. Limit the API of the JDK in the classpath to the - * specified Java version. Automatically sets {@link #jvmTarget(String) JVM target} version. Possible values are - * 1.8, 9, 10, ..., 21. The default value is 1.8. + * Specify the target version of the generated JVM bytecode. + *

+ * Limit the API of the JDK in the classpath to the specified Java version. Automatically sets + * {@link #jvmTarget(String) JVM target} version. + *

+ * Possible values are 1.8, 9, 10, ..., 21. The default value is 1.8. * * @param version the target version * @return this class instance @@ -336,6 +338,7 @@ public class CompileKotlinOptions { /** * Specify the target version of the generated JVM bytecode. + *

* Possible values are 1.8, 9, 10, ..., 21. The default value is 1.8. * * @param target the target version @@ -359,7 +362,7 @@ public class CompileKotlinOptions { } /** - * Enable verbose logging output which includes details of the compilation process. + * Specify a custom path to the Kotlin compiler used for the discovery of runtime libraries. * * @param path the Kotlin home path * @return this class instance @@ -481,8 +484,9 @@ public class CompileKotlinOptions { } /** - * Place the generated class files into the specified location. The location can be a directory, a ZIP, or a JAR - * file. + * Place the generated class files into the specified location. + *

+ * The location can be a directory, a ZIP, or a JAR file. * * @param path the location path * @return this class instance @@ -493,8 +497,9 @@ public class CompileKotlinOptions { } /** - * Place the generated class files into the specified location. The location can be a directory, a ZIP, or a JAR - * file. + * Place the generated class files into the specified location. + *

+ * The location can be a directory, a ZIP, or a JAR file. * * @param path the location path * @return this class instance @@ -528,7 +533,9 @@ public class CompileKotlinOptions { } /** - * Script definition template classes. Use fully qualified class names. + * Script definition template classes. + *

+ * Use fully qualified class names. * * @param classNames one or more class names * @return this class instance @@ -539,7 +546,9 @@ public class CompileKotlinOptions { } /** - * Script definition template classes. Use fully qualified class names. + * Script definition template classes. + *

+ * Use fully qualified class names. * * @param classNames the list class names * @return this class instance diff --git a/src/main/java/rife/bld/extension/CompileKotlinPlugin.java b/src/main/java/rife/bld/extension/CompileKotlinPlugin.java index 4936655..bf10326 100644 --- a/src/main/java/rife/bld/extension/CompileKotlinPlugin.java +++ b/src/main/java/rife/bld/extension/CompileKotlinPlugin.java @@ -16,6 +16,12 @@ package rife.bld.extension; +/** + * Defines the known Kotlin compiler plugins match (regex) strings. + * + * @author Erik C. Thauvin + * @since 1.0 + */ public enum CompileKotlinPlugin { ALL_OPEN("^allopen-compiler-plugin-.*$"), ASSIGNMENT("^assignment-compiler-plugin-.*$"), diff --git a/src/main/java/rife/bld/extension/dokka/DokkaOperation.java b/src/main/java/rife/bld/extension/dokka/DokkaOperation.java index 5d86a3e..ca28adc 100644 --- a/src/main/java/rife/bld/extension/dokka/DokkaOperation.java +++ b/src/main/java/rife/bld/extension/dokka/DokkaOperation.java @@ -28,7 +28,7 @@ import java.util.logging.Level; import java.util.logging.Logger; /** - * Builds Javadocs using Dokka. + * Builds documentation (javadoc, HTML, etc.) using Dokka. * * @author Erik C. Thauvin * @since 1.0 @@ -63,7 +63,9 @@ public class DokkaOperation extends AbstractProcessOperation { private boolean suppressInheritedMembers_; /** - * Sets the delay substitution of some elements. Used in incremental builds of multimodule projects. + * Sets the delay substitution of some elements. + *

+ * Used in incremental builds of multimodule projects. * * @param delayTemplateSubstitution the delay * @return this operation instance @@ -74,8 +76,7 @@ public class DokkaOperation extends AbstractProcessOperation { } /** - * Part of the {@link #execute} operation, constructs the command list - * to use for building the process. + * Part of the {@link #execute} operation, constructs the command list to use for building the process. * * @since 1.5 */ @@ -247,7 +248,7 @@ public class DokkaOperation extends AbstractProcessOperation { } /** - * Set the global external documentation links + * Set the global external documentation links. * * @param url the external documentation URL * @param packageListUrl the external documentation package list URL @@ -259,7 +260,7 @@ public class DokkaOperation extends AbstractProcessOperation { } /** - * Set the global external documentation links + * Set the global external documentation links. * * @param globalLinks the map of global links * @return this operation instance @@ -278,6 +279,7 @@ public class DokkaOperation extends AbstractProcessOperation { *

  • -privateApi
    • *
  • +warnUndocumented
    • *
  • +suppress
    • + *
  • +visibility:PUBLIC
    • *
  • ...
    • * * @@ -297,6 +299,7 @@ public class DokkaOperation extends AbstractProcessOperation { *
  • -privateApi
    • *
  • +warnUndocumented
    • *
  • +suppress
    • + *
  • +visibility:PUBLIC
    • *
  • ...
    • * * @@ -409,7 +412,7 @@ public class DokkaOperation extends AbstractProcessOperation { } /** - * Sets the output directory path, {@code ./dokka} by default + * Sets the output directory path, {@code ./dokka} by default. * * @param outputDir the output directory * @return this operation instance @@ -420,7 +423,7 @@ public class DokkaOperation extends AbstractProcessOperation { } /** - * Sets the output directory path, {@code ./dokka} by default + * Sets the output directory path, {@code ./dokka} by default. * * @param outputDir the output directory * @return this operation instance diff --git a/src/main/java/rife/bld/extension/dokka/SourceSet.java b/src/main/java/rife/bld/extension/dokka/SourceSet.java index ba78a35..4c48116 100644 --- a/src/main/java/rife/bld/extension/dokka/SourceSet.java +++ b/src/main/java/rife/bld/extension/dokka/SourceSet.java @@ -388,11 +388,12 @@ public class SourceSet { /** * Set the list of package source set configuration in format: *
      - *
    • + *
    • matchingRegexp
      • *
    • -deprecated
      • *
    • -privateApi
      • *
    • +warnUndocumented
      • *
    • +suppress
      • + *
    • +visibility:PUBLIC
      • *
    • ...
      • *
    * @@ -407,11 +408,12 @@ public class SourceSet { /** * Set the list of package source set configuration in format: *
      - *
    • + *
    • matchingRegexp
      • *
    • -deprecated
      • *
    • -privateApi
      • *
    • +warnUndocumented
      • *
    • +suppress
      • + *
    • +visibility:PUBLIC
      • *
    • ...
      • *
    * @@ -468,7 +470,7 @@ public class SourceSet { } /** - * Sets the name of the source set. Default is {@code main}. + * Sets the name of the source set. Default is {@code main}. * * @param sourceSetName the source set name. * @return this operation instance