We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
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
When documenting a type parameter in Kdoc, the only correct way to do it is using the @param tag, for example:
@param
/** * @param T the target type to return */ fun <T> genericFunc(): T
Unfortunately Diktat reports:
[KDOC_WITHOUT_PARAM_TAG] all methods which take arguments should have @param tags in KDoc: T param isn't present in argument list
Which I believe is a wrong behavior, given that it's taking into consideration the formal parameters only.
Diktat should not report a violation for the above example.
Diktat reports a KDOC_WITHOUT_PARAM_TAG
The text was updated successfully, but these errors were encountered:
No branches or pull requests
Describe the bug
When documenting a type parameter in Kdoc, the only correct way to do it is using the
@param
tag, for example:Unfortunately Diktat reports:
Which I believe is a wrong behavior, given that it's taking into consideration the formal parameters only.
Expected behavior
Diktat should not report a violation for the above example.
Observed behavior
Diktat reports a KDOC_WITHOUT_PARAM_TAG
Environment information
The text was updated successfully, but these errors were encountered: