diff options
author | Simon Ogorodnik <Simon.Ogorodnik@jetbrains.com> | 2019-09-30 18:55:29 +0300 |
---|---|---|
committer | Simon Ogorodnik <Simon.Ogorodnik@jetbrains.com> | 2019-09-30 18:55:29 +0300 |
commit | 3faee19a6b547837f49fbc6794965767cf8caf6d (patch) | |
tree | 119dfab8d77b4b0eb6e40cab7669495a8a1e5471 | |
parent | ab3a0654364534cf2c8cad86756450e908faa358 (diff) | |
parent | 5b1bfb684dcca4b7ff05d3c3c431df62acf2d5c1 (diff) | |
download | dokka-3faee19a6b547837f49fbc6794965767cf8caf6d.tar.gz dokka-3faee19a6b547837f49fbc6794965767cf8caf6d.tar.bz2 dokka-3faee19a6b547837f49fbc6794965767cf8caf6d.zip |
Merge remote-tracking branch 'origin/master' into tmp--release--0.10.0
-rw-r--r-- | LICENSE | 2 | ||||
-rw-r--r-- | README.md | 26 | ||||
-rw-r--r-- | buildSrc/src/main/groovy/org/jetbrains/CorrectShadowPublishing.groovy | 4 | ||||
-rw-r--r-- | core/src/main/kotlin/Model/PackageDocs.kt | 3 |
4 files changed, 29 insertions, 6 deletions
@@ -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. @@ -455,8 +455,8 @@ The available configuration options are shown below: <!-- List of '.md' files with package and module docs --> <!-- https://kotlinlang.org/docs/reference/kotlin-doc.html#module-and-package-documentation --> <includes> - <file>packages.md</file> - <file>extra.md</file> + <include>packages.md</include> + <include>extra.md</include> </includes> <!-- List of sample roots --> @@ -638,3 +638,25 @@ doesn't affect analysis of source code, it just changes the result. You can thin 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/buildSrc/src/main/groovy/org/jetbrains/CorrectShadowPublishing.groovy b/buildSrc/src/main/groovy/org/jetbrains/CorrectShadowPublishing.groovy index 4f6dcd75..62cc3d3c 100644 --- a/buildSrc/src/main/groovy/org/jetbrains/CorrectShadowPublishing.groovy +++ b/buildSrc/src/main/groovy/org/jetbrains/CorrectShadowPublishing.groovy @@ -36,5 +36,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') +} diff --git a/core/src/main/kotlin/Model/PackageDocs.kt b/core/src/main/kotlin/Model/PackageDocs.kt index cf6cd808..b24efc5d 100644 --- a/core/src/main/kotlin/Model/PackageDocs.kt +++ b/core/src/main/kotlin/Model/PackageDocs.kt @@ -7,6 +7,7 @@ import com.intellij.psi.PsiClass import com.intellij.psi.PsiFileFactory import com.intellij.psi.util.PsiTreeUtil import com.intellij.util.LocalTimeCounter +import com.intellij.openapi.util.text.StringUtil import org.intellij.markdown.MarkdownElementTypes import org.intellij.markdown.MarkdownTokenTypes import org.intellij.markdown.parser.LinkMap @@ -30,7 +31,7 @@ class PackageDocs fun parse(fileName: String, linkResolveContext: List<PackageFragmentDescriptor>) { val file = File(fileName) if (file.exists()) { - val text = file.readText() + val text = StringUtil.convertLineSeparators(file.readText()) val tree = parseMarkdown(text) val linkMap = LinkMap.buildLinkMap(tree.node, text) var targetContent: MutableContent = moduleContent |