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] Non-existent parameter from KDoc doesn't appear on the implicit primary constructor page #3348

Open
atyrin opened this issue Nov 15, 2023 · 5 comments
Assignees
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

@atyrin
Copy link
Contributor

atyrin commented Nov 15, 2023

/**
 * @param [paramInt] integer param
 * @param [paramStr] string param
 */
class ClassKDocLocation {
}

In K1, the constructor page looks like this:

image

For K2:
image


But if I change the class signature to:

/**
 * @param [paramInt] integer param
 * @param [paramStr] string param
 */
class ClassKDocLocation() {
}

the K2 output will be the same.

Installation

  • Dokka version: 1.9.20

Parent: #3328

@atyrin atyrin added the bug label Nov 15, 2023
@IgnatBeresnev IgnatBeresnev added the topic: K2 Issues / PRs that are related to the K2 migration. See #2888 label Nov 15, 2023
@vmishenev
Copy link
Member

Is this actual only for nonexistent parameters?

@atyrin
Copy link
Contributor Author

atyrin commented Nov 15, 2023

Should be. If there is a parameter, then it works. The issue is only for implicit constructors.

@IgnatBeresnev IgnatBeresnev added the kdoc-spec An issue that requires clarification from the KDoc spec's perspective label Dec 8, 2023
@IgnatBeresnev
Copy link
Member

The correct behaviour is not defined anywhere, so I've added the kdoc-spec for future reference.

@IgnatBeresnev
Copy link
Member

IgnatBeresnev commented Dec 20, 2023

Should add a warning about unresolved links in params, and keep K2's behaviour.

Consider adding additional information to the log that the behaviour in K2 is different than K1. Or mention it in release notes.

Blocking:

  • Testing: no
  • Beta: yes

@vmishenev vmishenev changed the title [K2] Parameter from KDoc doesn't appear on the implicit primary constructor page [K2] Non-existent parameter from KDoc doesn't appear on the implicit primary constructor page Jan 13, 2024
@whyoleg whyoleg self-assigned this May 15, 2024
@whyoleg
Copy link
Collaborator

whyoleg commented Aug 23, 2024

Current state: the only place where we miss unresolved parameters with K2 analysis is when we have implicit primary constructor.
Also, in all cases of unresolved parameters we log them as unresolved link with K2.

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

4 participants