Compare commits

..

No commits in common. "200479e1c1813a7b249f34e5abd48a811f4810e3" and "28ad500a12f67c4ebcf0a5c4ff911e96ddfc5efa" have entirely different histories.

5 changed files with 34 additions and 62 deletions

View file

@ -50,7 +50,7 @@ public class CompileKotlinOperation extends AbstractOperation<CompileKotlinOpera
private BaseProject project_;
/**
* Returns the list of JARs contained in a given directory.
* Returns the list JARs contained in a given directory.
*
* @param directory the directory
* @param regex the regular expression to match
@ -74,12 +74,6 @@ public class CompileKotlinOperation extends AbstractOperation<CompileKotlinOpera
return jars;
}
/**
* Returns the list of Kotlin source file {{@code .kt}} contained in a given directory.
*
* @param directory the directory
* @return the list of Kotlin files
*/
public static Collection<File> getKotlinFileList(File directory) {
if (directory == null) {
return Collections.emptyList();
@ -173,7 +167,7 @@ public class CompileKotlinOperation extends AbstractOperation<CompileKotlinOpera
}
/**
* Provides a list of compilation options to pass to the Kotlin compiler.
* Provides a list of compilation options to pass to the {@code kotlinc} compiler.
*
* @param options the compiler options
* @return this operation instance
@ -247,7 +241,7 @@ public class CompileKotlinOperation extends AbstractOperation<CompileKotlinOpera
}
/**
* Part of the {@link #execute} operation, build sources to a given destination.
* Part of the {@link #execute} operation, build sources to a destination.
*
* @param classpath the classpath list used for the compilation
* @param sources the source files to compile
@ -338,7 +332,6 @@ public class CompileKotlinOperation extends AbstractOperation<CompileKotlinOpera
* <li>{@link #testSourceFiles() testSourceFile} to the {@code kotlin} directory in
* {@link BaseProject#srcTestDirectory() srcTestDirectory}</li>
* <li>{@link CompileKotlinOptions#jdkRelease jdkRelease} to {@link BaseProject#javaRelease() javaRelease}</li>
* <li>{@link CompileKotlinOptions#noStdLib(boolean) noStdLib} to {@code true}</li>
* </ul>
*
* @param project the project to configure the compile operation from
@ -354,7 +347,6 @@ public class CompileKotlinOperation extends AbstractOperation<CompileKotlinOpera
if (project.javaRelease() != null && !compileOptions_.hasRelease()) {
compileOptions_.jdkRelease(project.javaRelease());
}
compileOptions_.noStdLib(true);
return op;
}
@ -452,7 +444,7 @@ public class CompileKotlinOperation extends AbstractOperation<CompileKotlinOpera
*/
public CompileKotlinOperation plugins(File directory, CompileKotlinPlugin... plugins) {
for (var plugin : plugins) {
plugins_.addAll(getJarList(directory, plugin.label));
plugins_.addAll(CompileKotlinOperation.getJarList(directory, plugin.label));
}
return this;
}

View file

@ -45,7 +45,7 @@ public class CompileKotlinOptions {
private String moduleName_;
private boolean noJdk_;
private boolean noReflect_;
private boolean noStdLib_;
private boolean noStdLib_ = true;
private boolean noWarn_;
private String path_;
private boolean progressive_;
@ -68,14 +68,14 @@ public class CompileKotlinOptions {
* <p>
* 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:
* <ul>
* <li>{@code -include-runtime -d hello.jar hello.kt}</li>
* </ul>
* <p>
* {@code -include-runtime -d hello.jar hello.kt}
* <p>
* 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 (\).
* <ul>
* <li>{@code -include-runtime -d 'My folder'}</li>
* </ul>
* <p>
* {@code -include-runtime -d 'My folder'}
* <p>
* 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.
* <p>
* Limit the API of the JDK in the classpath to the specified Java version. Automatically sets
* {@link #jvmTarget(String) JVM target} version.
* <p>
* 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.
* <p>
* 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.
* <p>
* 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.
* <p>
* 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.
* <p>
* 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.
* <p>
* Use fully qualified class names.
* Script definition template classes. Use fully qualified class names.
*
* @param classNames the list class names
* @return this class instance

View file

@ -16,12 +16,6 @@
package rife.bld.extension;
/**
* Defines the known Kotlin compiler plugins match (regex) strings.
*
* @author <a href="https://erik.thauvin.net/">Erik C. Thauvin</a>
* @since 1.0
*/
public enum CompileKotlinPlugin {
ALL_OPEN("^allopen-compiler-plugin-.*$"),
ASSIGNMENT("^assignment-compiler-plugin-.*$"),

View file

@ -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 <a href="https://erik.thauvin.net/">Erik C. Thauvin</a>
* @since 1.0
@ -63,9 +63,7 @@ public class DokkaOperation extends AbstractProcessOperation<DokkaOperation> {
private boolean suppressInheritedMembers_;
/**
* Sets the delay substitution of some elements.
* <p>
* 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<DokkaOperation> {
}
/**
* 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<DokkaOperation> {
}
/**
* 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<DokkaOperation> {
}
/**
* 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<DokkaOperation> {
* <li>-privateApi</li>
* <li>+warnUndocumented</li>
* <li>+suppress</li>
* <li>+visibility:PUBLIC</li>
* <li>...</li>
* </ul>
*
@ -299,7 +297,6 @@ public class DokkaOperation extends AbstractProcessOperation<DokkaOperation> {
* <li>-privateApi</li>
* <li>+warnUndocumented</li>
* <li>+suppress</li>
* <li>+visibility:PUBLIC</li>
* <li>...</li>
* </ul>
*
@ -412,7 +409,7 @@ public class DokkaOperation extends AbstractProcessOperation<DokkaOperation> {
}
/**
* 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<DokkaOperation> {
}
/**
* 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

View file

@ -388,12 +388,11 @@ public class SourceSet {
/**
* Set the list of package source set configuration in format:
* <ul>
* <li>matchingRegexp</li>
* <li><matchingRegexp</li>
* <li>-deprecated</li>
* <li>-privateApi</li>
* <li>+warnUndocumented</li>
* <li>+suppress</li>
* <li>+visibility:PUBLIC</li>
* <li>...</li>
* </ul>
*
@ -408,12 +407,11 @@ public class SourceSet {
/**
* Set the list of package source set configuration in format:
* <ul>
* <li>matchingRegexp</li>
* <li><matchingRegexp</li>
* <li>-deprecated</li>
* <li>-privateApi</li>
* <li>+warnUndocumented</li>
* <li>+suppress</li>
* <li>+visibility:PUBLIC</li>
* <li>...</li>
* </ul>
*
@ -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