Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Constructor-like functions are lost from functions list if they have the same decapitalized analog #2950

Closed
sandwwraith opened this issue Mar 30, 2023 · 5 comments
Labels
awaiting response An issue/PR that cannot be completed without additional information or a discussion bug feedback: Kotlin libs Feedback from Kotlin's internal libraries

Comments

@sandwwraith
Copy link
Member

Describe the bug
Sounds a bit hard to understand, so I'll show the example. In kotlinx.serialization, there is:

interface SerialDescriptorhttps://github.com/Kotlin/kotlinx.serialization/blob/60c632c970d7da02151fd7c920f40ebc269c0f29/core/commonMain/src/kotlinx/serialization/descriptors/SerialDescriptor.kt#L146

public fun SerialDescriptorhttps://github.com/Kotlin/kotlinx.serialization/blob/ccf9c2c52cd9df10e3782f9f8a02ff4172c4b868/core/commonMain/src/kotlinx/serialization/descriptors/SerialDescriptors.kt#L116

public inline fun <reified T> serialDescriptor()(2 overloads) — https://github.com/Kotlin/kotlinx.serialization/blob/ccf9c2c52cd9df10e3782f9f8a02ff4172c4b868/core/commonMain/src/kotlinx/serialization/descriptors/SerialDescriptors.kt#L153

However, on the https://kotlinlang.org/api/kotlinx.serialization/kotlinx-serialization-core/kotlinx.serialization.descriptors/ page we can see only interface SerialDescriptor on Types tab, and Functions tab with lowercase names (despite function itself in the table named as SerialDescriptor:

image

There is, however, page for fun SerialDescriptor: https://kotlinlang.org/api/kotlinx.serialization/kotlinx-serialization-core/kotlinx.serialization.descriptors/-serial-descriptor.html
and it is clickable from sidebar:

image

Expected behaviour
fun SerialDescriptor is also listed on the Functions tab

Installation

  • Dokka version: 1.7.0

Additional context
Website is build on teamcity

@IgnatBeresnev IgnatBeresnev added the feedback: Kotlin libs Feedback from Kotlin's internal libraries label Apr 6, 2023
@IgnatBeresnev
Copy link
Member

This might've been "fixed" in the recent versions of Dokka, either in #2846 or in #2861.

This is how it currently looks if you open the "Functions" tab of the package, would this behaviour be acceptable?

2023-04-06_22-18-57

@sandwwraith
Copy link
Member Author

Yes, this looks OK. Is this a build on your machine? What version of Dokka should I update to?

@IgnatBeresnev IgnatBeresnev added the awaiting response An issue/PR that cannot be completed without additional information or a discussion label Apr 17, 2023
@IgnatBeresnev
Copy link
Member

@sandwwraith the fixes should be present in Dokka 1.8.10

I'll close the issue once Dokka is updated in kotlinx.serialization, tagging it as "awaiting response" to not forget

@IgnatBeresnev
Copy link
Member

IgnatBeresnev commented Apr 21, 2023

@sandwwraith the API reference for serialization has been updated, can you please have a look and confirm that we can close the issue?

@sandwwraith
Copy link
Member Author

It has all functions now, thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
awaiting response An issue/PR that cannot be completed without additional information or a discussion bug feedback: Kotlin libs Feedback from Kotlin's internal libraries
Projects
None yet
Development

No branches or pull requests

2 participants