diff options
| author | Ignat Beresnev <ignat@beresnev.me> | 2021-12-14 10:09:10 +0300 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-12-14 10:09:10 +0300 |
| commit | ed5d582b1a0f667c21443d1a493ff46bc5860865 (patch) | |
| tree | 1733fe31493f742584763895f443f1874a4693ab /core | |
| parent | bf9d62a7a2bb510d8099bb2bba225b95c2c064f1 (diff) | |
| parent | 19b2a2d5d0986fca3cf6766a05d09d7e458aa370 (diff) | |
| download | dokka-ed5d582b1a0f667c21443d1a493ff46bc5860865.tar.gz dokka-ed5d582b1a0f667c21443d1a493ff46bc5860865.tar.bz2 dokka-ed5d582b1a0f667c21443d1a493ff46bc5860865.zip | |
Merge pull request #2259 from Kotlin/2213-description-list-support
Description list support for JavaDocs (#2213)
Diffstat (limited to 'core')
| -rw-r--r-- | core/api/core.api | 8 | ||||
| -rw-r--r-- | core/src/main/kotlin/pages/ContentNodes.kt | 22 |
2 files changed, 30 insertions, 0 deletions
diff --git a/core/api/core.api b/core/api/core.api index 96fe317a..46a4c3a5 100644 --- a/core/api/core.api +++ b/core/api/core.api @@ -3913,6 +3913,14 @@ public final class org/jetbrains/dokka/pages/HtmlContent : org/jetbrains/dokka/m public abstract interface class org/jetbrains/dokka/pages/Kind { } +public final class org/jetbrains/dokka/pages/ListStyle : java/lang/Enum, org/jetbrains/dokka/pages/Style { + public static final field DescriptionDetails Lorg/jetbrains/dokka/pages/ListStyle; + public static final field DescriptionList Lorg/jetbrains/dokka/pages/ListStyle; + public static final field DescriptionTerm Lorg/jetbrains/dokka/pages/ListStyle; + public static fun valueOf (Ljava/lang/String;)Lorg/jetbrains/dokka/pages/ListStyle; + public static fun values ()[Lorg/jetbrains/dokka/pages/ListStyle; +} + public abstract interface class org/jetbrains/dokka/pages/MemberPage : org/jetbrains/dokka/pages/ContentPage { } 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 |