Reorganize tabs for Classlike #2764

vmishenev · 2022-12-05T22:15:34Z

on #2749

plugins/base/src/main/resources/dokka/scripts/platform-content-handler.js

plugins/base/src/main/kotlin/translators/documentables/DefaultPageCreator.kt

core/src/main/kotlin/pages/contentNodeProperties.kt

plugins/base/src/main/kotlin/renderers/html/HtmlRenderer.kt

IgnatBeresnev

I tried to wrap my head around how it worked before and how it's working now, but couldn't understand anything by just looking at this PR alone, so I started debugging

When I understood how it worked previously and how works in this PR, I tried to address things that I found confusing / not obvious / difficult to find, and tried to think of ways which would've made it easier.

I also tried to implement my suggestions to see if there were any problems/blockers that I didn't notice. Result can be found in #2810, it's a very rough draft, but it works for the most part. Hopefully it adds more context to my comments

I've commented on major things only since there's no point in commenting on code that might get deleted, so I'd like to have another look before merge

core/src/main/kotlin/pages/contentNodeProperties.kt

plugins/base/src/main/kotlin/translators/documentables/DefaultPageCreator.kt

core/src/main/kotlin/pages/contentNodeProperties.kt

plugins/base/src/main/kotlin/renderers/html/HtmlRenderer.kt

plugins/base/src/main/kotlin/translators/documentables/DefaultPageCreator.kt

plugins/base/src/main/resources/dokka/scripts/platform-content-handler.js

plugins/base/src/main/kotlin/translators/documentables/DefaultPageCreator.kt

IgnatBeresnev · 2023-01-12T03:44:56Z

Some additional things that I noticed:

Anchors don't work in the preview. If you open Member + Extensions tab and then copy an anchor and follow it, it will reset selected tabs and not focus on the declaration
Found an empty Members tab with the Function header, for example in CoroutineScope class (see screenshot 1)
If a class has only extensions, should the tab be called "Members + Extensions" or just "Extensions"?
Should member and extension functions with the same name be merged like before or listed separately? (see screenshot 2)
Should constructors be listed separately as before or merged together like functions with the same name? (see screenshot 3)

vmishenev · 2023-01-13T13:08:11Z

These changes are obvious, but I would like to avoid a full redesign of tabbed content.
The HTML format is not stable yet. For example, in #2749 we had other tabs and had transformers that can add new tabs,
Besides, we would need to change GFM render as well.
And I'm not sure tabs should be used for classlikes. As for me, the checkbox Show extension is more obvious.

My changes in the existing content model are small.

IgnatBeresnev · 2023-01-13T17:31:23Z

but I would like to avoid a full redesign of tabbed content

I'm not proposing a full redesign, although it would be nice. I do think that partial redesign is necessary though.

I've outlined what I think could be improved and add clarity, with examples. It's unclear whether you're proposing to just disregard it all.

vmishenev · 2023-01-14T15:07:20Z

I've outlined what I think could be improved and add clarity, with examples. It's unclear whether you're proposing to just disregard it all.

I found time to implement some of the proposals, the most important ones.

If a class has only extensions, should the tab be called "Members + Extensions" or just "Extensions"?

It is already discussed. "Members + Extensions"

Should member and extension functions with the same name be merged like before or listed separately?

Separately, so, at least, they lead to different pages.

Should constructors be listed separately as before or merged together like functions with the same name?

The behaviour has not changed in this PR.

IgnatBeresnev

It's definitely getting better and easier to navigate / find usages 👍

core/src/main/kotlin/pages/contentNodeProperties.kt

plugins/base/src/main/kotlin/translators/documentables/DefaultPageCreator.kt

plugins/base/src/main/kotlin/translators/documentables/PageContentBuilder.kt

plugins/base/src/main/kotlin/translators/documentables/DefaultPageCreator.kt

plugins/base/src/main/kotlin/translators/documentables/PageContentBuilder.kt

plugins/kotlin-as-java/src/test/kotlin/KotlinAsJavaPluginTest.kt

plugins/base/src/main/kotlin/translators/documentables/DefaultPageCreator.kt

vmishenev · 2023-02-21T16:35:07Z

After a discussion, it was decided to get rid public API of ContentTabsExtra. The motivation is based on two statements:

The tabs are needed only for HTML format. Other implemented formats do not use tabbed content
The principle of decreasing new public API is applied, but some declarations of tabs are still in public API.

Introduce `BasicToggleableContentType.INVISIBLE`

core/src/main/kotlin/model/Documentable.kt

core/src/main/kotlin/pages/contentNodeProperties.kt

plugins/base/src/main/kotlin/renderers/html/HtmlRenderer.kt

plugins/base/src/test/kotlin/pageMerger/PageNodeMergerTest.kt

plugins/base/src/test/kotlin/renderers/html/CoverPageTest.kt

plugins/base/src/main/kotlin/renderers/html/HtmlRenderer.kt

plugins/base/src/main/kotlin/translators/documentables/PageContentBuilder.kt

plugins/base/src/main/kotlin/translators/documentables/DefaultPageCreator.kt

IgnatBeresnev

Very well done, thanks for addressing the comments! 👍 👍

IgnatBeresnev · 2023-02-24T13:51:29Z

plugins/base/src/main/kotlin/renderers/html/HtmlRenderer.kt

+    /**
+     * Tabs themselves are created in HTML plugin since, currently, only HTML format supports them.
+     * [TabbedContentType] is used to mark content that should be inside tab content.
+     * A tab can display multiple [TabbedContentType].
+     * The content style [ContentStyle.TabbedContent] is used to determine where tabs will be generated.
+     *
+     * @see TabbedContentType
+     * @see ContentStyle.TabbedContent
+     */


🔥 🔥 🔥

plugins/base/src/main/kotlin/renderers/html/HtmlRenderer.kt

IgnatBeresnev · 2023-02-24T13:57:05Z

plugins/base/src/main/kotlin/renderers/html/HtmlRenderer.kt

+
+    private fun createTabsForClasslikes(page: ClasslikePage): List<ContentTab> {
+        val documentables = page.documentables
+        fun List<Documentable>.shouldDocumentConstructors() = !this.any { it is DAnnotation }


The same top-level public function is declared in DefaultPageCreator - can it be used? Not sure if the copy-paste is intentional

It will be unavailable when we have a separate HTML plugin

Wrap tab content Fix css style Revert public API in `DefaultPageCreator`

(cherry picked from commit 1040288)

vmishenev linked an issue Dec 5, 2022 that may be closed by this pull request

Reorganize tabs for class-like items #2763

Closed

vmishenev force-pushed the 2763-reorganize-tabs branch from 7e85362 to e83f031 Compare December 12, 2022 17:31

vmishenev marked this pull request as ready for review December 12, 2022 17:31

vmishenev requested a review from IgnatBeresnev December 12, 2022 17:31

vmishenev force-pushed the 2763-reorganize-tabs branch from e83f031 to 2fc15fe Compare December 13, 2022 14:39

IgnatBeresnev reviewed Dec 15, 2022

View reviewed changes

vmishenev mentioned this pull request Dec 16, 2022

Deduplicate extensions #2780

Merged

vmishenev requested a review from IgnatBeresnev January 5, 2023 16:24

atyrin mentioned this pull request Jan 9, 2023

Invalid default platform tab content on page load for merged declarations #2801

Open

vmishenev force-pushed the 2763-reorganize-tabs branch 2 times, most recently from 88e3034 to ea725b3 Compare January 9, 2023 13:57

IgnatBeresnev mentioned this pull request Jan 12, 2023

Push classlike tabs reorganization research results #2810

Closed

IgnatBeresnev reviewed Jan 12, 2023

View reviewed changes

vmishenev requested a review from IgnatBeresnev January 16, 2023 22:04

vmishenev force-pushed the 2763-reorganize-tabs branch from 73a5fe6 to 92bdc27 Compare January 17, 2023 12:13

IgnatBeresnev reviewed Jan 18, 2023

View reviewed changes

vmishenev requested a review from IgnatBeresnev January 30, 2023 12:53

vmishenev force-pushed the 2763-reorganize-tabs branch from a819cca to 23d8bfb Compare February 21, 2023 16:58

vmishenev added 7 commits February 21, 2023 23:13

Reorganize tabs for Classlike

e2fa5ed

Improve

cabbebf

Fix bugs

f0378ea

Do not merge extensions and members into one group by name

fa564dc

Fix tests

3bf5bca

Do not render empty Members tab

b22c954

Refactor

93710bc

vmishenev added 10 commits February 21, 2023 23:13

Get rid of extraHtmlAttributes in HtmlRender

b1f7725

Redesign

797d8e1

Fix anchors

33f96c3

Fix tests

fa9070e

Hide headers for html on package pages

93106e4

Refactor

926f923

Introduce `BasicToggleableContentType.INVISIBLE`

Remove redundant

312c668

Rid public API of ContentTabsExtra

274d127

Get rid of INVISIBLE

74dc86f

Change Deprecated message

e8e71d8

vmishenev force-pushed the 2763-reorganize-tabs branch from 23d8bfb to fb32411 Compare February 22, 2023 13:07

Add sorting and make properties Divergent

e884773

vmishenev force-pushed the 2763-reorganize-tabs branch from fb32411 to e884773 Compare February 22, 2023 14:44

IgnatBeresnev reviewed Feb 22, 2023

View reviewed changes

vmishenev self-assigned this Feb 22, 2023

Refactor

7ee0138

IgnatBeresnev approved these changes Feb 24, 2023

View reviewed changes

vmishenev requested a review from IgnatBeresnev February 24, 2023 13:49

vmishenev force-pushed the 2763-reorganize-tabs branch from 5facf89 to 1e76662 Compare February 24, 2023 13:59

IgnatBeresnev approved these changes Feb 24, 2023

View reviewed changes

Refactor

e8086a6

Wrap tab content Fix css style Revert public API in `DefaultPageCreator`

vmishenev force-pushed the 2763-reorganize-tabs branch from 1e76662 to e8086a6 Compare February 24, 2023 14:46

Support ContentKind.Extensions

d7a0317

vmishenev force-pushed the 2763-reorganize-tabs branch from 6f9f6f1 to d7a0317 Compare February 24, 2023 15:41

vmishenev merged commit 1040288 into master Feb 24, 2023

vmishenev deleted the 2763-reorganize-tabs branch February 24, 2023 15:44

IgnatBeresnev pushed a commit that referenced this pull request Feb 27, 2023

Reorganize tabs for Classlike (#2764)

605ce9e

(cherry picked from commit 1040288)

vmishenev mentioned this pull request Dec 6, 2023

Render member extensions correctly #3374

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Reorganize tabs for Classlike #2764

Reorganize tabs for Classlike #2764

vmishenev commented Dec 5, 2022 •

edited

Loading

IgnatBeresnev left a comment

IgnatBeresnev commented Jan 12, 2023

vmishenev commented Jan 13, 2023

IgnatBeresnev commented Jan 13, 2023 •

edited

Loading

vmishenev commented Jan 14, 2023

IgnatBeresnev left a comment

vmishenev commented Feb 21, 2023

IgnatBeresnev left a comment

IgnatBeresnev Feb 24, 2023

IgnatBeresnev Feb 24, 2023

vmishenev Feb 24, 2023

Reorganize tabs for Classlike #2764

Reorganize tabs for Classlike #2764

Conversation

vmishenev commented Dec 5, 2022 • edited Loading

IgnatBeresnev left a comment

Choose a reason for hiding this comment

IgnatBeresnev commented Jan 12, 2023

vmishenev commented Jan 13, 2023

IgnatBeresnev commented Jan 13, 2023 • edited Loading

vmishenev commented Jan 14, 2023

IgnatBeresnev left a comment

Choose a reason for hiding this comment

vmishenev commented Feb 21, 2023

IgnatBeresnev left a comment

Choose a reason for hiding this comment

IgnatBeresnev Feb 24, 2023

Choose a reason for hiding this comment

IgnatBeresnev Feb 24, 2023

Choose a reason for hiding this comment

vmishenev Feb 24, 2023

Choose a reason for hiding this comment

vmishenev commented Dec 5, 2022 •

edited

Loading

IgnatBeresnev commented Jan 13, 2023 •

edited

Loading