Change Deprecated message

Kotlin · Feb 21, 2023 · 23d8bfb · 23d8bfb
1 parent 24880f3
commit 23d8bfb
Show file tree

Hide file tree

Showing 6 changed files with 18 additions and 21 deletions.
diff --git a/core/src/main/kotlin/pages/contentNodeProperties.kt b/core/src/main/kotlin/pages/contentNodeProperties.kt
@@ -10,8 +10,7 @@ class SimpleAttr(val extraKey: String, val extraValue: String) : ExtraProperty<C
 
 const val TOGGLEABLE_CONTENT_TYPE_ATTR = "data-togglable"
 enum class BasicTabbedContentType : TabbedContentType {
-    TYPE, CONSTRUCTOR, FUNCTION, PROPERTY, ENTRY, EXTENSION,
-    INVISIBLE
+    TYPE, CONSTRUCTOR, FUNCTION, PROPERTY, ENTRY, EXTENSION_PROPERTY, EXTENSION_FUNCTION
 }
 
 /**

diff --git a/plugins/base/src/main/kotlin/DokkaBase.kt b/plugins/base/src/main/kotlin/DokkaBase.kt
@@ -51,7 +51,7 @@ class DokkaBase : DokkaPlugin() {
     val outputWriter by extensionPoint<OutputWriter>()
     val htmlPreprocessors by extensionPoint<PageTransformer>()
     val kotlinAnalysis by extensionPoint<KotlinAnalysis>()
-    @Deprecated("It is not used anymore. The order can be changed in `ContentTabsExtra`, for example, by a transformer")
+    @Deprecated("It is not used anymore")
     val tabSortingStrategy by extensionPoint<TabSortingStrategy>()
     val immediateHtmlCommandConsumer by extensionPoint<ImmediateHtmlCommandConsumer>()
     val externalDocumentablesProvider by extensionPoint<ExternalDocumentablesProvider>()

diff --git a/plugins/base/src/main/kotlin/renderers/html/HtmlRenderer.kt b/plugins/base/src/main/kotlin/renderers/html/HtmlRenderer.kt
@@ -93,7 +93,8 @@ open class HtmlRenderer(
                     BasicTabbedContentType.TYPE,
                     BasicTabbedContentType.FUNCTION,
                     BasicTabbedContentType.PROPERTY,
-                    BasicTabbedContentType.EXTENSION,
+                    BasicTabbedContentType.EXTENSION_PROPERTY,
+                    BasicTabbedContentType.EXTENSION_FUNCTION
                 )
             ),
             if(csEnum.isEmpty()) null else ContentTab(
@@ -116,14 +117,14 @@ open class HtmlRenderer(
                 "Functions",
                 listOf(
                     BasicTabbedContentType.FUNCTION,
-                    BasicTabbedContentType.EXTENSION,
+                    BasicTabbedContentType.EXTENSION_FUNCTION,
                 )
             ),
             if (p.properties.isEmpty()) null else ContentTab(
                 "Properties",
                 listOf(
                     BasicTabbedContentType.PROPERTY,
-                    BasicTabbedContentType.EXTENSION,
+                    BasicTabbedContentType.EXTENSION_PROPERTY,
                 )
             )
         )
@@ -905,7 +906,7 @@ open class HtmlRenderer(
         templater.renderFromTemplate(DokkaTemplateTypes.BASE) {
             val generatedContent =
                 createHTML().div("main-content") {
-                    page.getDocumentableType()?.let { attributes["documentable-type"] = it }
+                    page.getDocumentableType()?.let { attributes["data-documentable-type"] = it }
                     id = "content"
                     (page as? ContentPage)?.let {
                         attributes["pageIds"] = "${context.configuration.moduleName}::${page.pageId}"
@@ -976,8 +977,8 @@ private fun TabbedContentType.toHtmlAttribute(): String =
                 BasicTabbedContentType.CONSTRUCTOR -> "CONSTRUCTOR"
                 BasicTabbedContentType.FUNCTION -> "FUNCTION"
                 BasicTabbedContentType.PROPERTY -> "PROPERTY"
-                BasicTabbedContentType.EXTENSION -> "EXTENSION"
-                BasicTabbedContentType.INVISIBLE -> "INVISIBLE"
+                BasicTabbedContentType.EXTENSION_PROPERTY -> "EXTENSION_PROPERTY"
+                BasicTabbedContentType.EXTENSION_FUNCTION -> "EXTENSION_FUNCTION"
             }
     else -> throw IllegalStateException("Unknown TabbedContentType $this")
     }

diff --git a/plugins/base/src/main/kotlin/translators/documentables/DefaultPageCreator.kt b/plugins/base/src/main/kotlin/translators/documentables/DefaultPageCreator.kt
@@ -267,8 +267,7 @@ open class DefaultPageCreator(
             types,
             scopes.flatMap { it.functions },
             scopes.flatMap { it.properties },
-            extensions,
-            true
+            extensions
         )
     }
 
@@ -290,15 +289,13 @@ open class DefaultPageCreator(
         types: List<Documentable>,
         functions: List<DFunction>,
         properties: List<DProperty>,
-        extensions: List<Documentable>,
-        isClasslike: Boolean = false
+        extensions: List<Documentable>
     ) = contentBuilder.contentFor(dri, sourceSets) {
         divergentBlock(
             "Types",
             types,
             ContentKind.Classlikes,
-            extra = mainExtra + TabbedContentTypeExtra(BasicTabbedContentType.TYPE),
-            headerExtra = if (isClasslike) mainExtra else mainExtra + TabbedContentTypeExtra(BasicTabbedContentType.INVISIBLE)
+            extra = mainExtra + TabbedContentTypeExtra(BasicTabbedContentType.TYPE)
         )
         val (extensionProps, extensionFuns) = extensions.splitPropsAndFuns()
         if (separateInheritedMembers) {
@@ -544,7 +541,7 @@ open class DefaultPageCreator(
             name,
             list.sorted(),
             ContentKind.Functions,
-            extra = mainExtra + TabbedContentTypeExtra(if (onlyExtensions) BasicTabbedContentType.EXTENSION else tabbedContentType)
+            extra = mainExtra + TabbedContentTypeExtra(if (onlyExtensions) BasicTabbedContentType.EXTENSION_FUNCTION else tabbedContentType)
         )
     }
 
@@ -568,13 +565,13 @@ open class DefaultPageCreator(
             sortedGroupedElements.map { it.first.name to it.second },
             sourceSets,
             needsAnchors = true,
-            extra = mainExtra + TabbedContentTypeExtra(if(onlyExtensions)  BasicTabbedContentType.EXTENSION  else tabbedContentType),
+            extra = mainExtra + TabbedContentTypeExtra(if(onlyExtensions)  BasicTabbedContentType.EXTENSION_PROPERTY  else tabbedContentType),
             headers = listOf(
                 headers("Name", "Summary")
             )
         ) { key, props ->
             val extra =
-                if (props.all { it.isExtension() }) mainExtra + TabbedContentTypeExtra(BasicTabbedContentType.EXTENSION) else mainExtra
+                if (props.all { it.isExtension() }) mainExtra + TabbedContentTypeExtra(BasicTabbedContentType.EXTENSION_PROPERTY) else mainExtra
             link(
                 text = key,
                 address = props.first().dri,
@@ -628,7 +625,7 @@ open class DefaultPageCreator(
                             val elementName = elementNameAndIsExtension.first
                             val isExtension = elementNameAndIsExtension.second
                             val rowExtra =
-                                if (isExtension) extra + TabbedContentTypeExtra(BasicTabbedContentType.EXTENSION) else extra
+                                if (isExtension) extra + TabbedContentTypeExtra(BasicTabbedContentType.EXTENSION_FUNCTION) else extra
 
                             row(
                                 dri = elements.map { it.dri }.toSet(),

diff --git a/plugins/base/src/main/kotlin/translators/documentables/PageContentBuilder.kt b/plugins/base/src/main/kotlin/translators/documentables/PageContentBuilder.kt
@@ -262,7 +262,7 @@ open class PageContentBuilder(
                                 val documentables = it.second
                                 val newExtraWithTab =
                                     if (documentables.all { it.isExtension() }) mainExtra + TabbedContentTypeExtra(
-                                        BasicTabbedContentType.EXTENSION
+                                        BasicTabbedContentType.EXTENSION_PROPERTY
                                     ) else mainExtra
                                 val newExtra = if (needsAnchors) newExtraWithTab + SymbolAnchorHint(
                                     it.first,

diff --git a/plugins/base/src/main/resources/dokka/styles/style.css b/plugins/base/src/main/resources/dokka/styles/style.css
@@ -1294,6 +1294,6 @@ div.runnablesample {
 }
 
 // the hack to hide the headers inside tabs for a package page
-.main-content[documentable-type="package"] .tabs-section-body > h2 {
+.main-content[data-documentable-type="package"] .tabs-section-body > h2  !important {
     display: none;
 }