dokka icon indicating copy to clipboard operation
dokka copied to clipboard

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

Open whbboyd opened this issue 4 years ago • 1 comments

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 avatar Aug 06 '21 15:08 whbboyd

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.

cptartur avatar Sep 26 '22 10:09 cptartur

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.

Griefed avatar Nov 14 '22 17:11 Griefed

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

IgnatBeresnev avatar Nov 22 '22 21:11 IgnatBeresnev