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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Should @return be displayed "Returns" in generated docs? #3534

Open
martinbonnin opened this issue Mar 18, 2024 · 0 comments
Open

Should @return be displayed "Returns" in generated docs? #3534

martinbonnin opened this issue Mar 18, 2024 · 0 comments
Labels
question A user question, can be resolved if the question is answered/resolved

Comments

@martinbonnin
Copy link
Contributor

martinbonnin commented Mar 18, 2024

Hi 馃憢

Somewhat of a bikeshedding/OCD question but I noticed Dokka displays "Return" for @return tags when Java uses "Returns" (example)

This is inconsistent with using the 3rd person for method descriptions like used in the KDoc syntax page:

class Group<T>(val name: String) {
    /**
     * Adds a [member] to this group.
     * @return the new size of the group.
     */
    fun add(member: T): Int { ... }
}

The above will display Adds for the method description but Return for the @return tag which is a bit weird (example here):

Screenshot 2024-03-18 at 11 56 03

Could @return be displayed "Returns"?

@martinbonnin martinbonnin added the question A user question, can be resolved if the question is answered/resolved label Mar 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
question A user question, can be resolved if the question is answered/resolved
Projects
None yet
Development

No branches or pull requests

1 participant