Skip to content
This repository has been archived by the owner on Dec 19, 2023. It is now read-only.

Migrate to Dokka 0.10.1 #385

Merged
merged 8 commits into from
Apr 14, 2020
Merged

Migrate to Dokka 0.10.1 #385

merged 8 commits into from
Apr 14, 2020

Conversation

fbenz
Copy link
Contributor

@fbenz fbenz commented Apr 12, 2020

Changes to the Dokka extension:

Example project:

  • There is no need for Java 11 dependencies or the Javadoc Doclet in the Gradle build file of the example project.
  • reportUndocumented = true is the annoying default and thus I changed it to false.
  • I have the checked the resulting documentation and there is no difference.

Copy link
Contributor

@jmisur jmisur left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

great improvement 👍
tested, output is 1-1

}
----

To speed the build up and avoid test issues, once can reduce the list ob subprojects in
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

of

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, by using a spell checker I found more :)

git checkout ${dokka.version}
----

Add the following snippted at the end of `core/build.gradle`:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

snippet

override val reportUndocumented: Boolean = false,
override val skipEmptyPackages: Boolean = false,
override val skipDeprecated: Boolean = false,
override val jdkVersion: Int = 6,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

6?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It does not matter for the test but I changed it to 8 to have it in line with what we actually use.

[source,bash]
----
mvn install:install-file -Dfile=lib/dokka-core-${dokka.version}-tests.jar
-DgroupId=org.jetbrains.dokka -DartifactId=dokka-core -Dversion=${dokka.version}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

missing \ for multiline command

@fbenz fbenz merged commit 094b282 into master Apr 14, 2020
@fbenz fbenz deleted the dokka-0.10.1 branch April 14, 2020 07:14
@fbenz fbenz mentioned this pull request Aug 9, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants