rife2/bld-kotlin
rife2/bld-kotlin
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Cleaned up Javadoc links

Browse source
This commit is contained in:
Erik C. Thauvin 2023-11-19 10:59:36 -08:00
parent 59416e4986
commit c83c76dc60
3 changed files with 8 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

8
src/main/java/rife/bld/extension/CompileKotlinOperation.java
View file

@ -235,7 +235,7 @@ public class CompileKotlinOperation extends AbstractOperation<CompileKotlinOpera
} }
/** /**
* Part of the {@link #execute} operation, builds the main sources. * Part of the {@link #execute execute} operation, builds the main sources.
*/ */
protected void executeBuildMainSources() protected void executeBuildMainSources()
throws IOException { throws IOException {
@ -247,7 +247,7 @@ public class CompileKotlinOperation extends AbstractOperation<CompileKotlinOpera
} }
/** /**
* Part of the {@link #execute} operation, build sources to a given destination. * Part of the {@link #execute execute} operation, build sources to a given destination.
* *
* @param classpath the classpath list used for the compilation * @param classpath the classpath list used for the compilation
* @param sources the source files to compile * @param sources the source files to compile
@ -301,7 +301,7 @@ public class CompileKotlinOperation extends AbstractOperation<CompileKotlinOpera
} }
/** /**
* Part of the {@link #execute} operation, builds the test sources. * Part of the {@link #execute execute} operation, builds the test sources.
*/ */
protected void executeBuildTestSources() protected void executeBuildTestSources()
throws IOException { throws IOException {
@ -313,7 +313,7 @@ public class CompileKotlinOperation extends AbstractOperation<CompileKotlinOpera
} }
/** /**
* Part of the {@link #execute} operation, creates the build directories. * Part of the {@link #execute execute} operation, creates the build directories.
*/ */
protected void executeCreateBuildDirectories() throws IOException { protected void executeCreateBuildDirectories() throws IOException {
if (buildMainDirectory() != null && !buildMainDirectory().exists() && !buildMainDirectory().mkdirs()) { if (buildMainDirectory() != null && !buildMainDirectory().exists() && !buildMainDirectory().mkdirs()) {

4
src/main/java/rife/bld/extension/dokka/DokkaOperation.java
View file

@ -76,7 +76,7 @@ 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 execute} operation, constructs the command list to use for building the process.
* *
* @since 1.5 * @since 1.5
*/ */
@ -358,7 +358,7 @@ public class DokkaOperation extends AbstractProcessOperation<DokkaOperation> {
} }
/** /**
* Sets the Markdown * Sets the Markdown files that contain module and package documentation.
* <p> * <p>
* The contents of specified files are parsed and embedded into documentation as module and package descriptions. * The contents of specified files are parsed and embedded into documentation as module and package descriptions.
* <p> * <p>

4
src/main/java/rife/bld/extension/dokka/SourceSet.java
View file

@ -276,7 +276,7 @@ public class SourceSet {
* Sets the display name of the source set, used both internally and externally. * Sets the display name of the source set, used both internally and externally.
* <p> * <p>
* The name is used both externally (for example, the source set name is visible to documentation readers) and * The name is used both externally (for example, the source set name is visible to documentation readers) and
* internally (for example, for logging messages of {@link #reportUndocumented}). * internally (for example, for logging messages of {@link #reportUndocumented reportUndocumented}).
* <p> * <p>
* The platform name can be used if you don't have a better alternative. * The platform name can be used if you don't have a better alternative.
* *
@ -396,7 +396,7 @@ public class SourceSet {
* <p> * <p>
* Whether to generate external documentation links to JDK's Javadocs. * Whether to generate external documentation links to JDK's Javadocs.
* <p> * <p>
* The version of JDK Javadocs is determined by the {@link #jdkVersion} option. * The version of JDK Javadocs is determined by the {@link #jdkVersion jdkVersion} option.
* <p> * <p>
* Note: Links are generated when noJdkLink is set to false. * Note: Links are generated when noJdkLink is set to false.
* *