https://github.com/Vorlonsoft/EasyDokkaPlugin
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.
https://github.com/Vorlonsoft/EasyDokkaPlugin
android dokka gradle gradle-android-plugin gradle-plugin gradle-task java javadoc javadoc-documentation javadocs kotlin
Last synced: 7 months ago
JSON representation
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.
- Host: GitHub
- URL: https://github.com/Vorlonsoft/EasyDokkaPlugin
- Owner: Vorlonsoft
- License: apache-2.0
- Created: 2018-08-05T09:02:36.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2018-09-29T20:20:31.000Z (over 7 years ago)
- Last Synced: 2025-04-23T07:50:39.983Z (about 1 year ago)
- Topics: android, dokka, gradle, gradle-android-plugin, gradle-plugin, gradle-task, java, javadoc, javadoc-documentation, javadocs, kotlin
- Language: Gradle
- Homepage: https://vorlonsoft.github.io/EasyDokkaPlugin/
- Size: 92.8 KB
- Stars: 13
- Watchers: 2
- Forks: 5
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-groovy - EasyDokkaPlugin - Gradle script plugin to generate documentation by Dokka documentation engine for Java and Kotlin (Scripting Tools)
README
# EasyDokkaPlugin [](#) [](https://github.com/Vorlonsoft/EasyDokkaPlugin/releases)
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.
## Contents
* [Usage](#usage)
* [1. Have a working Gradle build](#1-have-a-working-gradle-build)
* [2. Call the Script](#2-call-the-script)
* [3. Generate documentation](#3-generate-documentation)
* [4. Get documentation](#4-get-documentation)
* [Optional properties](#optional-properties)
* [Groovydoc documentation](#groovydoc-documentation)
* [Already in use](#already-in-use-in-following-libraries)
* [Other plugins](#our-other-plugins)
* [Contribute](#contribute)
* [License](#license)
## Usage
### 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:
```groovy
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:
```bash
$ gradle dokkaJavadocsJar
```
### 4. Get documentation
Get generated documentation from `${buildDir}` directory.
### Optional properties
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](https://github.com/Vorlonsoft/AndroidRate):
```properties
DOKKA_FATJAR_VERSION = 0.9.17
DOKKA_OUTPUT_FORMAT = javadoc
```
There are optional properties which can be set:
#### Dokka fatjar version
```properties
DOKKA_FATJAR_VERSION (default is "0.9.17")
```
${latestVersion} is [](#)
#### Dokka output format
```properties
DOKKA_OUTPUT_FORMAT (default is "javadoc")
```
Options:
* `html` - minimalistic html format used by default
* `javadoc` - Dokka mimic to javadoc
* `html-as-java` - as `html` but using java syntax
* `markdown` - Markdown structured as `html`
* `gfm` - GitHub flavored markdown
* `jekyll` - Jekyll compatible markdown
* `kotlin-website` - internal format used for documentation on *kotlinlang.org*
## Groovydoc documentation
See [EasyDokkaPlugin documentation](https://vorlonsoft.github.io/EasyDokkaPlugin/groovydoc/)
## Already in use in following libraries
* [AndroidRate library](https://github.com/Vorlonsoft/AndroidRate)
* ...
## Our other plugins
[GradleMavenPush](https://github.com/Vorlonsoft/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).
## Contribute
1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Added some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request
## License
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
https://www.apache.org/licenses/LICENSE-2.0
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.