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.

Sign up for GitHub

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

Jump to bottom

JavaDoc on docs.enola.dev #491

Open
vorburger opened this issue Feb 17, 2024 · 3 comments
Open

JavaDoc on docs.enola.dev #491

vorburger opened this issue Feb 17, 2024 · 3 comments
Labels
build Build, CI, etc. (w.o. #testing) distro Distribution related documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed

Comments

@vorburger
Copy link
Member

https://docs.enola.dev/dev/java/javadocs

Like this?
@vorburger vorburger added documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed good first issue Good for newcomers build Build, CI, etc. (w.o. #testing) distro Distribution related labels Feb 17, 2024
@vorburger
Copy link
Member Author

vorburger commented Oct 6, 2024 •
edited
Loading

https://openjdk.org/jeps/467 Write JavaDoc as Markdown instead of HTML!

@vorburger vorburger mentioned this issue Dec 28, 2024
Open
@vorburger
Copy link
Member Author

vorburger commented Dec 29, 2024 •
edited
Loading

Like this?

That actually uses javadoc.bzl from https://github.com/google/bazel-common...

https://bazel.build/versions/8.0.0/reference/be/java does not have any JavaDoc?

https://github.com/bazel-contrib/rules_jvm_external/blob/master/docs/api.md#javadoc is the way to go, it seems.

But in #970 I've found that java_export that actually also runs javadoc - except that it fails. I'll temporarily use tags = ["no-javadocs"] there, and when I pick this up, dig into fixing that.

@vorburger vorburger mentioned this issue Dec 29, 2024
Open
@vorburger
Copy link
Member Author

Inspiration: https://jstach.io/rainbowgum/#faq_javadoc is a cool 💡 idea..

It would be neat to have JBang examples on the Javadoc of each package.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
build Build, CI, etc. (w.o. #testing) distro Distribution related documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@vorburger