- * The contents of specified files are parsed and embedded into documentation as module and package descriptions. - *
- * This can be configured on per-package basis.
- *
- * @param files one or more files
- * @return this operation instance
- * @see #includesPaths(Collection)
- */
- public DokkaOperation includes(Path... files) {
- return includesPaths(List.of(files));
- }
-
-
/**
* Retrieves the markdown files that contain the module and package documentation.
*
@@ -501,43 +483,12 @@ public class DokkaOperation extends AbstractProcessOperation
- * The contents of specified files are parsed and embedded into documentation as module and package descriptions.
- *
- * This can be configured on per-package basis.
- *
- * @param files the markdown files
- * @return this operation instance
- * @see #includes(Path...)
- */
- public DokkaOperation includesPaths(Collection
- * The contents of specified files are parsed and embedded into documentation as module and package descriptions.
- *
- * This can be configured on per-package basis.
- *
- * @param files the markdown files
- * @return this operation instance
- * @see #includes(String...)
- */
- public DokkaOperation includesStrings(Collection
@@ -683,19 +598,8 @@ public class DokkaOperation extends AbstractProcessOperation
- * The directory to where documentation is generated, regardless of output format.
- *
- * @param outputDir the output directory
- * @return this operation instance
- */
- public DokkaOperation outputDir(Path outputDir) {
- return outputDir(outputDir.toFile());
+ outputDir_ = new File(outputDir);
+ return this;
}
/**
@@ -737,12 +641,12 @@ public class DokkaOperation extends AbstractProcessOperation
diff --git a/src/main/java/rife/bld/extension/dokka/AnalysisPlatform.java b/src/main/java/rife/bld/extension/dokka/AnalysisPlatform.java
index 0f6c1a4..dd6ff1a 100644
--- a/src/main/java/rife/bld/extension/dokka/AnalysisPlatform.java
+++ b/src/main/java/rife/bld/extension/dokka/AnalysisPlatform.java
@@ -1,5 +1,5 @@
/*
- * Copyright 2023-2025 the original author or authors.
+ * Copyright 2023-2024 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
diff --git a/src/main/java/rife/bld/extension/dokka/DocumentedVisibility.java b/src/main/java/rife/bld/extension/dokka/DocumentedVisibility.java
index 76e368c..dae65a4 100644
--- a/src/main/java/rife/bld/extension/dokka/DocumentedVisibility.java
+++ b/src/main/java/rife/bld/extension/dokka/DocumentedVisibility.java
@@ -1,5 +1,5 @@
/*
- * Copyright 2023-2025 the original author or authors.
+ * Copyright 2023-2024 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
diff --git a/src/main/java/rife/bld/extension/dokka/LoggingLevel.java b/src/main/java/rife/bld/extension/dokka/LoggingLevel.java
index 1cac7ae..b493e11 100644
--- a/src/main/java/rife/bld/extension/dokka/LoggingLevel.java
+++ b/src/main/java/rife/bld/extension/dokka/LoggingLevel.java
@@ -1,5 +1,5 @@
/*
- * Copyright 2023-2025 the original author or authors.
+ * Copyright 2023-2024 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
diff --git a/src/main/java/rife/bld/extension/dokka/OutputFormat.java b/src/main/java/rife/bld/extension/dokka/OutputFormat.java
index a1a5f37..0d4a2c0 100644
--- a/src/main/java/rife/bld/extension/dokka/OutputFormat.java
+++ b/src/main/java/rife/bld/extension/dokka/OutputFormat.java
@@ -1,5 +1,5 @@
/*
- * Copyright 2023-2025 the original author or authors.
+ * Copyright 2023-2024 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
diff --git a/src/main/java/rife/bld/extension/dokka/SourceSet.java b/src/main/java/rife/bld/extension/dokka/SourceSet.java
index a6336e7..2b5f24a 100644
--- a/src/main/java/rife/bld/extension/dokka/SourceSet.java
+++ b/src/main/java/rife/bld/extension/dokka/SourceSet.java
@@ -1,5 +1,5 @@
/*
- * Copyright 2023-2025 the original author or authors.
+ * Copyright 2023-2024 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -19,12 +19,8 @@ package rife.bld.extension.dokka;
import rife.bld.extension.DokkaOperation;
import java.io.File;
-import java.nio.file.Path;
-import java.util.ArrayList;
-import java.util.Collection;
-import java.util.List;
-import java.util.Map;
-import java.util.concurrent.ConcurrentSkipListMap;
+import java.util.*;
+import java.util.concurrent.ConcurrentHashMap;
import java.util.stream.Collectors;
/**
@@ -33,16 +29,15 @@ import java.util.stream.Collectors;
* @author Erik C. Thauvin
* @since 1.0
*/
-@SuppressWarnings("PMD.UseConcurrentHashMap")
public class SourceSet {
private final Collection
- * This is useful if some types that come from dependencies are not resolved/picked up automatically.
- *
- * This option accepts both {@code .jar} and {@code .klib} files.
- *
- * @param files one or more file
- * @return this operation instance
- * @see #classpathPaths(Collection)
- */
- public SourceSet classpath(Path... files) {
- return classpathPaths(List.of(files));
+ classpath_.addAll(Arrays.stream(files).map(File::new).toList());
+ return this;
}
/**
@@ -285,7 +266,6 @@ public class SourceSet {
*
* @param files the collection of files
* @return this operation instance
- * @see #classpath(File...)
*/
public SourceSet classpath(Collection
- * This is useful if some types that come from dependencies are not resolved/picked up automatically.
- *
- * This option accepts both {@code .jar} and {@code .klib} files.
- *
- * @param files the collection of files
- * @return this operation instance
- * @see #classpath(Path...)
- */
- public SourceSet classpathPaths(Collection
- * This is useful if some types that come from dependencies are not resolved/picked up automatically.
- *
- * This option accepts both {@code .jar} and {@code .klib} files.
- *
- * @param files the collection of files
- * @return this operation instance
- * @see #classpath(String...)
- */
- public SourceSet classpathStrings(Collection
- * The Markdown files that contain module and package documentation.
- *
- * The contents of the specified files are parsed and embedded into documentation as module and package
- * descriptions.
- *
- * @param files one or more files
- * @return this operation instance
- * @see #classpathPaths(Collection)
- */
- public SourceSet includes(Path... files) {
- return includesPaths(List.of(files));
- }
-
-
/**
* Retrieves the Markdown files that contain module and package documentation.
*
@@ -510,45 +443,12 @@ public class SourceSet {
*
* @param files the collection of files
* @return this operation instance
- * @see #includes(File...)
*/
public SourceSet includes(Collection
- * The Markdown files that contain module and package documentation.
- *
- * The contents of the specified files are parsed and embedded into documentation as module and package
- * descriptions.
- *
- * @param files the collection of files
- * @return this operation instance
- * @see #includes(Path...)
- */
- public SourceSet includesPaths(Collection
- * The Markdown files that contain module and package documentation.
- *
- * The contents of the specified files are parsed and embedded into documentation as module and package
- * descriptions.
- *
- * @param files the collection of files
- * @return this operation instance
- * @see #classpath(String...)
- */
- public SourceSet includesStrings(Collection
@@ -565,15 +465,6 @@ public class SourceSet {
return this;
}
- /**
- * Retrieves the version of the JDK to use for linking to JDK Javadocs.
- *
- * @return the JDK version.
- */
- public String jdkVersion() {
- return jdkVersion_;
- }
-
/**
* Sets the version of JDK to use for linking to JDK Javadocs.
*
@@ -586,7 +477,8 @@ public class SourceSet {
* @return this operation instance
*/
public SourceSet jdkVersion(int jdkVersion) {
- return jdkVersion(String.valueOf(jdkVersion));
+ jdkVersion_ = String.valueOf(jdkVersion);
+ return this;
}
/**
@@ -607,7 +499,8 @@ public class SourceSet {
* @return this operation instance
*/
public SourceSet languageVersion(int languageVersion) {
- return languageVersion(String.valueOf(languageVersion));
+ languageVersion_ = String.valueOf(languageVersion);
+ return this;
}
/**
@@ -709,7 +602,8 @@ public class SourceSet {
* @return this operation instance
*/
public SourceSet perPackageOptions(String... perPackageOptions) {
- return perPackageOptions(List.of(perPackageOptions));
+ perPackageOptions_.addAll(List.of(perPackageOptions));
+ return this;
}
/**
@@ -738,7 +632,6 @@ public class SourceSet {
*
* @param samples the samples
* @return this operation instance
- * @see #samples(File...)
*/
public SourceSet samples(Collection
- * The directories or files that contain sample functions which are referenced via the {@code @sample} KDoc
- * tag.
- *
- * @param samples nne or more samples
- * @return this operation instance
- * @see #samplesPaths(Collection)
- */
- public SourceSet samples(Path... samples) {
- return samplesPaths(List.of(samples));
- }
-
- /**
- * Set the directories or files that contain sample functions.
- *
- * The directories or files that contain sample functions which are referenced via the {@code @sample} KDoc
- * tag.
- *
- * @param samples the samples
- * @return this operation instance
- * @see #samples(Path...)
- */
- public SourceSet samplesPaths(Collection
- * The directories or files that contain sample functions which are referenced via the {@code @sample} KDoc
- * tag.
- *
- * @param samples the samples
- * @return this operation instance
- * @see #samples(String...)
- */
- public SourceSet samplesStrings(Collection
- * The source code roots to be analyzed and documented. Acceptable inputs are directories and individual
- * {@code .kt} / {@code .java} files.
- *
- * @param src pne ore moe source code roots
- * @return this operation instance
- * @see #srcPaths(Collection)
- */
- public SourceSet src(Path... src) {
- return srcPaths(List.of(src));
+ src_.addAll(Arrays.stream(src).map(File::new).toList());
+ return this;
}
/**
@@ -938,19 +774,8 @@ public class SourceSet {
* @return this operation instance
*/
public SourceSet srcLink(File srcPath, String remotePath, String lineSuffix) {
- return srcLink(srcPath.getAbsolutePath(), remotePath, lineSuffix);
- }
-
- /**
- * Sets the mapping between a source directory and a Web service for browsing the code.
- *
- * @param srcPath the source path
- * @param remotePath the remote path
- * @param lineSuffix the line suffix
- * @return this operation instance
- */
- public SourceSet srcLink(Path srcPath, String remotePath, String lineSuffix) {
- return srcLink(srcPath.toFile().getAbsolutePath(), remotePath, lineSuffix);
+ srcLinks_.put(srcPath.getAbsolutePath(), remotePath + lineSuffix);
+ return this;
}
/**
@@ -962,34 +787,6 @@ public class SourceSet {
return srcLinks_;
}
- /**
- * Sets the source code roots to be analyzed and documented.
- *
- * The source code roots to be analyzed and documented. Acceptable inputs are directories and individual
- * {@code .kt} / {@code .java} files.
- *
- * @param src the source code roots
- * @return this operation instance
- * @see #src(Path...)
- */
- public SourceSet srcPaths(Collection
- * The source code roots to be analyzed and documented. Acceptable inputs are directories and individual
- * {@code .kt} / {@code .java} files.
- *
- * @param src the source code roots
- * @return this operation instance
- * @see #src(String...)
- */
- public SourceSet srcStrings(Collection
@@ -997,13 +794,13 @@ public class SourceSet {
*
* @param suppressedFiles the suppressed files
* @return this operation instance
- * @see #suppressedFiles(File...)
*/
public SourceSet suppressedFiles(Collection
- * The files to be suppressed when generating documentation.
- *
- * @param suppressedFiles one or moe suppressed files
- * @return this operation instance
- * @see #suppressedFilesPaths(Collection)
- */
- public SourceSet suppressedFiles(Path... suppressedFiles) {
- return suppressedFilesPaths(List.of(suppressedFiles));
- }
-
- /**
- * Sets the paths to files to be suppressed.
- *
- * The files to be suppressed when generating documentation.
- *
- * @param suppressedFiles the suppressed files
- * @return this operation instance
- * @see #suppressedFiles(Path...)
- */
- public SourceSet suppressedFilesPaths(Collection
- * The files to be suppressed when generating documentation.
- *
- * @param suppressedFiles the suppressed files
- * @return this operation instance
- * @see #suppressedFiles(String...)
- */
- public SourceSet suppressedFilesStrings(Collection