aboutsummaryrefslogtreecommitdiff
path: root/plugins
diff options
context:
space:
mode:
authorSarah Haggarty <81160244+sarahhaggarty@users.noreply.github.com>2023-01-19 17:34:28 +0100
committerGitHub <noreply@github.com>2023-01-19 17:34:28 +0100
commit1dcb0f88bbe78a10c2de8b97ebf797e7af8b90e0 (patch)
treefad47efeadff4375d64f79eac36482d262b19287 /plugins
parent4121336ce35ae2502ace12b5b7469fd3dbc5a4ad (diff)
downloaddokka-1dcb0f88bbe78a10c2de8b97ebf797e7af8b90e0.tar.gz
dokka-1dcb0f88bbe78a10c2de8b97ebf797e7af8b90e0.tar.bz2
dokka-1dcb0f88bbe78a10c2de8b97ebf797e7af8b90e0.zip
Add module and package documentation content (#2819)
Co-authored-by: Sarah Haggarty <sarahhaggarty@users.noreply.github.com>
Diffstat (limited to 'plugins')
-rw-r--r--plugins/base/src/main/kotlin/parsers/moduleAndPackage/parseModuleAndPackageDocumentationFragments.kt2
-rw-r--r--plugins/base/src/test/kotlin/transformers/InvalidContentModuleAndPackageDocumentationReaderTest.kt2
2 files changed, 2 insertions, 2 deletions
diff --git a/plugins/base/src/main/kotlin/parsers/moduleAndPackage/parseModuleAndPackageDocumentationFragments.kt b/plugins/base/src/main/kotlin/parsers/moduleAndPackage/parseModuleAndPackageDocumentationFragments.kt
index a21a5acb..edfc04a5 100644
--- a/plugins/base/src/main/kotlin/parsers/moduleAndPackage/parseModuleAndPackageDocumentationFragments.kt
+++ b/plugins/base/src/main/kotlin/parsers/moduleAndPackage/parseModuleAndPackageDocumentationFragments.kt
@@ -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/kotlin-doc.html#module-and-package-documentation""".trimMargin()
+ |For more information consult the specification: https://kotlinlang.org/docs/reference/dokka-module-and-package-docs.html""".trimMargin()
)
}
diff --git a/plugins/base/src/test/kotlin/transformers/InvalidContentModuleAndPackageDocumentationReaderTest.kt b/plugins/base/src/test/kotlin/transformers/InvalidContentModuleAndPackageDocumentationReaderTest.kt
index 6a1f5f11..3c2151d8 100644
--- a/plugins/base/src/test/kotlin/transformers/InvalidContentModuleAndPackageDocumentationReaderTest.kt
+++ b/plugins/base/src/test/kotlin/transformers/InvalidContentModuleAndPackageDocumentationReaderTest.kt
@@ -74,7 +74,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/kotlin-doc.html#module-and-package-documentation",
+ "For more information consult the specification: https://kotlinlang.org/docs/reference/dokka-module-and-package-docs.html",
exception?.message
)
}