From 5e91a085f0bc508e5a9d5f29f27bb2ced8f4e3f1 Mon Sep 17 00:00:00 2001 From: Kamil Doległo Date: Mon, 23 Sep 2019 10:26:51 +0200 Subject: Readme update for the androidVariant --- README.md | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 43e5ac9d..ccf92094 100644 --- a/README.md +++ b/README.md @@ -376,8 +376,15 @@ apply plugin: 'org.jetbrains.dokka' ``` There is also a `noAndroidSdkLink` configuration parameter that works similar to `noJdkLink` and `noStdlibLink` -By default the variant documented by dokka is the first release variant encountered. If you want to change that, -you can disable the autoconfiguration and configure dokka manually. +By default the variant documented by dokka is the first release variant encountered. +You can override that by setting the `androidVariant` property inside the `configuration` (or specific platform) block: +```groovy +dokka { + configuration { + androidVariant = "debug" + } +} +``` ### Using the Maven plugin -- cgit From 59c3f5fb48ce65e85d72deddebf57b9775317b79 Mon Sep 17 00:00:00 2001 From: unly Date: Tue, 3 Dec 2019 09:44:51 +0100 Subject: fix the link to the dokka fat jar --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index ccf92094..1408ca53 100644 --- a/README.md +++ b/README.md @@ -586,7 +586,7 @@ Inside the `dokka` tag you can create another tags named `` that su ### Using the Command Line -To run Dokka from the command line, download the [Dokka jar](https://github.com/Kotlin/dokka/releases/download/0.10.0/dokka-fatjar.jar). +To run Dokka from the command line, download the [Dokka jar](https://github.com/Kotlin/dokka/releases/download/0.10.0/dokka-fatjar-0.10.0.jar). To generate documentation, run the following command: java -jar dokka-fatjar.jar -- cgit From 10f5f9ee902381315e4032571db0cbe896141fc2 Mon Sep 17 00:00:00 2001 From: Kamil Doległo Date: Wed, 18 Dec 2019 12:55:15 +0100 Subject: Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 1408ca53..45f3b4b5 100644 --- a/README.md +++ b/README.md @@ -377,11 +377,11 @@ apply plugin: 'org.jetbrains.dokka' There is also a `noAndroidSdkLink` configuration parameter that works similar to `noJdkLink` and `noStdlibLink` By default the variant documented by dokka is the first release variant encountered. -You can override that by setting the `androidVariant` property inside the `configuration` (or specific platform) block: +You can override that by setting the `androidVariants` property inside the `configuration` (or specific platform) block: ```groovy dokka { configuration { - androidVariant = "debug" + androidVariants = ["debug", "release"] } } ``` -- cgit From 56a48495210732fc08f67bc70b9d33946775168b Mon Sep 17 00:00:00 2001 From: Martin Bonnin Date: Mon, 27 Jan 2020 15:27:07 +0100 Subject: Add a CONTRIBUTING.md --- CONTRIBUTING.md | 35 +++++++++++++++++++++++++++++++++++ README.md | 26 -------------------------- 2 files changed, 35 insertions(+), 26 deletions(-) create mode 100644 CONTRIBUTING.md (limited to 'README.md') diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..3e81c6d4 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,35 @@ +## Branches + +As of late January 2020: + +* master is the latest released version (0.10.0). +* dev-0.10.1 is the maintenance branch for 0.10.0. It will contain mostly bugfixes. +* dev-0.11.0 is a big rewrite of dokka, it's changing fast and things may break but this is where new features should be developed. + +## Building dokka + +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. + diff --git a/README.md b/README.md index 45f3b4b5..063791de 100644 --- a/README.md +++ b/README.md @@ -641,29 +641,3 @@ doesn't affect analysis of source code, it just changes the result. You can thin * `native` * `common` -## Building dokka - -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 465ea3d23be40d0d21df7f7cab51ec2d42e3237f Mon Sep 17 00:00:00 2001 From: Kamil Doległo Date: Mon, 10 Feb 2020 14:51:14 +0100 Subject: Update README.md for 0.10.1 --- README.md | 11 ++++------- 1 file changed, 4 insertions(+), 7 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 063791de..c6fe7011 100644 --- a/README.md +++ b/README.md @@ -29,7 +29,7 @@ or using the plugins block: ```groovy plugins { - id 'org.jetbrains.dokka' version '0.10.0' + id 'org.jetbrains.dokka' version '0.10.1' } repositories { jcenter() // or maven { url 'https://dl.bintray.com/kotlin/dokka' } @@ -106,9 +106,6 @@ dokka { // Property used for manual addition of files to the classpath // This property does not override the classpath collected automatically but appends to it classpath = [new File("$buildDir/other.jar")] - - // By default, sourceRoots are taken from Kotlin Plugin, subProjects and kotlinTasks, following roots will be appended to them - sourceRoots = [files('src/main/kotlin')] // List of files with module and package documentation // https://kotlinlang.org/docs/reference/kotlin-doc.html#module-and-package-documentation @@ -316,7 +313,7 @@ repositories { } dependencies { - dokkaRuntime "org.jetbrains.dokka:dokka-fatjar:0.10.0" + dokkaRuntime "org.jetbrains.dokka:dokka-fatjar:0.10.1" } dokka { @@ -339,7 +336,7 @@ To use your Fat Jar, just set the path to it: } dependencies { - dokkaRuntime files("/path/to/fatjar/dokka-fatjar-0.10.0.jar") + dokkaRuntime files("/path/to/fatjar/dokka-fatjar-0.10.1.jar") } dokka { @@ -586,7 +583,7 @@ Inside the `dokka` tag you can create another tags named `` that su ### Using the Command Line -To run Dokka from the command line, download the [Dokka jar](https://github.com/Kotlin/dokka/releases/download/0.10.0/dokka-fatjar-0.10.0.jar). +To run Dokka from the command line, download the [Dokka jar](https://github.com/Kotlin/dokka/releases/download/0.10.1/dokka-fatjar-0.10.1.jar). To generate documentation, run the following command: java -jar dokka-fatjar.jar -- cgit