Skip to content

Instantly share code, notes, and snippets.

@jimlyas
Last active January 4, 2022 13:27
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save jimlyas/46025eac76169387849e2e86cb8792d2 to your computer and use it in GitHub Desktop.
Save jimlyas/46025eac76169387849e2e86cb8792d2 to your computer and use it in GitHub Desktop.
Gist for Dokka Medium
// In your root module
tasks.withType(DokkaMultiModuleTask::class.java).configureEach {
moduleName.set("name")
outputDirectory.set(file(buildDir))
}
// In your sub module
tasks.withType(DokkaTaskPartial::class.java).configureEach {
dokkaSourceSets {
// Your configuration
}
}
/**
* A group of *members*.
*
* This class has no useful logic; it's just a documentation example.
*
* @param T the type of a member in this group.
* @property name the name of this group.
* @constructor Creates an empty group.
*/
class Group<T>(val name: String) {
/**
* Adds a [member] to this group.
* @param member T type of the member to be added.
* @return the new size of the group.
*/
fun add(member: T): Int { ... }
}

Module ModuleName

Here you can define what your module actually is and what it does

Package your.package.name

What code do you stored in this package

Level 2 heading

Text after this heading is also part of documentation for your.package.name

Package other.package.name

Useful information about your other package.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment