Apply requested changes

Kotlin · Jan 17, 2022 · a3c9a6a · a3c9a6a
1 parent a9c8e8d
commit a3c9a6a
Show file tree

Hide file tree

Showing 6 changed files with 14 additions and 8 deletions.
diff --git a/core/src/main/kotlin/utilities/Html.kt b/core/src/main/kotlin/utilities/Html.kt
@@ -7,9 +7,9 @@ import java.net.URLEncoder
  * Replaces symbols reserved in HTML with their respective entities.
  * Replaces & with &amp;, < with &lt; and > with &gt;
  */
-fun String.htmlEscape(): String = replace("&", "&amp;").replace("<", "&lt;").replace(">", "&gt;")
+fun String.htmlEscape(): String = replace("&", "&amp;").replace("<", "&lt;").replace(">", "&gt;").replace("\"", "&quot;")
 
 fun String.urlEncoded(): String = URLEncoder.encode(this, "UTF-8")
 
 fun String.formatToEndWithHtml() =
-    if (endsWith(".html") || contains(Regex("\\.html#"))) this else "$this.html"
+    if (endsWith(".html") || contains(Regex("\\.html#"))) this else "$this.html"
diff --git a/...base/src/main/kotlin/translators/descriptors/DefaultDescriptorToDocumentableTranslator.kt b/...base/src/main/kotlin/translators/descriptors/DefaultDescriptorToDocumentableTranslator.kt
@@ -306,7 +306,7 @@ private class DokkaDescriptorVisitor(
             val classlikes = async { descriptorsWithKind.classlikes.visitClasslikes(driWithPlatform) }
 
             DEnumEntry(
-                dri = driWithPlatform.dri.copy(extra = DRIExtraContainer().also { it[EnumEntryDRIExtra] = EnumEntryDRIExtra }.encode()),
+                dri = driWithPlatform.dri.copy(extra = DRIExtraContainer(driWithPlatform.dri.extra).also { it[EnumEntryDRIExtra] = EnumEntryDRIExtra }.encode()),
                 name = descriptor.name.asString(),
                 documentation = descriptor.resolveDescriptorData(),
                 functions = functions.await(),

diff --git a/plugins/base/src/main/kotlin/translators/psi/DefaultPsiToDocumentableTranslator.kt b/plugins/base/src/main/kotlin/translators/psi/DefaultPsiToDocumentableTranslator.kt
@@ -269,7 +269,7 @@ class DefaultPsiToDocumentableTranslator(
                         name.orEmpty(),
                         fields.filterIsInstance<PsiEnumConstant>().map { entry ->
                             DEnumEntry(
-                                dri.withClass(entry.name).copy(extra = DRIExtraContainer().also { it[EnumEntryDRIExtra] = EnumEntryDRIExtra }.encode()),
+                                dri.withClass(entry.name).copy(extra = DRIExtraContainer(dri.extra).also { it[EnumEntryDRIExtra] = EnumEntryDRIExtra }.encode()),
                                 entry.name,
                                 javadocParser.parseDocumentation(entry).toSourceSetDependent(),
                                 null,

diff --git a/plugins/base/src/main/kotlin/translators/psi/parsers/JavadocParser.kt b/plugins/base/src/main/kotlin/translators/psi/parsers/JavadocParser.kt
@@ -326,7 +326,7 @@ class JavadocParser(
                 dri.toString()
             } ?: UNRESOLVED_PSI_ELEMENT
 
-            return """<a data-dri="${dri.replace("\"", "&quot;")}">${label.ifBlank{ defaultLabel().text }}</a>"""
+            return """<a data-dri="${dri.htmlEscape()}">${label.ifBlank{ defaultLabel().text }}</a>"""
         }
 
         private fun convertInlineDocTag(

diff --git a/.../test/kotlin/linking/EnumValuesLinking.kt → ...t/kotlin/linking/EnumValuesLinkingTest.kt b/.../test/kotlin/linking/EnumValuesLinking.kt → ...t/kotlin/linking/EnumValuesLinkingTest.kt
@@ -1,6 +1,8 @@
 package linking
 
 import org.jetbrains.dokka.base.testApi.testRunner.BaseAbstractTest
+import org.jetbrains.dokka.links.DRIExtraContainer
+import org.jetbrains.dokka.links.EnumEntryDRIExtra
 import org.jetbrains.dokka.model.dfs
 import org.jetbrains.dokka.model.doc.DocumentationLink
 import org.jetbrains.dokka.pages.ContentDRILink
@@ -13,7 +15,7 @@ import java.nio.file.Paths
 import utils.TestOutputWriterPlugin
 import java.lang.AssertionError
 
-class EnumValuesLinking : BaseAbstractTest() {
+class EnumValuesLinkingTest : BaseAbstractTest() {
 
     @Test
     fun `check if enum values are correctly linked`() {
@@ -41,6 +43,7 @@ class EnumValuesLinking : BaseAbstractTest() {
                         is DocumentationLink -> kotlinLink.dri.run {
                             assertEquals("KotlinEnum.ON_CREATE", this.classNames)
                             assertEquals(null, this.callable)
+                            assertNotNull(DRIExtraContainer(extra)[EnumEntryDRIExtra])
                         }
                         else -> throw AssertionError("Link node is not DocumentationLink type")
                     }
@@ -49,6 +52,7 @@ class EnumValuesLinking : BaseAbstractTest() {
                         is DocumentationLink -> javaLink.dri.run {
                             assertEquals("JavaEnum.ON_DECEIT", this.classNames)
                             assertEquals(null, this.callable)
+                            assertNotNull(DRIExtraContainer(extra)[EnumEntryDRIExtra])
                         }
                         else -> throw AssertionError("Link node is not DocumentationLink type")
                     }
@@ -60,6 +64,7 @@ class EnumValuesLinking : BaseAbstractTest() {
                         is DocumentationLink -> kotlinLink.dri.run {
                             assertEquals("KotlinEnum.ON_CREATE", this.classNames)
                             assertEquals(null, this.callable)
+                            assertNotNull(DRIExtraContainer(extra)[EnumEntryDRIExtra])
                         }
                         else -> throw AssertionError("Link node is not DocumentationLink type")
                     }
@@ -68,6 +73,7 @@ class EnumValuesLinking : BaseAbstractTest() {
                         is DocumentationLink -> javaLink.dri.run {
                             assertEquals("JavaEnum.ON_DECEIT", this.classNames)
                             assertEquals(null, this.callable)
+                            assertNotNull(DRIExtraContainer(extra)[EnumEntryDRIExtra])
                         }
                         else -> throw AssertionError("Link node is not DocumentationLink type")
                     }

diff --git a/...ns/javadoc/src/test/kotlin/org/jetbrains/dokka/javadoc/JavadocClasslikeTemplateMapTest.kt b/...ns/javadoc/src/test/kotlin/org/jetbrains/dokka/javadoc/JavadocClasslikeTemplateMapTest.kt
@@ -149,13 +149,13 @@ internal class JavadocClasslikeTemplateMapTest : AbstractJavadocTemplateMapTest(
             val map = allPagesOfType<JavadocClasslikePageNode>().first { it.name == "TestClass" }.templateMap
             assertEquals("TestClass", map["name"])
             val signature = assertIsInstance<Map<String, Any?>>(map["signature"])
-            assertEquals("@<a href=Author.html>Author</a>(name = \"Benjamin Franklin\")", signature["annotations"])
+            assertEquals("@<a href=Author.html>Author</a>(name = &quot;Benjamin Franklin&quot;)", signature["annotations"])
 
             val methods = assertIsInstance<Map<Any, Any?>>(map["methods"])
             val ownMethods = assertIsInstance<List<*>>(methods["own"])
             val method = assertIsInstance<Map<String, Any?>>(ownMethods.single())
             val methodSignature = assertIsInstance<Map<String, Any?>>(method["signature"])
-            assertEquals("@<a href=Author.html>Author</a>(name = \"Franklin D. Roosevelt\")", methodSignature["annotations"])
+            assertEquals("@<a href=Author.html>Author</a>(name = &quot;Franklin D. Roosevelt&quot;)", methodSignature["annotations"])
         }
     }