Skip to content

Add support to reference a parameter name from scaladoc #12033

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

Closed
robstoll opened this issue Jun 9, 2020 · 4 comments
Closed

Add support to reference a parameter name from scaladoc #12033

robstoll opened this issue Jun 9, 2020 · 4 comments

Comments

@robstoll
Copy link

robstoll commented Jun 9, 2020

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?

@dwijnand
Copy link
Member

There very little activity around the Scaladoc tool these days, so this might get more traction if someone were to propose it to the team working on https://github.com/lampepfl/scala3doc.

@dwijnand dwijnand added this to the Backlog milestone Nov 18, 2020
@robstoll
Copy link
Author

I guess this will be fixed in scala3 if they still use dokka under the hood as there is a way in Kotlin and as far as I remember it was said, that it is also able to distinguish params and type params

@som-snytt
Copy link

Heads up, closing as out of scope for Scaladoc 2.

@som-snytt som-snytt closed this as not planned Won't fix, can't repro, duplicate, stale Apr 6, 2024
@robstoll
Copy link
Author

robstoll commented Apr 7, 2024

Fair enough, I hope it will be improved in scala 3 (although no longer based on dokka)

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

No branches or pull requests

4 participants