You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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?
The text was updated successfully, but these errors were encountered:
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.
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
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?
The text was updated successfully, but these errors were encountered: