Skip to content

Latest commit

 

History

History

basic-gradle-example

Dokka Gradle example

This example demonstrates how to apply Dokka in a simple single-project Gradle build, as well as how to configure it.

Configuration changes:

  • Custom project name used in the header, Dokka Gradle Example.
  • Description for the project and the packages taken from Module.md.
  • Documentation contains source links that lead to declarations in this GitHub repository.

screenshot demonstration of output

Running

Run the :dokkaGenerate Gradle task to generate documentation for this example:

./gradlew :dokkaGenerate