From c9ed18389190fc8452972ec6fff6c84d2e484d05 Mon Sep 17 00:00:00 2001 From: Daniel Chao Date: Tue, 26 Mar 2024 07:48:55 -0700 Subject: [PATCH] Fix source links in pkldoc (#362) Fixes an issue where source links are incorrectly URI encoded; i.e. `https%3A//github.com` instead of `https://github.com`. This was causing the browser to resolve these as relative to the enclosing page. --- .../main/kotlin/org/pkl/doc/DocGenerator.kt | 2 +- .../main/kotlin/org/pkl/doc/DocPackageInfo.kt | 12 ++++-------- .../src/main/kotlin/org/pkl/doc/DocScope.kt | 9 +++++---- .../main/kotlin/org/pkl/doc/PageGenerator.kt | 7 ++++--- pkl-doc/src/main/kotlin/org/pkl/doc/Util.kt | 18 ++++++++++++++---- .../1.2.3/Module Containing Spaces/index.html | 2 +- .../com.package1/1.2.3/baseModule/index.html | 2 +- .../1.2.3/classAnnotations/index.html | 2 +- .../1.2.3/classComments/index.html | 2 +- .../1.2.3/classInheritance/index.html | 2 +- .../1.2.3/classMethodComments/index.html | 2 +- .../1.2.3/classMethodModifiers/index.html | 2 +- .../classMethodTypeAnnotations/index.html | 2 +- .../1.2.3/classMethodTypeReferences/index.html | 2 +- .../1.2.3/classPropertyAnnotations/index.html | 2 +- .../1.2.3/classPropertyComments/index.html | 2 +- .../1.2.3/classPropertyModifiers/index.html | 2 +- .../classPropertyTypeAnnotations/index.html | 2 +- .../classPropertyTypeReferences/index.html | 2 +- .../1.2.3/classTypeConstraints/index.html | 2 +- .../1.2.3/docExampleSubject1/index.html | 2 +- .../1.2.3/docExampleSubject2/index.html | 2 +- .../com.package1/1.2.3/docLinks/index.html | 2 +- .../1.2.3/methodAnnotations/index.html | 2 +- .../1.2.3/moduleComments/index.html | 2 +- .../com.package1/1.2.3/moduleExtend/index.html | 2 +- .../1.2.3/moduleInfoAnnotation/index.html | 2 +- .../moduleMethodCommentInheritance/index.html | 2 +- .../1.2.3/moduleMethodComments/index.html | 2 +- .../1.2.3/moduleMethodModifiers/index.html | 2 +- .../moduleMethodTypeAnnotations/index.html | 2 +- .../moduleMethodTypeReferences/index.html | 2 +- .../1.2.3/modulePropertyAnnotations/index.html | 2 +- .../index.html | 2 +- .../1.2.3/modulePropertyComments/index.html | 2 +- .../1.2.3/modulePropertyModifiers/index.html | 2 +- .../modulePropertyTypeAnnotations/index.html | 2 +- .../modulePropertyTypeReferences/index.html | 2 +- .../com.package1/1.2.3/moduleTypes1/index.html | 2 +- .../com.package1/1.2.3/moduleTypes2/index.html | 2 +- .../nested/nested2/nestedModule/index.html | 2 +- .../com.package1/1.2.3/shared/index.html | 2 +- .../1.2.3/ternalPackage/index.html | 2 +- .../1.2.3/typeAliasInheritance/index.html | 2 +- .../com.package1/1.2.3/typealiases/index.html | 2 +- .../com.package1/1.2.3/typealiases2/index.html | 2 +- .../com.package1/1.2.3/unionTypes/index.html | 2 +- .../1.2.3/unlistedClass/index.html | 2 +- .../1.2.3/unlistedMethod/index.html | 2 +- .../1.2.3/unlistedProperty/index.html | 2 +- .../com.package2/4.5.6/Module3/index.html | 2 +- .../localhost:0/birds/0.5.0/Bird/index.html | 2 +- .../birds/0.5.0/allFruit/index.html | 2 +- .../localhost:0/birds/0.5.0/catalog/index.html | 2 +- 54 files changed, 77 insertions(+), 69 deletions(-) diff --git a/pkl-doc/src/main/kotlin/org/pkl/doc/DocGenerator.kt b/pkl-doc/src/main/kotlin/org/pkl/doc/DocGenerator.kt index 09523291..675727e6 100644 --- a/pkl-doc/src/main/kotlin/org/pkl/doc/DocGenerator.kt +++ b/pkl-doc/src/main/kotlin/org/pkl/doc/DocGenerator.kt @@ -179,7 +179,7 @@ internal class DocPackage(val docPackageInfo: DocPackageInfo, val modules: List< mod, docPackageInfo.version, docPackageInfo.getModuleImportUri(mod.moduleName), - docPackageInfo.getModuleSourceCode(mod.moduleName)?.toEncodedUri(), + docPackageInfo.getModuleSourceCode(mod.moduleName), exampleModulesBySubject[mod.moduleName] ?: listOf() ) } diff --git a/pkl-doc/src/main/kotlin/org/pkl/doc/DocPackageInfo.kt b/pkl-doc/src/main/kotlin/org/pkl/doc/DocPackageInfo.kt index 33d843fe..785ee2d1 100644 --- a/pkl-doc/src/main/kotlin/org/pkl/doc/DocPackageInfo.kt +++ b/pkl-doc/src/main/kotlin/org/pkl/doc/DocPackageInfo.kt @@ -160,19 +160,15 @@ data class DocPackageInfo( when (importUri) { "pkl:/" -> "pkl:${moduleName.substring(4)}".toUri() else -> { - val path = - getModulePath(moduleName, moduleNamePrefix) - .split("/") - .map { it.uriEncoded } - .joinToString("/") { it } + ".pkl" + val path = getModulePath(moduleName, moduleNamePrefix).uriEncoded + ".pkl" URI(importUri).resolve(path) } } - internal fun getModuleSourceCode(moduleName: String): String? { - val path = "/" + getModulePath(moduleName, moduleNamePrefix) + ".pkl" + internal fun getModuleSourceCode(moduleName: String): URI? { + val path = "/" + getModulePath(moduleName, moduleNamePrefix).uriEncoded + ".pkl" // assumption: the fragment is only used for line numbers - return sourceCodeUrlScheme?.replace("%{path}", path)?.substringBefore('#') + return sourceCodeUrlScheme?.replace("%{path}", path)?.substringBefore('#')?.let(URI::create) } /** Information about a depended-on package. */ diff --git a/pkl-doc/src/main/kotlin/org/pkl/doc/DocScope.kt b/pkl-doc/src/main/kotlin/org/pkl/doc/DocScope.kt index 80156cfe..ed799cae 100644 --- a/pkl-doc/src/main/kotlin/org/pkl/doc/DocScope.kt +++ b/pkl-doc/src/main/kotlin/org/pkl/doc/DocScope.kt @@ -253,7 +253,7 @@ internal class PackageScope( private val moduleScopes: Map by lazy { modules.associate { module -> val docUrl = - url.resolve(getModulePath(module.moduleName, modulePrefix).uriEncodedPath + "/index.html") + url.resolve(getModulePath(module.moduleName, modulePrefix).uriEncoded + "/index.html") module.moduleName to ModuleScope(module, docUrl, this) } } @@ -326,7 +326,7 @@ internal class ModuleScope( get() = module.moduleName val path: String by lazy { - getModulePath(module.moduleName, parent!!.docPackageInfo.moduleNamePrefix).uriEncodedPath + getModulePath(module.moduleName, parent!!.docPackageInfo.moduleNamePrefix).uriEncoded } override val dataUrl: URI by lazy { parent!!.dataUrl.resolve("./$path/index.js") } @@ -386,11 +386,12 @@ internal class ClassScope( ) : PageScope() { override val url: URI by lazy { // `isModuleClass` distinction is relevant when this scope is a link target - if (clazz.isModuleClass) parentUrl else parentUrl.resolve("${clazz.simpleName.uriEncoded}.html") + if (clazz.isModuleClass) parentUrl + else parentUrl.resolve("${clazz.simpleName.uriEncodedComponent}.html") } override val dataUrl: URI by lazy { - parent!!.dataUrl.resolve("${clazz.simpleName.uriEncoded}.js") + parent!!.dataUrl.resolve("${clazz.simpleName.uriEncodedComponent}.js") } override fun getMethod(name: String): MethodScope? = diff --git a/pkl-doc/src/main/kotlin/org/pkl/doc/PageGenerator.kt b/pkl-doc/src/main/kotlin/org/pkl/doc/PageGenerator.kt index 7aaf8480..15b0d578 100644 --- a/pkl-doc/src/main/kotlin/org/pkl/doc/PageGenerator.kt +++ b/pkl-doc/src/main/kotlin/org/pkl/doc/PageGenerator.kt @@ -426,7 +426,7 @@ internal abstract class PageGenerator( // anchors, and requires no JS protected fun HtmlBlockTag.renderAnchor(anchorId: String, cssClass: String = "anchor") { div { - id = anchorId.uriEncoded + id = anchorId.uriEncodedComponent classes = setOf(cssClass) +" " // needs some content to be considered a valid anchor by browsers } @@ -457,7 +457,7 @@ internal abstract class PageGenerator( protected fun HtmlBlockTag.renderSelfLink(memberName: String) { a { classes = setOf("member-selflink", "material-icons") - href = "#${memberName.uriEncoded}" + href = "#${memberName.uriEncodedComponent}" +"link" } } @@ -600,7 +600,8 @@ internal abstract class PageGenerator( for (example in examples) { if (first) first = false else +", " a { - href = docModule.parent.docPackageInfo.getModuleSourceCode(example.moduleName)!! + href = + docModule.parent.docPackageInfo.getModuleSourceCode(example.moduleName)!!.toString() +example.shortModuleName } } diff --git a/pkl-doc/src/main/kotlin/org/pkl/doc/Util.kt b/pkl-doc/src/main/kotlin/org/pkl/doc/Util.kt index f85e204d..2064f4bc 100644 --- a/pkl-doc/src/main/kotlin/org/pkl/doc/Util.kt +++ b/pkl-doc/src/main/kotlin/org/pkl/doc/Util.kt @@ -119,7 +119,12 @@ internal fun String.replaceSourceCodePlaceholders( .replace("%{endLine}", sourceLocation.endLine.toString()) } -internal val String.uriEncoded +/** + * Encodes a URI string, encoding characters that are part of URI syntax. + * + * Follows `encodeURIComponent` from ECMAScript. + */ +internal val String.uriEncodedComponent get(): String { val ret = URLEncoder.encode(this, StandardCharsets.UTF_8) // Replace `+` with `%20` to be safe @@ -128,13 +133,18 @@ internal val String.uriEncoded return ret.replace("+", "%20") } -internal val String.uriEncodedPath - get(): String = split("/").map { it.uriEncoded }.joinToString("/") { it } +/** + * Encodes a URI string, preserving characters that are part of URI syntax. + * + * Follows `encodeURI` from ECMAScript. + */ +internal val String.uriEncoded + get(): String = replace(Regex("([^;/?:@&=+\$,#]+)")) { it.value.uriEncodedComponent } fun getModulePath(moduleName: String, packagePrefix: String): String = moduleName.substring(packagePrefix.length).replace('.', '/') -internal fun String.toEncodedUri(): URI = URI(uriEncodedPath) +internal fun String.toEncodedUri(): URI = URI(uriEncoded) /** * Turns `"foo.bar.baz-biz"` into ``"foo.bar.`baz-biz`"``. diff --git a/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/Module Containing Spaces/index.html b/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/Module Containing Spaces/index.html index ea719b6f..5ca600da 100644 --- a/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/Module Containing Spaces/index.html +++ b/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/Module Containing Spaces/index.html @@ -31,7 +31,7 @@
Module URI:
https://example.com/Module%20Containing%20Spaces.pklcontent_copy
Source code:
-
Module Containing Spaces.pkl
+
Module Containing Spaces.pkl
diff --git a/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/baseModule/index.html b/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/baseModule/index.html index dc5bd295..fb26cd7e 100644 --- a/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/baseModule/index.html +++ b/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/baseModule/index.html @@ -31,7 +31,7 @@
Module URI:
https://example.com/baseModule.pklcontent_copy
Source code:
-
baseModule.pkl
+
baseModule.pkl
diff --git a/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/classAnnotations/index.html b/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/classAnnotations/index.html index 21c3b477..73faa2b0 100644 --- a/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/classAnnotations/index.html +++ b/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/classAnnotations/index.html @@ -31,7 +31,7 @@
Module URI:
https://example.com/classAnnotations.pklcontent_copy
Source code:
-
classAnnotations.pkl
+
classAnnotations.pkl
diff --git a/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/classComments/index.html b/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/classComments/index.html index 547c7376..bbbae048 100644 --- a/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/classComments/index.html +++ b/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/classComments/index.html @@ -33,7 +33,7 @@
Module URI:
https://example.com/classComments.pklcontent_copy
Source code:
-
classComments.pkl
+
classComments.pkl
diff --git a/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/classInheritance/index.html b/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/classInheritance/index.html index 6514225d..f8d4d184 100644 --- a/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/classInheritance/index.html +++ b/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/classInheritance/index.html @@ -32,7 +32,7 @@
Module URI:
https://example.com/classInheritance.pklcontent_copy
Source code:
-
classInheritance.pkl
+
classInheritance.pkl
diff --git a/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/classMethodComments/index.html b/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/classMethodComments/index.html index f731c882..69d28e0b 100644 --- a/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/classMethodComments/index.html +++ b/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/classMethodComments/index.html @@ -32,7 +32,7 @@
Module URI:
https://example.com/classMethodComments.pklcontent_copy
Source code:
-
classMethodComments.pkl
+
classMethodComments.pkl
diff --git a/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/classMethodModifiers/index.html b/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/classMethodModifiers/index.html index 5218b8ad..a5227cd9 100644 --- a/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/classMethodModifiers/index.html +++ b/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/classMethodModifiers/index.html @@ -32,7 +32,7 @@
Module URI:
https://example.com/classMethodModifiers.pklcontent_copy
Source code:
-
classMethodModifiers.pkl
+
classMethodModifiers.pkl
diff --git a/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/classMethodTypeAnnotations/index.html b/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/classMethodTypeAnnotations/index.html index 2070d95b..d6177348 100644 --- a/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/classMethodTypeAnnotations/index.html +++ b/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/classMethodTypeAnnotations/index.html @@ -32,7 +32,7 @@
Module URI:
https://example.com/classMethodTypeAnnotations.pklcontent_copy
Source code:
-
classMethodTypeAnnotations.pkl
+
classMethodTypeAnnotations.pkl
diff --git a/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/classMethodTypeReferences/index.html b/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/classMethodTypeReferences/index.html index 43a516fe..5a9144de 100644 --- a/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/classMethodTypeReferences/index.html +++ b/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/classMethodTypeReferences/index.html @@ -33,7 +33,7 @@ the same module, a different module, and external modules.

Module URI:
https://example.com/classMethodTypeReferences.pklcontent_copy
Source code:
-
classMethodTypeReferences.pkl
+
classMethodTypeReferences.pkl
diff --git a/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/classPropertyAnnotations/index.html b/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/classPropertyAnnotations/index.html index 15001004..662ac6c6 100644 --- a/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/classPropertyAnnotations/index.html +++ b/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/classPropertyAnnotations/index.html @@ -31,7 +31,7 @@
Module URI:
https://example.com/classPropertyAnnotations.pklcontent_copy
Source code:
-
classPropertyAnnotations.pkl
+
classPropertyAnnotations.pkl
diff --git a/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/classPropertyComments/index.html b/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/classPropertyComments/index.html index d08ec569..2b37fc22 100644 --- a/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/classPropertyComments/index.html +++ b/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/classPropertyComments/index.html @@ -32,7 +32,7 @@
Module URI:
https://example.com/classPropertyComments.pklcontent_copy
Source code:
-
classPropertyComments.pkl
+
classPropertyComments.pkl
diff --git a/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/classPropertyModifiers/index.html b/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/classPropertyModifiers/index.html index 246a600f..0f3b248c 100644 --- a/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/classPropertyModifiers/index.html +++ b/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/classPropertyModifiers/index.html @@ -32,7 +32,7 @@
Module URI:
https://example.com/classPropertyModifiers.pklcontent_copy
Source code:
-
classPropertyModifiers.pkl
+
classPropertyModifiers.pkl
diff --git a/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/classPropertyTypeAnnotations/index.html b/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/classPropertyTypeAnnotations/index.html index b248d942..62e1e9ae 100644 --- a/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/classPropertyTypeAnnotations/index.html +++ b/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/classPropertyTypeAnnotations/index.html @@ -32,7 +32,7 @@
Module URI:
https://example.com/classPropertyTypeAnnotations.pklcontent_copy
Source code:
-
classPropertyTypeAnnotations.pkl
+
classPropertyTypeAnnotations.pkl
diff --git a/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/classPropertyTypeReferences/index.html b/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/classPropertyTypeReferences/index.html index ae18771c..17d98196 100644 --- a/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/classPropertyTypeReferences/index.html +++ b/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/classPropertyTypeReferences/index.html @@ -33,7 +33,7 @@ the same module, a different module, and external modules.

Module URI:
https://example.com/classPropertyTypeReferences.pklcontent_copy
Source code:
-
classPropertyTypeReferences.pkl
+
classPropertyTypeReferences.pkl
diff --git a/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/classTypeConstraints/index.html b/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/classTypeConstraints/index.html index 4c71a5ab..e2d03ef2 100644 --- a/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/classTypeConstraints/index.html +++ b/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/classTypeConstraints/index.html @@ -31,7 +31,7 @@
Module URI:
https://example.com/classTypeConstraints.pklcontent_copy
Source code:
-
classTypeConstraints.pkl
+
classTypeConstraints.pkl
diff --git a/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/docExampleSubject1/index.html b/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/docExampleSubject1/index.html index f57cb48c..f8f2f62a 100644 --- a/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/docExampleSubject1/index.html +++ b/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/docExampleSubject1/index.html @@ -30,7 +30,7 @@
Module URI:
https://example.com/docExampleSubject1.pklcontent_copy
Source code:
-
docExampleSubject1.pkl
+
docExampleSubject1.pkl
Examples:
docExample, docExample2
diff --git a/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/docExampleSubject2/index.html b/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/docExampleSubject2/index.html index c9a0efa3..7cd0bf26 100644 --- a/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/docExampleSubject2/index.html +++ b/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/docExampleSubject2/index.html @@ -30,7 +30,7 @@
Module URI:
https://example.com/docExampleSubject2.pklcontent_copy
Source code:
-
docExampleSubject2.pkl
+
docExampleSubject2.pkl
Examples:
docExample
diff --git a/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/docLinks/index.html b/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/docLinks/index.html index dde17ca1..f7086a60 100644 --- a/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/docLinks/index.html +++ b/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/docLinks/index.html @@ -41,7 +41,7 @@
Module URI:
https://example.com/docLinks.pklcontent_copy
Source code:
-
docLinks.pkl
+
docLinks.pkl
diff --git a/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/methodAnnotations/index.html b/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/methodAnnotations/index.html index 784da943..6737287b 100644 --- a/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/methodAnnotations/index.html +++ b/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/methodAnnotations/index.html @@ -30,7 +30,7 @@
Module URI:
https://example.com/methodAnnotations.pklcontent_copy
Source code:
-
methodAnnotations.pkl
+
methodAnnotations.pkl
diff --git a/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/moduleComments/index.html b/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/moduleComments/index.html index ce12505d..db1ac29b 100644 --- a/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/moduleComments/index.html +++ b/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/moduleComments/index.html @@ -32,7 +32,7 @@
Module URI:
https://example.com/moduleComments.pklcontent_copy
Source code:
-
moduleComments.pkl
+
moduleComments.pkl
diff --git a/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/moduleExtend/index.html b/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/moduleExtend/index.html index c3e7e075..17bec328 100644 --- a/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/moduleExtend/index.html +++ b/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/moduleExtend/index.html @@ -31,7 +31,7 @@
Module URI:
https://example.com/moduleExtend.pklcontent_copy
Source code:
-
moduleExtend.pkl
+
moduleExtend.pkl
diff --git a/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/moduleInfoAnnotation/index.html b/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/moduleInfoAnnotation/index.html index ba04ef9e..2e93f60f 100644 --- a/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/moduleInfoAnnotation/index.html +++ b/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/moduleInfoAnnotation/index.html @@ -32,7 +32,7 @@
Pkl version:
0.10.0 or higher
Source code:
-
moduleInfoAnnotation.pkl
+
moduleInfoAnnotation.pkl
diff --git a/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/moduleMethodCommentInheritance/index.html b/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/moduleMethodCommentInheritance/index.html index f665add5..5a0f9459 100644 --- a/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/moduleMethodCommentInheritance/index.html +++ b/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/moduleMethodCommentInheritance/index.html @@ -30,7 +30,7 @@
Module URI:
https://example.com/moduleMethodCommentInheritance.pklcontent_copy
Source code:
-
moduleMethodCommentInheritance.pkl
+
moduleMethodCommentInheritance.pkl
diff --git a/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/moduleMethodComments/index.html b/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/moduleMethodComments/index.html index e316ee85..66f0c054 100644 --- a/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/moduleMethodComments/index.html +++ b/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/moduleMethodComments/index.html @@ -31,7 +31,7 @@
Module URI:
https://example.com/moduleMethodComments.pklcontent_copy
Source code:
-
moduleMethodComments.pkl
+
moduleMethodComments.pkl
diff --git a/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/moduleMethodModifiers/index.html b/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/moduleMethodModifiers/index.html index 86a87a88..2ec646e7 100644 --- a/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/moduleMethodModifiers/index.html +++ b/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/moduleMethodModifiers/index.html @@ -31,7 +31,7 @@
Module URI:
https://example.com/moduleMethodModifiers.pklcontent_copy
Source code:
-
moduleMethodModifiers.pkl
+
moduleMethodModifiers.pkl
diff --git a/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/moduleMethodTypeAnnotations/index.html b/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/moduleMethodTypeAnnotations/index.html index 75f2cad8..dd74a2d6 100644 --- a/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/moduleMethodTypeAnnotations/index.html +++ b/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/moduleMethodTypeAnnotations/index.html @@ -31,7 +31,7 @@
Module URI:
https://example.com/moduleMethodTypeAnnotations.pklcontent_copy
Source code:
-
moduleMethodTypeAnnotations.pkl
+
moduleMethodTypeAnnotations.pkl
diff --git a/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/moduleMethodTypeReferences/index.html b/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/moduleMethodTypeReferences/index.html index f5f065be..e4f14fa6 100644 --- a/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/moduleMethodTypeReferences/index.html +++ b/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/moduleMethodTypeReferences/index.html @@ -33,7 +33,7 @@ the same module, a different module, and external modules.

Module URI:
https://example.com/moduleMethodTypeReferences.pklcontent_copy
Source code:
-
moduleMethodTypeReferences.pkl
+
moduleMethodTypeReferences.pkl
diff --git a/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/modulePropertyAnnotations/index.html b/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/modulePropertyAnnotations/index.html index fa9a73ae..99e30fdd 100644 --- a/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/modulePropertyAnnotations/index.html +++ b/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/modulePropertyAnnotations/index.html @@ -31,7 +31,7 @@
Module URI:
https://example.com/modulePropertyAnnotations.pklcontent_copy
Source code:
-
modulePropertyAnnotations.pkl
+
modulePropertyAnnotations.pkl
diff --git a/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/modulePropertyCommentInheritance/index.html b/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/modulePropertyCommentInheritance/index.html index c38dcc18..2ba18cb4 100644 --- a/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/modulePropertyCommentInheritance/index.html +++ b/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/modulePropertyCommentInheritance/index.html @@ -30,7 +30,7 @@
Module URI:
https://example.com/modulePropertyCommentInheritance.pklcontent_copy
Source code:
-
modulePropertyCommentInheritance.pkl
+
modulePropertyCommentInheritance.pkl
diff --git a/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/modulePropertyComments/index.html b/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/modulePropertyComments/index.html index 2aeff543..55d85b4f 100644 --- a/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/modulePropertyComments/index.html +++ b/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/modulePropertyComments/index.html @@ -31,7 +31,7 @@
Module URI:
https://example.com/modulePropertyComments.pklcontent_copy
Source code:
-
modulePropertyComments.pkl
+
modulePropertyComments.pkl
diff --git a/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/modulePropertyModifiers/index.html b/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/modulePropertyModifiers/index.html index 519b5c6e..5b13735c 100644 --- a/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/modulePropertyModifiers/index.html +++ b/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/modulePropertyModifiers/index.html @@ -31,7 +31,7 @@
Module URI:
https://example.com/modulePropertyModifiers.pklcontent_copy
Source code:
-
modulePropertyModifiers.pkl
+
modulePropertyModifiers.pkl
diff --git a/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/modulePropertyTypeAnnotations/index.html b/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/modulePropertyTypeAnnotations/index.html index fe55e426..fd8ce921 100644 --- a/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/modulePropertyTypeAnnotations/index.html +++ b/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/modulePropertyTypeAnnotations/index.html @@ -31,7 +31,7 @@
Module URI:
https://example.com/modulePropertyTypeAnnotations.pklcontent_copy
Source code:
-
modulePropertyTypeAnnotations.pkl
+
modulePropertyTypeAnnotations.pkl
diff --git a/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/modulePropertyTypeReferences/index.html b/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/modulePropertyTypeReferences/index.html index 0ea6084f..7ffd5891 100644 --- a/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/modulePropertyTypeReferences/index.html +++ b/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/modulePropertyTypeReferences/index.html @@ -33,7 +33,7 @@ the same module, a different module, and external modules.

Module URI:
https://example.com/modulePropertyTypeReferences.pklcontent_copy
Source code:
-
modulePropertyTypeReferences.pkl
+
modulePropertyTypeReferences.pkl
diff --git a/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/moduleTypes1/index.html b/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/moduleTypes1/index.html index 02826c94..365d1edd 100644 --- a/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/moduleTypes1/index.html +++ b/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/moduleTypes1/index.html @@ -30,7 +30,7 @@
Module URI:
https://example.com/moduleTypes1.pklcontent_copy
Source code:
-
moduleTypes1.pkl
+
moduleTypes1.pkl
diff --git a/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/moduleTypes2/index.html b/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/moduleTypes2/index.html index 99e37950..b39a5682 100644 --- a/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/moduleTypes2/index.html +++ b/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/moduleTypes2/index.html @@ -31,7 +31,7 @@
Module URI:
https://example.com/moduleTypes2.pklcontent_copy
Source code:
-
moduleTypes2.pkl
+
moduleTypes2.pkl
diff --git a/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/nested/nested2/nestedModule/index.html b/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/nested/nested2/nestedModule/index.html index 0b59c5e1..fd04626c 100644 --- a/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/nested/nested2/nestedModule/index.html +++ b/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/nested/nested2/nestedModule/index.html @@ -31,7 +31,7 @@
Module URI:
https://example.com/nested/nested2/nestedModule.pklcontent_copy
Source code:
-
nestedModule.pkl
+
nestedModule.pkl
diff --git a/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/shared/index.html b/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/shared/index.html index e9a80479..486da487 100644 --- a/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/shared/index.html +++ b/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/shared/index.html @@ -31,7 +31,7 @@
Module URI:
https://example.com/shared.pklcontent_copy
Source code:
-
shared.pkl
+
shared.pkl
diff --git a/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/ternalPackage/index.html b/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/ternalPackage/index.html index f624e187..0204b92a 100644 --- a/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/ternalPackage/index.html +++ b/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/ternalPackage/index.html @@ -30,7 +30,7 @@
Module URI:
https://example.com/ternalPackage.pklcontent_copy
Source code:
-
ternalPackage.pkl
+
ternalPackage.pkl
diff --git a/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/typeAliasInheritance/index.html b/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/typeAliasInheritance/index.html index 6462f9d5..84848c35 100644 --- a/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/typeAliasInheritance/index.html +++ b/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/typeAliasInheritance/index.html @@ -32,7 +32,7 @@
Module URI:
https://example.com/typeAliasInheritance.pklcontent_copy
Source code:
-
typeAliasInheritance.pkl
+
typeAliasInheritance.pkl
diff --git a/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/typealiases/index.html b/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/typealiases/index.html index a206bab6..597dc073 100644 --- a/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/typealiases/index.html +++ b/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/typealiases/index.html @@ -32,7 +32,7 @@
Module URI:
https://example.com/typealiases.pklcontent_copy
Source code:
-
typealiases.pkl
+
typealiases.pkl
diff --git a/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/typealiases2/index.html b/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/typealiases2/index.html index 02509ed0..6415c69a 100644 --- a/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/typealiases2/index.html +++ b/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/typealiases2/index.html @@ -32,7 +32,7 @@
Module URI:
https://example.com/typealiases2.pklcontent_copy
Source code:
-
typealiases2.pkl
+
typealiases2.pkl
diff --git a/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/unionTypes/index.html b/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/unionTypes/index.html index 125ed83b..c99d3436 100644 --- a/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/unionTypes/index.html +++ b/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/unionTypes/index.html @@ -30,7 +30,7 @@
Module URI:
https://example.com/unionTypes.pklcontent_copy
Source code:
-
unionTypes.pkl
+
unionTypes.pkl
diff --git a/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/unlistedClass/index.html b/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/unlistedClass/index.html index fb2182c9..323db821 100644 --- a/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/unlistedClass/index.html +++ b/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/unlistedClass/index.html @@ -30,7 +30,7 @@
Module URI:
https://example.com/unlistedClass.pklcontent_copy
Source code:
-
unlistedClass.pkl
+
unlistedClass.pkl
diff --git a/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/unlistedMethod/index.html b/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/unlistedMethod/index.html index 3f86b6c0..c95657be 100644 --- a/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/unlistedMethod/index.html +++ b/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/unlistedMethod/index.html @@ -31,7 +31,7 @@
Module URI:
https://example.com/unlistedMethod.pklcontent_copy
Source code:
-
unlistedMethod.pkl
+
unlistedMethod.pkl
diff --git a/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/unlistedProperty/index.html b/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/unlistedProperty/index.html index e7133213..abebc793 100644 --- a/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/unlistedProperty/index.html +++ b/pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/unlistedProperty/index.html @@ -31,7 +31,7 @@
Module URI:
https://example.com/unlistedProperty.pklcontent_copy
Source code:
-
unlistedProperty.pkl
+
unlistedProperty.pkl
diff --git a/pkl-doc/src/test/files/DocGeneratorTest/output/com.package2/4.5.6/Module3/index.html b/pkl-doc/src/test/files/DocGeneratorTest/output/com.package2/4.5.6/Module3/index.html index 39545fe7..bba25e45 100644 --- a/pkl-doc/src/test/files/DocGeneratorTest/output/com.package2/4.5.6/Module3/index.html +++ b/pkl-doc/src/test/files/DocGeneratorTest/output/com.package2/4.5.6/Module3/index.html @@ -31,7 +31,7 @@
Module URI:
modulepath:/com/package2/Module3.pklcontent_copy
Source code:
-
Module3.pkl
+
Module3.pkl
diff --git a/pkl-doc/src/test/files/DocGeneratorTest/output/localhost:0/birds/0.5.0/Bird/index.html b/pkl-doc/src/test/files/DocGeneratorTest/output/localhost:0/birds/0.5.0/Bird/index.html index a21b005c..f7a6f0f2 100644 --- a/pkl-doc/src/test/files/DocGeneratorTest/output/localhost:0/birds/0.5.0/Bird/index.html +++ b/pkl-doc/src/test/files/DocGeneratorTest/output/localhost:0/birds/0.5.0/Bird/index.html @@ -30,7 +30,7 @@
Module URI:
package://localhost:0/Bird.pklcontent_copy
Source code:
-
Bird.pkl
+
Bird.pkl
diff --git a/pkl-doc/src/test/files/DocGeneratorTest/output/localhost:0/birds/0.5.0/allFruit/index.html b/pkl-doc/src/test/files/DocGeneratorTest/output/localhost:0/birds/0.5.0/allFruit/index.html index 97e58212..8df77427 100644 --- a/pkl-doc/src/test/files/DocGeneratorTest/output/localhost:0/birds/0.5.0/allFruit/index.html +++ b/pkl-doc/src/test/files/DocGeneratorTest/output/localhost:0/birds/0.5.0/allFruit/index.html @@ -30,7 +30,7 @@
Module URI:
package://localhost:0/allFruit.pklcontent_copy
Source code:
-
allFruit.pkl
+
allFruit.pkl
diff --git a/pkl-doc/src/test/files/DocGeneratorTest/output/localhost:0/birds/0.5.0/catalog/index.html b/pkl-doc/src/test/files/DocGeneratorTest/output/localhost:0/birds/0.5.0/catalog/index.html index 18add738..0af0f836 100644 --- a/pkl-doc/src/test/files/DocGeneratorTest/output/localhost:0/birds/0.5.0/catalog/index.html +++ b/pkl-doc/src/test/files/DocGeneratorTest/output/localhost:0/birds/0.5.0/catalog/index.html @@ -30,7 +30,7 @@
Module URI:
package://localhost:0/catalog.pklcontent_copy
Source code:
-
catalog.pkl
+
catalog.pkl