diff --git a/src/main/java/rife/bld/extension/CompileKotlinOperation.java b/src/main/java/rife/bld/extension/CompileKotlinOperation.java index 333f200..1f531c7 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(); @@ -173,7 +167,7 @@ public class CompileKotlinOperation extends AbstractOperation{@link #testSourceFiles() testSourceFile} to the {@code kotlin} directory in * {@link BaseProject#srcTestDirectory() srcTestDirectory} *
  • {@link CompileKotlinOptions#jdkRelease jdkRelease} to {@link BaseProject#javaRelease() javaRelease}
    • - *
  • {@link CompileKotlinOptions#noStdLib(boolean) noStdLib} to {@code true}
    • * * * @param project the project to configure the compile operation from @@ -354,7 +347,6 @@ 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}
      • - *
    + *

    + * {@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'}
      • - *
    + *

    + * {@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,7 +298,8 @@ public class CompileKotlinOptions { } /** - * 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 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 @@ -309,12 +310,9 @@ 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 @@ -338,7 +336,6 @@ 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 @@ -362,7 +359,7 @@ public class CompileKotlinOptions { } /** - * Specify a custom path to the Kotlin compiler used for the discovery of runtime libraries. + * Enable verbose logging output which includes details of the compilation process. * * @param path the Kotlin home path * @return this class instance @@ -484,9 +481,8 @@ 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 @@ -497,9 +493,8 @@ 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 @@ -533,9 +528,7 @@ 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 @@ -546,9 +539,7 @@ 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 bf10326..4936655 100644 --- a/src/main/java/rife/bld/extension/CompileKotlinPlugin.java +++ b/src/main/java/rife/bld/extension/CompileKotlinPlugin.java @@ -16,12 +16,6 @@ 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 ca28adc..5d86a3e 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 documentation (javadoc, HTML, etc.) using Dokka. + * Builds Javadocs using Dokka. * * @author Erik C. Thauvin * @since 1.0 @@ -63,9 +63,7 @@ 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 @@ -76,7 +74,8 @@ 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 */ @@ -248,7 +247,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 @@ -260,7 +259,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 @@ -279,7 +278,6 @@ public class DokkaOperation extends AbstractProcessOperation { *

  • -privateApi
    • *
  • +warnUndocumented
    • *
  • +suppress
    • - *
  • +visibility:PUBLIC
    • *
  • ...
    • * * @@ -299,7 +297,6 @@ public class DokkaOperation extends AbstractProcessOperation { *
  • -privateApi
    • *
  • +warnUndocumented
    • *
  • +suppress
    • - *
  • +visibility:PUBLIC
    • *
  • ...
    • * * @@ -412,7 +409,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 @@ -423,7 +420,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 4c48116..ba78a35 100644 --- a/src/main/java/rife/bld/extension/dokka/SourceSet.java +++ b/src/main/java/rife/bld/extension/dokka/SourceSet.java @@ -388,12 +388,11 @@ public class SourceSet { /** * Set the list of package source set configuration in format: *
      - *
    • matchingRegexp
      • + *
    • *
    • -deprecated
      • *
    • -privateApi
      • *
    • +warnUndocumented
      • *
    • +suppress
      • - *
    • +visibility:PUBLIC
      • *
    • ...
      • *
    * @@ -408,12 +407,11 @@ public class SourceSet { /** * Set the list of package source set configuration in format: *
      - *
    • matchingRegexp
      • + *
    • *
    • -deprecated
      • *
    • -privateApi
      • *
    • +warnUndocumented
      • *
    • +suppress
      • - *
    • +visibility:PUBLIC
      • *
    • ...
      • *
    * @@ -470,7 +468,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