From 50a3323322265ff3b5dab1d861a25bbb1167812a Mon Sep 17 00:00:00 2001 From: Ignat Beresnev Date: Thu, 18 Aug 2022 19:33:53 +0200 Subject: Add deprecation details block (#2622) --- core/api/core.api | 2 ++ .../api/content-matcher-test-utils.api | 2 ++ .../src/main/kotlin/matchers/content/ContentMatchersDsl.kt | 6 +++++- core/src/main/kotlin/pages/ContentNodes.kt | 9 +++++++-- 4 files changed, 16 insertions(+), 3 deletions(-) (limited to 'core') diff --git a/core/api/core.api b/core/api/core.api index bba6b74a..68bfacec 100644 --- a/core/api/core.api +++ b/core/api/core.api @@ -3791,6 +3791,7 @@ public final class org/jetbrains/dokka/pages/ContentKind : java/lang/Enum, org/j public static final field Companion Lorg/jetbrains/dokka/pages/ContentKind$Companion; public static final field Constructors Lorg/jetbrains/dokka/pages/ContentKind; public static final field Cover Lorg/jetbrains/dokka/pages/ContentKind; + public static final field Deprecation Lorg/jetbrains/dokka/pages/ContentKind; public static final field Empty Lorg/jetbrains/dokka/pages/ContentKind; public static final field Extensions Lorg/jetbrains/dokka/pages/ContentKind; public static final field Functions Lorg/jetbrains/dokka/pages/ContentKind; @@ -3910,6 +3911,7 @@ public final class org/jetbrains/dokka/pages/ContentResolvedLink : org/jetbrains public final class org/jetbrains/dokka/pages/ContentStyle : java/lang/Enum, org/jetbrains/dokka/pages/Style { public static final field Caption Lorg/jetbrains/dokka/pages/ContentStyle; + public static final field Footnote Lorg/jetbrains/dokka/pages/ContentStyle; public static final field InDocumentationAnchor Lorg/jetbrains/dokka/pages/ContentStyle; public static final field Indented Lorg/jetbrains/dokka/pages/ContentStyle; public static final field KDocTag Lorg/jetbrains/dokka/pages/ContentStyle; diff --git a/core/content-matcher-test-utils/api/content-matcher-test-utils.api b/core/content-matcher-test-utils/api/content-matcher-test-utils.api index bd90a04e..0a7f153b 100644 --- a/core/content-matcher-test-utils/api/content-matcher-test-utils.api +++ b/core/content-matcher-test-utils/api/content-matcher-test-utils.api @@ -15,6 +15,8 @@ public final class matchers/content/ContentMatchersDslKt { public static final fun br (Lmatchers/content/ContentMatcherBuilder;)V public static final fun caption (Lmatchers/content/ContentMatcherBuilder;Lkotlin/jvm/functions/Function1;)V public static final fun check (Lmatchers/content/ContentMatcherBuilder;Lkotlin/jvm/functions/Function1;)V + public static final fun codeBlock (Lmatchers/content/ContentMatcherBuilder;Lkotlin/jvm/functions/Function1;)V + public static final fun codeInline (Lmatchers/content/ContentMatcherBuilder;Lkotlin/jvm/functions/Function1;)V public static final fun divergent (Lmatchers/content/ContentMatcherBuilder;Lkotlin/jvm/functions/Function1;)V public static final fun divergentGroup (Lmatchers/content/ContentMatcherBuilder;Lkotlin/jvm/functions/Function1;)V public static final fun divergentInstance (Lmatchers/content/ContentMatcherBuilder;Lkotlin/jvm/functions/Function1;)V diff --git a/core/content-matcher-test-utils/src/main/kotlin/matchers/content/ContentMatchersDsl.kt b/core/content-matcher-test-utils/src/main/kotlin/matchers/content/ContentMatchersDsl.kt index 264be933..08442536 100644 --- a/core/content-matcher-test-utils/src/main/kotlin/matchers/content/ContentMatchersDsl.kt +++ b/core/content-matcher-test-utils/src/main/kotlin/matchers/content/ContentMatchersDsl.kt @@ -91,6 +91,10 @@ fun ContentMatcherBuilder<*>.platformHinted(block: ContentMatcherBuilder.list(block: ContentMatcherBuilder.() -> Unit) = composite(block) +fun ContentMatcherBuilder<*>.codeBlock(block: ContentMatcherBuilder.() -> Unit) = composite(block) + +fun ContentMatcherBuilder<*>.codeInline(block: ContentMatcherBuilder.() -> Unit) = composite(block) + fun ContentMatcherBuilder<*>.caption(block: ContentMatcherBuilder.() -> Unit) = composite { block() check { assertThat(this::style).contains(ContentStyle.Caption) } @@ -117,4 +121,4 @@ fun ContentMatcherBuilder.divergent(block: ContentMatc composite(block) fun ContentMatcherBuilder.after(block: ContentMatcherBuilder.() -> Unit) = - composite(block) \ No newline at end of file + composite(block) diff --git a/core/src/main/kotlin/pages/ContentNodes.kt b/core/src/main/kotlin/pages/ContentNodes.kt index 0d8475a9..35b70840 100644 --- a/core/src/main/kotlin/pages/ContentNodes.kt +++ b/core/src/main/kotlin/pages/ContentNodes.kt @@ -333,7 +333,12 @@ enum class ContentKind : Kind { Symbol, Comment, Constructors, Functions, Parameters, Properties, Classlikes, Packages, Sample, Main, BriefComment, - Empty, Source, TypeAliases, Cover, Inheritors, SourceSetDependentHint, Extensions, Annotations; + Empty, Source, TypeAliases, Cover, Inheritors, SourceSetDependentHint, Extensions, Annotations, + + /** + * Deprecation details block with related information such as message/replaceWith/level. + */ + Deprecation; companion object { private val platformTagged = @@ -388,7 +393,7 @@ enum class TextStyle : Style { enum class ContentStyle : Style { RowTitle, TabbedContent, WithExtraAttributes, RunnableSample, InDocumentationAnchor, Caption, - Wrapped, Indented, KDocTag + Wrapped, Indented, KDocTag, Footnote } enum class ListStyle : Style { -- cgit