Skip to content

Commit

Permalink
Add some documentation for configuration integration tests
Browse files Browse the repository at this point in the history
  • Loading branch information
IgnatBeresnev committed Apr 18, 2023
1 parent 8f6d062 commit f17b73d
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 0 deletions.
5 changes: 5 additions & 0 deletions integration-tests/gradle/projects/it-configuration/README.md
@@ -0,0 +1,5 @@
# it-configuration

This is an integration test project for checking Dokka's configuration options.

Please see the KDoc for the integration test itself.
Expand Up @@ -7,6 +7,18 @@ import org.junit.runners.Parameterized.Parameters
import java.io.File
import kotlin.test.*

/**
* Tests for Dokka's configuration options of the Gradle runner.
*
* Options can be checked to work in combination with each other:
* for instance, you can check that `reportUndocumented` and `failOnWarning`
* work in synergy when both set to true.
*
* Configuration options can be passed as project properties using Gradle CLI arguments.
* For example, passing `-Pname=value` to Gradle will create a project-wide property with
* key `name` and value `value`, which you can use to set the corresponding option's value
* using Dokka's configuration DSL.
*/
class ConfigurationTest(override val versions: BuildVersions) : AbstractGradleIntegrationTest() {

companion object {
Expand Down

0 comments on commit f17b73d

Please sign in to comment.