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 to a package #3455

Open
vmishenev opened this issue Jan 18, 2024 · 2 comments
Open

KDoc links to a package #3455

vmishenev opened this issue Jan 18, 2024 · 2 comments
Labels
bug kdoc-spec An issue that requires clarification from the KDoc spec's perspective

Comments

@vmishenev
Copy link
Member

vmishenev commented Jan 18, 2024

package example

/**
* ref to  [example]
*/
fun x(){}

It works in IDEA K1/K2 and Dokka K1/K2.

@vmishenev vmishenev added bug topic: K2 Issues / PRs that are related to the K2 migration. See #2888 labels Jan 18, 2024
@IgnatBeresnev
Copy link
Member

Related: #3004

@IgnatBeresnev IgnatBeresnev added the kdoc-spec An issue that requires clarification from the KDoc spec's perspective label Jan 19, 2024
@IgnatBeresnev
Copy link
Member

I've added the kdoc-spec tag since the documentation on kotlinlang doesn't say that links can lead to packages.

To link to another element (class, method, property, or parameter), simply put its name in square brackets

Given that linking to packages seems logical, it already works in K2 and the fix in K1 is trivial, it makes sense increase the priority of this kdoc spec question.

If we decide that links to packages are acceptable, the documentation on kotlinlang needs to be updated.

@vmishenev vmishenev changed the title [K1] KDoc links to a package are unresolved KDoc links to a package Mar 27, 2024
@vmishenev vmishenev removed their assignment May 10, 2024
@vmishenev vmishenev removed the topic: K2 Issues / PRs that are related to the K2 migration. See #2888 label May 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug kdoc-spec An issue that requires clarification from the KDoc spec's perspective
Projects
None yet
Development

No branches or pull requests

2 participants