Skip to content

Commit

Permalink
Merge dev-0.10.1 into master
Browse files Browse the repository at this point in the history
  • Loading branch information
kamildoleglo committed Feb 10, 2020
2 parents 23fbfa0 + 465ea3d commit 0d0d41f
Show file tree
Hide file tree
Showing 30 changed files with 638 additions and 533 deletions.
1 change: 1 addition & 0 deletions .idea/codeStyles/codeStyleConfig.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 0 additions & 8 deletions .idea/compiler.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

80 changes: 80 additions & 0 deletions .idea/jarRepositories.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 6 additions & 0 deletions .idea/kotlinScripting.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

35 changes: 35 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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.

48 changes: 13 additions & 35 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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' }
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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 {
Expand All @@ -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 {
Expand Down Expand Up @@ -376,8 +373,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 `androidVariants` property inside the `configuration` (or specific platform) block:
```groovy
dokka {
configuration {
androidVariants = ["debug", "release"]
}
}
```

### Using the Maven plugin

Expand Down Expand Up @@ -579,7 +583,7 @@ Inside the `dokka` tag you can create another tags named `<passconfig/>` 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 <arguments>
Expand Down Expand Up @@ -634,29 +638,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.
24 changes: 5 additions & 19 deletions build.gradle
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
import org.jetbrains.DependenciesVersionGetter

allprojects {
ext {
if (!project.findProperty("dokka_version")) {
Expand Down Expand Up @@ -41,6 +39,8 @@ allprojects {
jcenter()
mavenCentral()
mavenLocal()
maven { url 'https://kotlin.bintray.com/kotlin-plugin' }
maven { url 'https://www.jetbrains.com/intellij-repository/releases' }
maven { url "https://dl.bintray.com/jetbrains/markdown" }
maven { url "https://dl.bintray.com/kotlin/kotlin-eap" }
maven { url "https://dl.bintray.com/kotlin/kotlin-dev" }
Expand Down Expand Up @@ -78,24 +78,21 @@ def bintrayPublication(project, List<String> _publications) {
})
}

def versions = DependenciesVersionGetter.getVersions(project, bundled_kotlin_compiler_version)

ext.ideaVersion = versions["idea.build.id"]
ext.markdownVersion = versions["markdown.build.id"].replace("%20", " ")

configurations {
ideaIC
intellijCore
}

repositories {
maven { url 'https://kotlin.bintray.com/kotlin-plugin' }
maven { url 'https://www.jetbrains.com/intellij-repository/snapshots' }
maven { url 'https://www.jetbrains.com/intellij-repository/releases' }
}

dependencies {
intellijCore "com.jetbrains.intellij.idea:intellij-core:$ideaVersion"
ideaIC "com.jetbrains.intellij.idea:ideaIC:$ideaVersion"
intellijCore "com.jetbrains.intellij.idea:intellij-core:$idea_version"
ideaIC "com.jetbrains.intellij.idea:ideaIC:$idea_version"
}

def intellijCoreAnalysis() {
Expand All @@ -116,17 +113,6 @@ configurations {
kotlin_plugin_full
}

dependencies {
final String ijVersion = "20" + ideaVersion.take(2) + "." + ideaVersion[2]
kotlin_plugin_full "teamcity:kotlin-plugin-$bundled_kotlin_compiler_version-IJ$ijVersion-1:$bundled_kotlin_compiler_version@zip"
}

def kotlinPluginDependency() {
return zipTree(configurations.kotlin_plugin_full.singleFile).matching({
include("Kotlin/lib/kotlin-plugin.jar")
})
}


allprojects {

Expand Down
7 changes: 3 additions & 4 deletions core/build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -28,12 +28,11 @@ dependencies {
compile "org.jetbrains.kotlin:kotlin-compiler:$bundled_kotlin_compiler_version"
compile "org.jetbrains.kotlin:kotlin-script-runtime:$bundled_kotlin_compiler_version"

compile "teamcity:kotlin-ide-common:$bundled_kotlin_compiler_version"
compile "org.jetbrains:markdown:$markdownVersion"
compile "org.jetbrains:markdown:0.1.41"

compile intellijCoreAnalysis()
compile kotlinPluginDependency()

compile "org.jetbrains.kotlin:kotlin-plugin-ij193:$kotlin_plugin_version" //TODO: parametrize ij version after 1.3.70

compile 'org.jetbrains.kotlinx:kotlinx-html-jvm:0.6.8'

Expand Down
Loading

0 comments on commit 0d0d41f

Please sign in to comment.