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

How to show full property description instead abridged one on class page? #3975

Open
Rubydesic opened this issue Dec 22, 2024 · 2 comments
Open
Labels
format: html An issue/PR related to Dokka's default HTML output format question A user question, can be resolved if the question is answered/resolved

Comments

@Rubydesic
Copy link

Question
Dokka only shows an abridged description of the property on the documentation page for the class that contains it. How can I configure it to show the full description?

Screenshots
The class page shows an abridged description of the property:
image

The full description of the property:
image

Installation

  • Operating system: Windows
  • Build tool: Gradle
  • Dokka version: 2.0.0
@Rubydesic Rubydesic added the question A user question, can be resolved if the question is answered/resolved label Dec 22, 2024
@vmishenev
Copy link
Contributor

According to the description of KDoc, Dokka displays only the first paragraph of the documentation text (the block of text until the first blank line) for members on a class page.
There is no way to display the full documentation for members.

Could you elaborate on your use case? Do you want to show the full documentation for all members (properties/functions)? Do you not need their dedicated pages?"

@Rubydesic
Copy link
Author

Yes, I want to show the full documentation for all members and not have dedicated pages. In a Javadoc, for example, one can read the full documentation for each member without needing to click on links.

In my opinion, requiring the reader to click on links to see each member's information makes the documentation annoying to read and reduces discoverability.

@whyoleg whyoleg added the format: html An issue/PR related to Dokka's default HTML output format label Jan 14, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
format: html An issue/PR related to Dokka's default HTML output format question A user question, can be resolved if the question is answered/resolved
Projects
None yet
Development

No branches or pull requests

3 participants