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

Feature request: when a kdoc consists only of @see, copy it. #202

Open
mikehearn opened this issue Aug 16, 2017 · 1 comment
Open

Feature request: when a kdoc consists only of @see, copy it. #202

mikehearn opened this issue Aug 16, 2017 · 1 comment
Labels
enhancement An issue for a feature or an overall improvement kdoc-spec An issue that requires clarification from the KDoc spec's perspective

Comments

@mikehearn
Copy link
Contributor

A KDoc comment like /** see [bar] */ could simply use the docs for bar for this specific item. If the thing being documented is also called [bar] it could find the first overload that has non-@see docs and use that. This would make documenting methods that are minor variants of other methods easier.

@xeruf
Copy link

xeruf commented Jul 25, 2019

YES! I would love this! Often you create util methods that just bridge to another original method.

@kamildoleglo kamildoleglo added the enhancement An issue for a feature or an overall improvement label Aug 27, 2019
@Kordyjan Kordyjan added this to the Post-Stable milestone Sep 1, 2020
@IgnatBeresnev IgnatBeresnev added the kdoc-spec An issue that requires clarification from the KDoc spec's perspective label Apr 27, 2022
@IgnatBeresnev IgnatBeresnev removed this from the Backlog milestone Aug 22, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement An issue for a feature or an overall improvement kdoc-spec An issue that requires clarification from the KDoc spec's perspective
Projects
None yet
Development

No branches or pull requests

5 participants