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

Added docs command

Browse source
This commit is contained in:
Erik C. Thauvin 2024-08-30 17:13:15 -07:00
parent a48a5d99fd
commit 50ae7438b0
Signed by: erik
GPG key ID: 776702A6A2DA330E
2 changed files with 14 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

6
README.md
View file

@ -28,6 +28,12 @@ Template for [bld](https://rife2.com/bld) projects using the [Kotlin extension](
## Build the documentation with [Dokka](https://github.com/Kotlin/dokka) ## Build the documentation with [Dokka](https://github.com/Kotlin/dokka)
```console
./bld docs
```
or any of:
```console ```console
./bld javadoc ./bld javadoc
./bld dokka-html ./bld dokka-html

8
src/bld/java/com/example/ExampleBuild.java
View file

@ -107,6 +107,14 @@ public class ExampleBuild extends Project {
.execute(); .execute();
} }
@BuildCommand(value = "docs", summary = "Generates all documentation")
public void docs() throws ExitStatusException, IOException, InterruptedException {
dokkaGfm();
dokkaHtml();
dokkaJekyll();
javadoc();
}
@BuildCommand(value = "dokka-gfm", summary = "Generates documentation in GitHub flavored markdown format") @BuildCommand(value = "dokka-gfm", summary = "Generates documentation in GitHub flavored markdown format")
public void dokkaGfm() throws ExitStatusException, IOException, InterruptedException { public void dokkaGfm() throws ExitStatusException, IOException, InterruptedException {
new DokkaOperation() new DokkaOperation()