Skip to content

Commit eafb373

Browse files
committed
Update the docs with some examples for possible arguments
1 parent 5bed013 commit eafb373

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,31 @@ dokka(
4343
)
4444
```
4545

46+
### Supported `dokka-cli` arguments
47+
48+
See the Dokka [docs](https://github.com/Kotlin/dokka#using-the-command-line) for more information.
49+
50+
```starlark
51+
dokka(
52+
name = "dokka_javadoc_test",
53+
srcs = [ ... ],
54+
moduleName = "name goes here",
55+
moduleDisplayName = "display name goes here",
56+
offlineMode = False,
57+
failOnWarning = False,
58+
noStdlibLink = False,
59+
noJdkLink = False,
60+
jdkVersion = "1.8",
61+
includeNonPublic = False,
62+
skipEmptyPackages = False,
63+
skipDeprecated = False,
64+
reportUndocumented = False,
65+
plugins = [
66+
...
67+
],
68+
)
69+
```
70+
4671
## Building
4772

4873
`$ bazel build //sample:sample_dokka_docs`

0 commit comments

Comments
 (0)