aboutsummaryrefslogtreecommitdiff
path: root/core/src/main/kotlin
diff options
context:
space:
mode:
authorIgnat Beresnev <ignat.beresnev@jetbrains.com>2021-12-06 16:20:51 +0300
committerIgnat Beresnev <ignat.beresnev@jetbrains.com>2021-12-06 16:20:51 +0300
commitc68c05a1e8876e9b8555df7bcdfeaca3e100f0d1 (patch)
treed9c20d2118d6679175ef8ab9f7dfc6d49aba5af3 /core/src/main/kotlin
parent35a69e0322fcd271dccadcc2ee8cbb61dcafe62e (diff)
downloaddokka-c68c05a1e8876e9b8555df7bcdfeaca3e100f0d1.tar.gz
dokka-c68c05a1e8876e9b8555df7bcdfeaca3e100f0d1.tar.bz2
dokka-c68c05a1e8876e9b8555df7bcdfeaca3e100f0d1.zip
Description list support for JavaDocs (#2213)
Diffstat (limited to 'core/src/main/kotlin')
-rw-r--r--core/src/main/kotlin/pages/ContentNodes.kt22
1 files changed, 22 insertions, 0 deletions
diff --git a/core/src/main/kotlin/pages/ContentNodes.kt b/core/src/main/kotlin/pages/ContentNodes.kt
index 0c262937..c1bb3b8c 100644
--- a/core/src/main/kotlin/pages/ContentNodes.kt
+++ b/core/src/main/kotlin/pages/ContentNodes.kt
@@ -350,6 +350,28 @@ enum class ContentStyle : Style {
RowTitle, TabbedContent, WithExtraAttributes, RunnableSample, InDocumentationAnchor, Caption
}
+enum class ListStyle : Style {
+ /**
+ * Represents a list of groups of [DescriptionTerm] and [DescriptionDetails].
+ * Common uses for this element are to implement a glossary or to display
+ * metadata (a list of key-value pairs). Formatting example: see `<dl>` html tag.
+ */
+ DescriptionList,
+
+ /**
+ * If used within [DescriptionList] context, specifies a term in a description
+ * or definition list, usually followed by [DescriptionDetails] for one or more
+ * terms. Formatting example: see `<dt>` html tag
+ */
+ DescriptionTerm,
+
+ /**
+ * If used within [DescriptionList] context, provides the definition or other
+ * related text associated with [DescriptionTerm]. Formatting example: see `<dd>` html tag
+ */
+ DescriptionDetails
+}
+
object CommentTable : Style
object MultimoduleTable : Style