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

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

Open
1 task done
EdricChan03 opened this issue Dec 21, 2023 · 0 comments
Open
1 task done
Labels
ci Continuous Integration issues documentation Improvements or additions to documentation enhancement New feature or request

Comments

@EdricChan03
Copy link
Owner

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

@EdricChan03 EdricChan03 added documentation Improvements or additions to documentation enhancement New feature or request ci Continuous Integration issues labels Dec 21, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ci Continuous Integration issues documentation Improvements or additions to documentation enhancement New feature or request
Projects
Status: 🆕 New
Development

No branches or pull requests

1 participant