Skip to content

Add support to reference a parameter name from scaladoc #12033

Closed as not planned
@robstoll

Description

@robstoll

As far as I know the current recommendation to refer to parameter names is using {@code ...}.
IMO it would be beneficial if one can refer to a parameter (or a type parameter) using an own syntax.
For instance, could be [(param)] and [{tparam}] or {@parameref } and {@tparamref }

This way, I assume, IDEs would pick it up and include it in renamings. Certain IDEs support replacement of a text within scaladoc but if you use something like expected as parameter name, you end up checking each suggestion as it could also be wrong. An own syntax would help here as well.

Thoughts?

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions