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

Added method to reset the Dokka plugins

Browse source 
Added examples for generating documenation in HTML and markdown formats
This commit is contained in:
Erik C. Thauvin 2023-11-05 22:42:51 -08:00
parent c59a08542f
commit 84f14212f4
7 changed files with 78 additions and 29 deletions
Download patch file Download diff file Expand all files Collapse all files

29
examples/src/bld/java/com/example/ExampleBuild.java
View file

@ -8,6 +8,7 @@ import rife.bld.extension.dokka.LoggingLevel;
import rife.bld.operations.exceptions.ExitStatusException;
import java.io.IOException;
import java.nio.file.Path;
import java.util.List;
import java.util.logging.ConsoleHandler;
import java.util.logging.Level;
@ -54,6 +55,34 @@ public class ExampleBuild extends BaseProject {
.execute();
}
@BuildCommand(value = "dokka-gfm", summary = "Generates documentation in GitHub flavored markdown format")
public void dokkaGfm() throws ExitStatusException, IOException, InterruptedException {
new DokkaOperation()
.fromProject(this)
.loggingLevel(LoggingLevel.INFO)
.pluginsClasspath(true)
.pluginsClasspath("lib/bld/dokka-base-1.9.10.jar",
"lib/bld/analysis-kotlin-descriptors-1.9.10.jar",
"lib/bld/gfm-plugin-1.9.10.jar",
"lib/bld/freemarker-2.3.31.jar")
.outputDir(Path.of(buildDirectory().getAbsolutePath(), "dokka", "gfm").toFile())
.execute();
}
@BuildCommand(value = "dokka-html", summary = "Generates documentation in HTML format")
public void dokkaHtml() throws ExitStatusException, IOException, InterruptedException {
new DokkaOperation()
.fromProject(this)
.loggingLevel(LoggingLevel.INFO)
.pluginsClasspath(true)
.pluginsClasspath("lib/bld/dokka-base-1.9.10.jar",
"lib/bld/analysis-kotlin-descriptors-1.9.10.jar",
"lib/bld/kotlinx-html-jvm-0.7.5.jar",
"lib/bld/freemarker-2.3.31.jar")
.outputDir(Path.of(buildDirectory().getAbsolutePath(), "dokka", "html").toFile())
.execute();
}
@BuildCommand(summary = "Generates Javadoc for the project")
public void javadoc() throws ExitStatusException, IOException, InterruptedException {
new DokkaOperation()