EdricChan03 / EdricChan03/androidx-ktx-extras
[Javadoc] Consider using Dokka HTML docs instead for Javadoc artifact
- Dominant language
- Kotlin
- Stars
- 1
- Forks
- 1
- PR merge metrics
- No merged PRs in 30d
Description
### Is there an existing issue for this?
- [X] I have searched the existing issues
### Library name
All
### Library version
All
### What happened?
It appears that [Dokka's HTML format](https://kotlinlang.org/docs/dokka-html.html) 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](https://javadoc.io/doc/io.github.oshai/kotlin-logging-jvm/latest/kotlin-logging/io.github.oshai.kotlinlogging/index.html) seems to work just fine.
### Expected behaviour
_No response_
### Reproduction steps
1. [Open the javadoc jar file for say, `common-enums-jvm`](https://javadoc.io/doc/io.github.edricchan03.androidx.common/common-enums-jvm/latest/index.html)
2. Note that the [Javadoc-style format](https://kotlinlang.org/docs/dokka-javadoc.html) is used, instead of [Dokka's HTML format](https://kotlinlang.org/docs/dokka-html.html)
### 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
Contributor guide
No contributing guide indexed for this repository
Assessment
This issue has not been assessed yet.