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

[Dokka 2] Table header rendered as empty #3901

Open
MGaetan89 opened this issue Nov 5, 2024 · 4 comments
Open

[Dokka 2] Table header rendered as empty #3901

MGaetan89 opened this issue Nov 5, 2024 · 4 comments
Labels

Comments

@MGaetan89
Copy link
Contributor

MGaetan89 commented Nov 5, 2024

Describe the bug

If I use a table in my documentation (both code documentation and included files), the header is displayed as empty.

Expected behaviour

The header of the table is displayed.

Screenshots

Screenshot 2024-11-05 at 11 14 39 Screenshot 2024-11-05 at 11 15 14

To Reproduce

The screenshots above were generated with the following documentation:

/**
 * | Column A | Column B | Column C |
 * |-----|-----|-----|
 * | Cell 1 | Cell 2 | Cell 3 |
 * | Cell 4 | Cell 5 | Cell 6 |
 */

Installation

  • Operating system: macOS 15.1
  • Build tool: Gradle v8.10.2
  • Dokka version: 2.0.0-Beta

Dokka configuration

https://github.com/SRGSSR/pillarbox-android/blob/4a3ae5e3df1dc7ba041e1f91ad3164e3d022ff28/build.gradle.kts#L20-L37

https://github.com/SRGSSR/pillarbox-android/blob/4a3ae5e3df1dc7ba041e1f91ad3164e3d022ff28/build-logic/plugins/src/main/java/ch/srgssr/pillarbox/gradle/PillarboxAndroidLibraryPublishingPlugin.kt#L89-L114

@MGaetan89 MGaetan89 added the bug label Nov 5, 2024
@adam-enko
Copy link
Member

Hi, could you provide the full code block you're using? I've tried it quickly and with the following code:

/**
 * | Column A | Column B | Column C |
 * |-----|-----|-----|
 * | Cell 1 | Cell 2 | Cell 3 |
 * | Cell 4 | Cell 5 | Cell 6 |
 */
val asd = ""
image

So, I wonder if there's something specific about how the KDoc is declared that is causing the issue. I see an enum in your screenshot, maybe that's related

@MGaetan89
Copy link
Contributor Author

MGaetan89 commented Nov 5, 2024

That was the whole KDoc. I just tried on an interface, a field and a method:
Screenshot 2024-11-05 at 16 00 44

With the same result:
Screenshot 2024-11-05 at 15 58 56

Screenshot 2024-11-05 at 15 59 04 Screenshot 2024-11-05 at 15 59 12

I've added my Dokka configuration in my first message, in case it helps.

@whyoleg
Copy link
Collaborator

whyoleg commented Nov 14, 2024

Hey!
I also can't reproduce the original issue, and always see table header, no matter where I will put it.
If it's reproduced in your project, could you please share the link to the class where it could be reproduced or as a separate GitHub project?

@MGaetan89
Copy link
Contributor Author

MGaetan89 commented Nov 14, 2024

You can check out the following project: https://github.com/SRGSSR/pillarbox-android on the dokka_table_demo branch.

I've added a table in the PillarboxPlayer interface.

If you run ./gradlew :dokkaGenerate and open this page, you'll see that the table doesn't have any header.


The global Dokka configuration is available here:
https://github.com/SRGSSR/pillarbox-android/blob/b69923e324f941c2380f799d6101e77cc5e07654/build.gradle.kts#L20-L45

And we have a Gradle plugin for per-module configuration:
https://github.com/SRGSSR/pillarbox-android/blob/b69923e324f941c2380f799d6101e77cc5e07654/build-logic/plugins/src/main/java/ch/srgssr/pillarbox/gradle/PillarboxAndroidLibraryPublishingPlugin.kt#L89-L130


Let me know if you need help to set up the project, or to reproduce the issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants