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

[K2] Inconsistent KDoc link into inhertited documentation #3639

Open
vmishenev opened this issue May 31, 2024 · 0 comments
Open

[K2] Inconsistent KDoc link into inhertited documentation #3639

vmishenev opened this issue May 31, 2024 · 0 comments
Labels
bug kdoc-spec An issue that requires clarification from the KDoc spec's perspective topic: K2 Issues / PRs that are related to the K2 migration. See #2888

Comments

@vmishenev
Copy link
Member

vmishenev commented May 31, 2024

    interface A {
        /**
         * [a]
         */
        fun foo(a: Int)
    }

    class B : A {
        override fun foo(a: Int) {
        }
    }

In the documentation of B.foo, the reference [a] leads to a parameter of A.foo.

In IDE and Dokka K1, it leads to a parameter of B.foo.

Also, there is the unit test

@vmishenev vmishenev added bug kdoc-spec An issue that requires clarification from the KDoc spec's perspective topic: K2 Issues / PRs that are related to the K2 migration. See #2888 labels May 31, 2024
@vmishenev vmishenev changed the title [K2] Incorrect KDoc link into inhertited documentation [K2] Inconsistent KDoc link into inhertited documentation May 31, 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 topic: K2 Issues / PRs that are related to the K2 migration. See #2888
Projects
None yet
Development

No branches or pull requests

1 participant