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

Add JavaDocs to website #27

Open
wborn opened this issue Nov 28, 2024 · 0 comments
Open

Add JavaDocs to website #27

wborn opened this issue Nov 28, 2024 · 0 comments

Comments

@wborn
Copy link
Member

wborn commented Nov 28, 2024

Currently the documentation links to https://www.javadoc.io/doc/io.openremote for browsing the JavaDocs.

Integrating the JavaDocs into the documentation website would solve the following:

  • The JavaDocs keep working when www.javadoc.io stops working
  • It will allow for showing JavaDocs of unreleased versions
  • It makes it possible to style the JavaDocs so they are more integrated with the other documentation
  • It will be easier to navigate to the JavaDocs of the selected OpenRemote version when the documentation is versioned

We could also have a look at using Dokka for generating JavaDocs instead.
It generates more modern looking HTML and it can generate Markdown docs as well as documentation of Kotlin code (KDoc).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant