Skip to content

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

@whbboyd

Description

@whbboyd

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugformat: JavadocAn issue/PR related to Dokka's Javadoc output format or the Javadoc comments in general

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions