# Dokka examples

## Gradle

| Project                                                                             | Description                                                                                                                                                           |
|-------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [dokka-customFormat-example](gradle/dokka-customFormat-example)                     | Demonstrates how to override `.css` styles and add custom images as assets, allowing you to change the logo used in the header.                                       |
| [dokka-gradle-example](gradle/dokka-gradle-example)                                 | Demonstrates how to apply Dokka in a simple single-project Gradle build, as well as how to configure it.                                                              |
| [dokka-kotlinAsJava-example](gradle/dokka-kotlinAsJava-example)                     | Demonstrates how to apply Dokka plugins, [Kotlin as Java](../plugins/kotlin-as-java) specifically.                                                                    |
| [dokka-library-publishing-example](gradle/dokka-library-publishing-example)         | Demonstrates how to integrate Dokka into the publishing process of a library, adding documentation generated by Dokka as artifacts.                                   |
| [dokka-multimodule-example](gradle/dokka-multimodule-example)                       | Demonstrates how to apply and configure Dokka in a [multi-project build](https://docs.gradle.org/current/userguide/multi_project_builds.html).                        |
| [dokka-multiplatform-example](gradle/dokka-multiplatform-example)                   | Demonstrates Dokka's configuration and output for a simple [Kotlin Multiplatform](https://kotlinlang.org/docs/multiplatform.html) project.                            |
| [dokka-versioning-multimodule-example](gradle/dokka-versioning-multimodule-example) | Demonstrates configuration of Dokka's [versioning plugin](../../../plugins/versioning), which allows readers to navigate through different versions of documentation. |

## Maven

| Project        | Description                                         |
|----------------|-----------------------------------------------------|
| [maven](maven) | Simple Maven project with basic Dokka configuration |

## Plugins

| Project                                       | Description                                                                                            |
|-----------------------------------------------|--------------------------------------------------------------------------------------------------------|
| [hide-internal-api](plugin/hide-internal-api) | Dokka plugin that excludes declarations from generated documentation based on an `Internal` annotation |