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

Added additional Javadoc

Browse source
This commit is contained in:
Erik C. Thauvin 2023-11-16 13:36:30 -08:00
parent 46e81b5928
commit 2701a439ae
2 changed files with 126 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -238,6 +238,11 @@ public class DokkaOperation extends AbstractProcessOperation<DokkaOperation> {
/**
* Sets whether to fail documentation generation if Dokka has emitted a warning or an error.
* <p>
* Whether to fail documentation generation if Dokka has emitted a warning or an error. The process waits until all
* errors and warnings have been emitted first.
* <p>
* This setting works well with {@link SourceSet#reportUndocumented}
*
* @param failOnWarning {@code true} or {@code false}
* @return this operation instance
@ -335,6 +340,10 @@ public class DokkaOperation extends AbstractProcessOperation<DokkaOperation> {
/**
* Sets the Markdown files that contain module and package documentation.
* <p>
* The contents of specified files are parsed and embedded into documentation as module and package descriptions.
* <p>
* This can be configured on per-package basis.
*
* @param files one or more files
* @return this operation instance
@ -345,7 +354,11 @@ public class DokkaOperation extends AbstractProcessOperation<DokkaOperation> {
}
/**
* Sets the Markdown files that contain module and package documentation.
* Sets the Markdown
* <p>
* The contents of specified files are parsed and embedded into documentation as module and package descriptions.
* <p>
* This can be configured on per-package basis.
*
* @param files the list of files
* @return this operation instance
@ -368,6 +381,8 @@ public class DokkaOperation extends AbstractProcessOperation<DokkaOperation> {
/**
* Sets the name of the project/module. Default is {@code root}.
* <p>
* The display name used to refer to the module. It is used for the table of contents, navigation, logging, etc.
*
* @param moduleName the project/module name
* @return this operation instance
@ -390,7 +405,15 @@ public class DokkaOperation extends AbstractProcessOperation<DokkaOperation> {
/**
* Sets whether to suppress obvious functions such as inherited from {@code kotlin.Any} and
* {@link java.lang.Object java.lang.Object}.
* {@link java.lang.Object}.
* <p>
* A function is considered to be obvious if it is:
* <ul>
* <li>Inherited from {@code kotlin.Any}, {@code Kotlin.Enum}, {@link java.lang.Object} or {@link java.lang.Enum},
* such as {@code equals}, {@code hashCode}, {@code toString}.
* <li>Synthetic (generated by the compiler) and does not have any documentation, such as
* {@code dataClass.componentN} or {@code dataClass.copy}.
* </ul>
*
* @param noSuppressObviousFunctions {@code true} or {@code false}
* @return this operation instance
@ -402,9 +425,19 @@ public class DokkaOperation extends AbstractProcessOperation<DokkaOperation> {
/**
* Sets whether to resolve remote files/links over network.
* <p>
* This includes package-lists used for generating external documentation links. For example, to make classes from
* the standard library clickable.
* <p>
* Setting this to true can significantly speed up build times in certain cases, but can also worsen documentation
* quality and user experience. For example, by not resolving class/member links from your dependencies, including
* the standard library.
* <p>
* Note: You can cache fetched files locally and provide them to Dokka as local paths.
*
* @param offlineMode the offline mode
* @return this operation instance
* @see SourceSet#externalDocumentationLinks(String, String)
*/
public DokkaOperation offlineMode(Boolean offlineMode) {
offlineMode_ = offlineMode;
@ -413,6 +446,8 @@ public class DokkaOperation extends AbstractProcessOperation<DokkaOperation> {
/**
* Sets the output directory path, {@code ./dokka} by default.
* <p>
* The directory to where documentation is generated, regardless of output format.
*
* @param outputDir the output directory
* @return this operation instance
@ -518,6 +553,8 @@ public class DokkaOperation extends AbstractProcessOperation<DokkaOperation> {
/**
* Sets the configurations for a source set.
* <p>
* Individual and additional configuration of Kotlin source sets.
*
* @param sourceSet the source set configurations
* @return this operation instance