DokkaVersioningPluginParameters

Configuration for Dokka's Versioning plugin.

The versioning plugin provides the ability to host documentation for multiple versions of your library/application with seamless switching between them. This, in turn, provides a better experience for your users.

Note: The versioning plugin only works with Dokka's HTML format.

Constructors

Link copied to clipboard
constructor(name: String)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

An optional list of paths to other documentation versions. It must point to Dokka's outputs directly. This is useful if different versions can't all be in the same directory.

Link copied to clipboard

An optional path to a parent folder that contains other documentation versions. It requires a specific directory structure.

Link copied to clipboard
@get:Input
open val pluginFqn: String
Link copied to clipboard

An optional boolean value indicating whether to render the navigation dropdown on all pages.

Link copied to clipboard
@get:Input
abstract val version: Property<String>

The version of your application/library that documentation is going to be generated for. This will be the version shown in the dropdown menu.

Link copied to clipboard

An optional list of strings that represents the order that versions should appear in the dropdown menu.

Functions

Link copied to clipboard
open override fun getName(): String
Link copied to clipboard
open override fun jsonEncode(): String