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

Support newer javadoc features #4067

Open
owengray-google opened this issue Mar 18, 2025 · 0 comments
Open

Support newer javadoc features #4067

owengray-google opened this issue Mar 18, 2025 · 0 comments
Labels

Comments

@owengray-google
Copy link
Contributor

owengray-google commented Mar 18, 2025

Describe the bug
As of java 16, the javadoc spec now supports an inline {@return <description} tag. This tag is used at the beginning of a description, and both renders as "Returns <description>" in primary documentation text, and also creates the Returns tag as though it also were a normal @returns <description>.
This inline form is used in some of our Google non-androidx clients, as only android is restricted to a low Java version.
It isn't understood by dokka, which renders it as a text literal.

It is likely that there may be other updates to the javadoc spec in versions of Java that Kotlin and/or Android aren't very interested in. The internal documentation page that describes inline return and when it was added does not mention any other new javadoc spec, but I don't expect it to be comprehensive. I'm not sure what the best way to find newly-added javadoc spec would be.

Expected behaviour
Inline {@return } javadoc tags work.
(As do any other recently-added javadoc features)

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

No branches or pull requests

1 participant