Gradle Script plugin to generate documentation by Dokka documentation engine in Javadoc or other formats for Java, Kotlin, Android and non-Android projects. It's very easy, you don't need to add to
dependencies section additional
classpath or think about compatibility issues, you don't need additional repositories also.
- Optional properties
- Groovydoc documentation
- Already in use
- Other plugins
1. Have a working Gradle build
It is up to you.
2. Call the Script
Add the following at the end of
build.gradle of each sub-module that you wish to generate documentation:
apply from: 'https://raw.github.com/Vorlonsoft/EasyDokkaPlugin/master/dokka.gradle'
3. Generate documentation
You can now generate documentation by Dokka documentation engine in Javadoc or other formats:
$ gradle dokkaJavadocsJar
4. Get documentation
Get generated documentation from
Create project root
gradle.properties. You may already have this file, in which case just edit the original. This file should contain the properties values which are common to all of your sub-projects (if you have any). The values in the sub-project
gradle.properties file are specific to the sub-project (and override those in the root
gradle.properties). For instance, here's AndroidRate's:
DOKKA_FATJAR_VERSION = 0.9.17
DOKKA_OUTPUT_FORMAT = javadoc
There are optional properties which can be set:
Dokka fatjar version
DOKKA_FATJAR_VERSION (default is "0.9.17")
Dokka output format
DOKKA_OUTPUT_FORMAT (default is "javadoc")
html- minimalistic html format used by default
javadoc- Dokka mimic to javadoc
htmlbut using java syntax
markdown- Markdown structured as
gfm- GitHub flavored markdown
jekyll- Jekyll compatible markdown
kotlin-website- internal format used for documentation on kotlinlang.org
Already in use in following libraries
Our other plugins
GradleMavenPush - helper to upload Gradle Android Artifacts, Gradle Java Artifacts and Gradle Kotlin Artifacts to Maven repositories (JCenter, Maven Central, Corporate staging/snapshot servers and local Maven repositories).
- Fork it
- Create your feature branch (
git checkout -b my-new-feature)
- Commit your changes (
git commit -am 'Added some feature')
- Push to the branch (
git push origin my-new-feature)
- Create new Pull Request
Copyright 2018 Vorlonsoft LLC
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.