From c189c8c338c219b8d773666475f5ae2818461b0a Mon Sep 17 00:00:00 2001 From: Ivan Canet Date: Fri, 25 Jan 2019 15:46:01 +0100 Subject: Typo in README: "not overrides" (#399) --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 170ecfa6..db1ccd24 100644 --- a/README.md +++ b/README.md @@ -79,7 +79,7 @@ dokka { impliedPlatforms = ["JVM"] // See platforms section of documentation // Manual adding files to classpath - // This property not overrides classpath collected from kotlinTasks but appends to it + // This property doesn't override classpath collected from kotlinTasks but appends to it classpath = [new File("$buildDir/other.jar")] // By default, sourceRoots is taken from kotlinTasks, following roots will be appended to it -- cgit From fc3b668e2acefad7990b8ed02b9382c0c800a04e Mon Sep 17 00:00:00 2001 From: Tim McCormack Date: Wed, 30 Jan 2019 13:51:00 +0000 Subject: Fix inner tag for "includes" in Maven syntax example (#414) `includes` uses `include` for subitems, not `file` --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index db1ccd24..ec8709c2 100644 --- a/README.md +++ b/README.md @@ -252,8 +252,8 @@ The available configuration options are shown below: - packages.md - extra.md + packages.md + extra.md -- cgit From f2359e05347708e625d5a6b339010cda2adc30de Mon Sep 17 00:00:00 2001 From: Tiem Song Date: Fri, 15 Feb 2019 05:24:21 -0800 Subject: Add instructions for configuring Dokka in IDEA (#386) Porting over changes from https://github.com/google/dokka/pull/9 --- README.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/README.md b/README.md index ec8709c2..69442dc9 100644 --- a/README.md +++ b/README.md @@ -456,3 +456,25 @@ Basically, given the `documentation` as a model, we do this: Dokka is built with Gradle. To build it, use `./gradlew build`. Alternatively, open the project directory in IntelliJ IDEA and use the IDE to build and run Dokka. + +Here's how to import and configure Dokka in IntelliJ IDEA: + * Select "Open" from the IDEA welcome screen, or File > Open if a project is + already open +* Select the directory with your clone of Dokka + * Note: IDEA may have an error after the project is initally opened; it is OK + to ignore this as the next step will address this error +* After IDEA opens the project, select File > New > Module from existing sources + and select the `build.gradle` file from the root directory of your Dokka clone +* Use the default options and select "OK" +* After Dokka is loaded into IDEA, open the Gradle tool window (View > Tool + Windows > Gradle) and click on the top left "Refresh all Gradle projects" + button +* Verify the following project settings. In File > Settings > Build, Execution, + Deployment > Build Tools > Gradle > Runner: + * Ensure "Delegate IDE build/run actions to gradle" is checked + * "Gradle Test Runner" should be selected in the "Run tests using" drop-down + menu +* Note: After closing and re-opening the project, IDEA may give an error + message: "Error Loading Project: Cannot load 3 modules". Open up the details + of the error, and click "Remove Selected", as these module `.iml` files are + safe to remove. -- cgit From 0fa9b69b6afe762e5aee7b7cf801a38ebe74b2c9 Mon Sep 17 00:00:00 2001 From: Tiem Song Date: Fri, 15 Feb 2019 05:26:22 -0800 Subject: Update pom file to use 'compile' instead of 'runtime' (#393) This addresses Gradle 5.0 compatibility and fixes https://github.com/Kotlin/dokka/issues/388 --- buildSrc/src/main/groovy/org/jetbrains/CorrectShadowPublishing.groovy | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/buildSrc/src/main/groovy/org/jetbrains/CorrectShadowPublishing.groovy b/buildSrc/src/main/groovy/org/jetbrains/CorrectShadowPublishing.groovy index 3e1d2106..58cfdcf7 100644 --- a/buildSrc/src/main/groovy/org/jetbrains/CorrectShadowPublishing.groovy +++ b/buildSrc/src/main/groovy/org/jetbrains/CorrectShadowPublishing.groovy @@ -35,5 +35,5 @@ private static void addDependency(Node dependenciesNode, dep) { dependencyNode.appendNode('groupId', dep.group) dependencyNode.appendNode('artifactId', dep.name) dependencyNode.appendNode('version', dep.version) - dependencyNode.appendNode('scope', 'runtime') -} \ No newline at end of file + dependencyNode.appendNode('scope', 'compile') +} -- cgit From 6a1a0fde56be22c565d10d71f37f84e8d78c212a Mon Sep 17 00:00:00 2001 From: Kamil Doległo Date: Tue, 19 Mar 2019 11:50:06 +0100 Subject: Update readme for 0.9.18 --- README.md | 24 ++++++++++++++++++++---- 1 file changed, 20 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 34b01f54..1d62a4ed 100644 --- a/README.md +++ b/README.md @@ -16,17 +16,32 @@ buildscript { repositories { jcenter() } - dependencies { classpath "org.jetbrains.dokka:dokka-gradle-plugin:${dokka_version}" } } +repositories { + jcenter() +} apply plugin: 'org.jetbrains.dokka' ``` +or using the new plugins block: + +```groovy +plugins { + id 'org.jetbrains.dokka' version '0.9.18' +} +repositories { + jcenter() +} +``` + The plugin adds a task named "dokka" to the project. +If you encounter any problems when migrating from older versions of Dokka, please see the [FAQ](https://github.com/Kotlin/dokka/wiki/faq). + Minimal dokka configuration: ```groovy @@ -180,7 +195,7 @@ dependencies { ``` #### FAQ -Please see the [FAQ](https://github.com/Kotlin/dokka/wiki/faq). +If you encounter any problems, please see the [FAQ](https://github.com/Kotlin/dokka/wiki/faq). #### Android @@ -192,12 +207,13 @@ buildscript { repositories { jcenter() } - dependencies { classpath "org.jetbrains.dokka:dokka-android-gradle-plugin:${dokka_version}" } } - +repositories { + jcenter() +} apply plugin: 'com.android.library' apply plugin: 'kotlin-android' apply plugin: 'org.jetbrains.dokka-android' -- cgit From 5bf49eeb8d12d526961325e17f0bd291cfa2c7ee Mon Sep 17 00:00:00 2001 From: Simon Ogorodnik Date: Wed, 20 Mar 2019 00:03:02 +0300 Subject: Update README.md Add another repository option for Dokka fatjar --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 1d62a4ed..e60e32d1 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,7 @@ buildscript { } } repositories { - jcenter() + jcenter() // or maven { url 'https://dl.bintray.com/kotlin/dokka' } } apply plugin: 'org.jetbrains.dokka' @@ -34,7 +34,7 @@ plugins { id 'org.jetbrains.dokka' version '0.9.18' } repositories { - jcenter() + jcenter() // or maven { url 'https://dl.bintray.com/kotlin/dokka' } } ``` -- cgit From 5b1bfb684dcca4b7ff05d3c3c431df62acf2d5c1 Mon Sep 17 00:00:00 2001 From: Stanislav Erokhin Date: Thu, 15 Aug 2019 13:07:52 +0300 Subject: Fix the copyright section --- LICENSE | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/LICENSE b/LICENSE index e06d2081..af02b243 100644 --- a/LICENSE +++ b/LICENSE @@ -186,7 +186,7 @@ Apache License same "printed page" as the copyright notice for easier identification within third-party archives. - Copyright {yyyy} {name of copyright owner} + Copyright 2014-2019 JetBrains s.r.o. and Dokka project contributors. Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. -- cgit