Skip to content

Commit

Permalink
Replace invalid documentation links (#2973)
Browse files Browse the repository at this point in the history
  • Loading branch information
strangesource committed Apr 25, 2023
1 parent fcb2f4a commit 79aaba0
Show file tree
Hide file tree
Showing 5 changed files with 5 additions and 5 deletions.
Expand Up @@ -31,7 +31,7 @@ private fun parseModuleAndPackageDocFragment(
"Package" -> Package
else -> throw IllegalStateException(
"""Unexpected classifier: "${classifierAndName[0]}", expected either "Module" or "Package".
|For more information consult the specification: https://kotlinlang.org/docs/reference/dokka-module-and-package-docs.html""".trimMargin()
|For more information consult the specification: https://kotlinlang.org/docs/dokka-module-and-package-docs.html""".trimMargin()
)
}

Expand Down
Expand Up @@ -75,7 +75,7 @@ class InvalidContentModuleAndPackageDocumentationReaderTest : AbstractContextMod
runCatching { readerA[dModule(name = "moduleA", sourceSets = setOf(sourceSetA))] }.exceptionOrNull()
assertEquals(
"Unexpected classifier: \"Invalid\", expected either \"Module\" or \"Package\". \n" +
"For more information consult the specification: https://kotlinlang.org/docs/reference/dokka-module-and-package-docs.html",
"For more information consult the specification: https://kotlinlang.org/docs/dokka-module-and-package-docs.html",
exception?.message
)
}
Expand Down
Expand Up @@ -69,7 +69,7 @@ open class GradleDokkaSourceSetBuilder(

/**
* List of Markdown files that contain
* [module and package documentation](https://kotlinlang.org/docs/reference/dokka-module-and-package-docs.html).
* [module and package documentation](https://kotlinlang.org/docs/dokka-module-and-package-docs.html).
*
* Contents of specified files will be parsed and embedded into documentation as module and package descriptions.
*
Expand Down
Expand Up @@ -24,7 +24,7 @@ abstract class DokkaMultiModuleTask : AbstractDokkaParentTask() {

/**
* List of Markdown files that contain
* [module and package documentation](https://kotlinlang.org/docs/reference/dokka-module-and-package-docs.html).
* [module and package documentation](https://kotlinlang.org/docs/dokka-module-and-package-docs.html).
*
* Contents of specified files will be parsed and embedded into documentation as module and package descriptions.
*
Expand Down
2 changes: 1 addition & 1 deletion runners/maven-plugin/src/main/kotlin/DokkaMojo.kt
Expand Up @@ -66,7 +66,7 @@ abstract class AbstractDokkaMojo(private val defaultDokkaPlugins: List<Dependenc

/**
* List of Markdown files that contain
* [module and package documentation](https://kotlinlang.org/docs/reference/dokka-module-and-package-docs.html).
* [module and package documentation](https://kotlinlang.org/docs/dokka-module-and-package-docs.html).
*
* Contents of specified files will be parsed and embedded into documentation as module and package descriptions.
*
Expand Down

0 comments on commit 79aaba0

Please sign in to comment.