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

KDoc links based on type parameters #3756

Open
whyoleg opened this issue Aug 21, 2024 · 0 comments
Open

KDoc links based on type parameters #3756

whyoleg opened this issue Aug 21, 2024 · 0 comments
Labels
kdoc-spec An issue that requires clarification from the KDoc spec's perspective

Comments

@whyoleg
Copy link
Collaborator

whyoleg commented Aug 21, 2024

On current moment nor KDoc specify this is possible or not, nor IDE or Dokka resolves cases like this:

/**
 * [T.toInt] - unresolved
 * [T.hashCode] - unresolved
 */
class Storage<T: Number>

While Javadoc allows such usages:

/**
 * {@link T#intValue()} - resolved
 * <p>
 * {@link T#hashCode()} - resolved
 */
public class Storage<T extends Number> {}

and produces following result:

image

We need to decide at some point if there are good use cases for such syntax.

@whyoleg whyoleg added the kdoc-spec An issue that requires clarification from the KDoc spec's perspective label Aug 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kdoc-spec An issue that requires clarification from the KDoc spec's perspective
Projects
None yet
Development

No branches or pull requests

1 participant