diff options
| author | Ignat Beresnev <ignat.beresnev@jetbrains.com> | 2023-01-19 04:10:57 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-01-19 04:10:57 +0100 |
| commit | 5eeb2bbeb8c71ae813808ee0e8d09293c4abe1c1 (patch) | |
| tree | bb62ab50a59cbeca06de6fd1eb5c75ff27bc5bd0 /examples/maven | |
| parent | 1fa8552994fb292729eca8c0de6a1561380b008c (diff) | |
| download | dokka-5eeb2bbeb8c71ae813808ee0e8d09293c4abe1c1.tar.gz dokka-5eeb2bbeb8c71ae813808ee0e8d09293c4abe1c1.tar.bz2 dokka-5eeb2bbeb8c71ae813808ee0e8d09293c4abe1c1.zip | |
Revise README documentation for examples and plugins (#2736)
Diffstat (limited to 'examples/maven')
| -rw-r--r-- | examples/maven/README.md | 11 | ||||
| -rw-r--r-- | examples/maven/pom.xml | 3 |
2 files changed, 14 insertions, 0 deletions
diff --git a/examples/maven/README.md b/examples/maven/README.md new file mode 100644 index 00000000..766b80fd --- /dev/null +++ b/examples/maven/README.md @@ -0,0 +1,11 @@ +# Dokka Maven example + +This example demonstrates how you can configure Dokka in a Maven-based project. + +### Running + +Run the `dokka:dokka` goal to generate documentation for this example: + +```bash +mvn dokka:dokka +``` diff --git a/examples/maven/pom.xml b/examples/maven/pom.xml index 74675d6d..7c9de827 100644 --- a/examples/maven/pom.xml +++ b/examples/maven/pom.xml @@ -68,6 +68,9 @@ <lineSuffix>#L</lineSuffix> </link> </sourceLinks> + <includes> + <include>Module.md</include> + </includes> </configuration> </plugin> </plugins> |