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.

Sign up for GitHub

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

Jump to bottom

Rule: Change kdoc comments, which are in inappropriate places to the block comments #828

Closed
kgevorkyan opened this issue Apr 9, 2021 · 1 comment · Fixed by #1350
Closed

Rule: Change kdoc comments, which are in inappropriate places to the block comments #828

kgevorkyan opened this issue Apr 9, 2021 · 1 comment · Fixed by #1350
Assignees
@icemachined
Labels
enhancement New feature or request good first issue Good for newcomers needed

Comments

@kgevorkyan
Copy link
Member

Usually, kdoc comments are used before descriptions of classes or functions.
Using them in code or in some statements is the bad practice.
We need to change them to the block comments, by removing extra *, for example
@kgevorkyan kgevorkyan added the enhancement New feature or request label Apr 9, 2021
@orchestr7 orchestr7 added good first issue Good for newcomers needed labels Apr 27, 2022
@orchestr7
Copy link
Member

orchestr7 commented May 27, 2022 •
edited
Loading

@nulls this issue you was talking about
@icemachined you can do this by checking the next Node after the Kdoc

icemachined added a commit that referenced this issue Jun 7, 2022
@icemachined
New Rule COMMENTS_BY_KDOC was implemented
93514e9 
### What's done:

* New Rule COMMENTS_BY_KDOC was added to check if code block contains kdoc comments
* and fix it by converting to block comment
* tests and docs were added
* Closes: #828
@icemachined icemachined mentioned this issue Jun 7, 2022
Merged
5 tasks
icemachined added a commit that referenced this issue Jun 7, 2022
@icemachined
New Rule COMMENTS_BY_KDOC was implemented
bb73b13 
### What's done:

* New Rule COMMENTS_BY_KDOC was added to check if code block contains kdoc comments
* and fix it by converting to block comment
* tests and docs were added
* Closes: #828
icemachined added a commit that referenced this issue Jun 14, 2022
@icemachined
New Rule COMMENTS_BY_KDOC was implemented (#1350)
48f0c3d 
* New Rule COMMENTS_BY_KDOC was implemented

### What's done:

* New Rule COMMENTS_BY_KDOC was added to check if code block contains kdoc comments
* and fix it by converting to block comment
* tests and docs were added
* Closes: #828
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@icemachined icemachined

Labels
enhancement New feature or request good first issue Good for newcomers needed
Projects
None yet
Milestone
No milestone
3 participants
@kgevorkyan @icemachined @orchestr7