Skip to content

[Javadoc] Consider using Dokka HTML docs instead for Javadoc artifact #25

@EdricChan03

Description

@EdricChan03

Is there an existing issue for this?

  • I have searched the existing issues

Library name

All

Library version

All

What happened?

It appears that Dokka's HTML format renders just fine if used as a "Javadoc" source - not sure if this is used internally for IntelliJ's quick documentation, but trying to open a Javadoc of for example the kotlin-logging library seems to work just fine.

Expected behaviour

No response

Reproduction steps

  1. Open the javadoc jar file for say, common-enums-jvm
  2. Note that the Javadoc-style format is used, instead of Dokka's HTML format

Relevant log output

No response

Possible solution

Switch to publishing 100% Dokka HTML docs, not sure if there'll be any unforeseen issues though

Additional context

While browsing the Javadocs for kotlin-logging, I noticed that they're using Dokka HTML docs and that it shows up just fine on https://javadoc.io

Metadata

Metadata

Assignees

No one assigned

    Labels

    ciContinuous Integration issuesdocumentationImprovements or additions to documentationenhancementNew feature or request

    Projects

    Status

    🆕 New

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions