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

Generated package-level javadoc truncates all documentation after the first sentence. #2055

Closed
whbboyd opened this issue Aug 6, 2021 · 3 comments · Fixed by #2751
Closed
Labels
bug format: Javadoc An issue/PR related to Dokka's Javadoc output format or the Javadoc comments in general

Comments

@whbboyd
Copy link

whbboyd commented Aug 6, 2021

Describe the bug
Generated javadoc includes only the first sentence of package-level documentation on the package page. All package-level documentation after the first sentence is dropped, and does not appear anywhere in the generated javadoc.

Expected behaviour
The package page for a given package should include all the documentation written for that package.

Screenshots
From the reproduction example project, javadoc has only the first sentence of documentation:
screenshot
Compare the generated kotlindoc, which contains the entire package documentation:
screenshot

To Reproduce
Reproduction example project is at https://github.com/whbboyd/dokka-javadoc-bug

Installation

  • Operating system: Linux
  • Build tool: Maven 3.6.0/OpenJDK 11.0.12
  • Dokka version: 1.5.0 (also reproduced with 1.4.32)

Are you willing to provide a PR?
If I can be pointed to likely culprit code, I can take a crack at writing a PR.

@whbboyd whbboyd added the bug label Aug 6, 2021
@MarcinAman MarcinAman added the format: Javadoc An issue/PR related to Dokka's Javadoc output format or the Javadoc comments in general label Aug 9, 2021
@cptartur
Copy link

Any updates on this? Seems like this issue is still present as of Dokka 1.7.10, and the only solution seems to be not to use full stops at all in docs which is not ideal.

@Griefed
Copy link

Griefed commented Nov 14, 2022

I am experiencing the same problem.

Say I've got a package description along the lines of

# Package de.griefed.serverpackcreator.api.utilities.common

Common utilities used by various parts, projects, things, cheeseburgers. Mostly composed of smaller methods which are meant to do one and one thing only.

The resulting documentation would only include the following:

# Package de.griefed.serverpackcreator.api.utilities.common

Common utilities used by various parts, projects, things, cheeseburgers.

@IgnatBeresnev
Copy link
Member

IgnatBeresnev commented Nov 22, 2022

The fix will be shipped in the next release (1.8.0)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug format: Javadoc An issue/PR related to Dokka's Javadoc output format or the Javadoc comments in general
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants