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

Fixed KdocComments and KdocFormatting #1892

Open
wants to merge 9 commits into
base: master
Choose a base branch
from

Conversation

DrAlexD
Copy link
Member

@DrAlexD DrAlexD commented Dec 22, 2023

What's done:

  • Made refactoring in KdocComments.
  • Added fix test for case when there is class description and some properties in class KDoc at the same time.
  • Fixed bug in KdocFormatting for case when @property and @constructor basic tags haven't empty line before them.
  • Modified fix test for case when there is class description before @property tag.
  • Added smoke test for class KDoc. Currently disabled due to Empty lines in class constructor before properties with comments #1889.

Closes #1884

Copy link

codecov bot commented Dec 22, 2023

Codecov Report

Attention: Patch coverage is 94.11765% with 3 lines in your changes missing coverage. Please review.

Project coverage is 76.82%. Comparing base (f63b045) to head (24166ca).

Files Patch % Lines
...diktat/ruleset/rules/chapter2/kdoc/KdocComments.kt 94.59% 0 Missing and 2 partials ⚠️
...ktat/ruleset/rules/chapter2/kdoc/KdocFormatting.kt 85.71% 0 Missing and 1 partial ⚠️
Additional details and impacted files
@@             Coverage Diff              @@
##             master    #1892      +/-   ##
============================================
+ Coverage     76.79%   76.82%   +0.03%     
+ Complexity     2492     2476      -16     
============================================
  Files           134      134              
  Lines          7898     7883      -15     
  Branches       2240     2230      -10     
============================================
- Hits           6065     6056       -9     
+ Misses          828      826       -2     
+ Partials       1005     1001       -4     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Contributor

github-actions bot commented Dec 22, 2023

JUnit Tests (Windows, EnricoMi/publish-unit-test-result-action@v2)

  167 files  ±0    167 suites  ±0   7m 19s ⏱️ -39s
1 449 tests +3  1 430 ✅ +1  19 💤 +2  0 ❌ ±0 
2 829 runs  +3  2 810 ✅ +1  19 💤 +2  0 ❌ ±0 

Results for commit 24166ca. ± Comparison against base commit f63b045.

♻️ This comment has been updated with latest results.

Copy link
Contributor

github-actions bot commented Dec 22, 2023

JUnit Tests (macOS, EnricoMi/publish-unit-test-result-action@v2)

  167 files  ±0    167 suites  ±0   2m 49s ⏱️ -54s
1 449 tests +3  1 408 ✅ +1  41 💤 +2  0 ❌ ±0 
2 829 runs  +3  2 788 ✅ +1  41 💤 +2  0 ❌ ±0 

Results for commit 24166ca. ± Comparison against base commit f63b045.

♻️ This comment has been updated with latest results.

@DrAlexD DrAlexD self-assigned this Dec 22, 2023
@DrAlexD DrAlexD added the bug Something isn't working label Dec 22, 2023
@DrAlexD DrAlexD added this to the 2.1.0 milestone Dec 22, 2023
Copy link
Member

@orchestr7 orchestr7 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I do not understand how 90% of refactoring work, but basically there are a lot of tests, so I believe in you :)

…ugfix/kdoc_formatting

# Conflicts:
#	diktat-cli/src/test/kotlin/com/saveourtool/diktat/smoke/DiktatSmokeTestBase.kt
@DrAlexD DrAlexD removed the request for review from diphtongue June 20, 2024 11:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

KDOC_NEWLINES_BEFORE_BASIC_TAGS is not fixing a newline problem from the first run
3 participants