diff options
| -rw-r--r-- | README.md | 28 |
1 files changed, 25 insertions, 3 deletions
@@ -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 @@ -277,8 +277,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 --> @@ -486,3 +486,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. |