aboutsummaryrefslogtreecommitdiff
path: root/core/src/main/kotlin/utilities/Html.kt
diff options
context:
space:
mode:
Diffstat (limited to 'core/src/main/kotlin/utilities/Html.kt')
-rw-r--r--core/src/main/kotlin/utilities/Html.kt15
1 files changed, 15 insertions, 0 deletions
diff --git a/core/src/main/kotlin/utilities/Html.kt b/core/src/main/kotlin/utilities/Html.kt
new file mode 100644
index 00000000..3226ca9d
--- /dev/null
+++ b/core/src/main/kotlin/utilities/Html.kt
@@ -0,0 +1,15 @@
+package org.jetbrains.dokka.utilities
+
+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.urlEncoded(): String = URLEncoder.encode(this, "UTF-8")
+
+fun String.formatToEndWithHtml() =
+ if (endsWith(".html") || contains(Regex("\\.html#"))) this else "$this.html" \ No newline at end of file