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 #1754

Merged
merged 30 commits into from
Oct 16, 2023
Merged

Commits on Sep 28, 2023

  1. Fixed KdocComments

    ### What's done:
    - Added non-fixed warning `KDOC_EXTRA_PROPERTY` for case when `private` or `override` property has `@property` tag in class-KDoc.
    - Removed fixed warning `KDOC_NO_CONSTRUCTOR_PROPERTY` for case when `override` property  hasn't `@property` tag in class-KDoc.
    - Added non-fixed warning `KDOC_NO_CONSTRUCTOR_PROPERTY_WITH_COMMENT` for case when `private` or `override` property has comment before.
    - Changed warning `KDOC_NO_CONSTRUCTOR_PROPERTY` to `KDOC_NO_CONSTRUCTOR_PROPERTY_WITH_COMMENT` for case when non-`private` and non-`override` property has comment before.
    - Added check is warning `KDOC_NO_CONSTRUCTOR_PROPERTY_WITH_COMMENT` fixable for case when non-`private` and non-`override` property has tags in KDoc-comment before. If it has = non-fixed.
    - Fixed case when text from comment before non-`private` and non-`override` property didn't append to the end of `@property` text in class-KDoc for that property.
    - Fixed case when `@property` text in class-KDoc didn't create for KDoc-comment before non-`private` and non-`override` property.
    - Fixed functions `removeWithWhiteSpace` and `removeChildMergingSurroundingWhitespaces` for additional handling KDoc-comments.
    - Reworked fix tests. Added fix test for case when `@property` tag exist in class-KDoc.
    - Added warning tests.
    
    It's part of saveourtool#1737
    DrAlexD committed Sep 28, 2023
    Configuration menu
    Copy the full SHA
    37edc00 View commit details
    Browse the repository at this point in the history
  2. Configuration menu
    Copy the full SHA
    fc88b09 View commit details
    Browse the repository at this point in the history
  3. - fix

    DrAlexD committed Sep 28, 2023
    Configuration menu
    Copy the full SHA
    c1ebe74 View commit details
    Browse the repository at this point in the history
  4. Merge branch 'feature/fix-kdoc-comments' of https://github.com/DrAlex…

    …D/diktat into feature/fix-kdoc-comments
    
    # Conflicts:
    #	diktat-rules/src/main/kotlin/com/saveourtool/diktat/ruleset/rules/chapter2/kdoc/KdocComments.kt
    DrAlexD committed Sep 28, 2023
    Configuration menu
    Copy the full SHA
    d5e31fa View commit details
    Browse the repository at this point in the history
  5. - fix

    DrAlexD committed Sep 28, 2023
    Configuration menu
    Copy the full SHA
    bdef44b View commit details
    Browse the repository at this point in the history
  6. - fix

    DrAlexD committed Sep 28, 2023
    Configuration menu
    Copy the full SHA
    382736a View commit details
    Browse the repository at this point in the history

Commits on Oct 2, 2023

  1. - fixed case when @Property text in class-KDoc didn't create for KDoc…

    …-comment before private and override property
    
    - fixed case when there wasn't empty line after class-Kdoc description and before any tag
    - fixed case when indentation wasn't created before content of new line if tag block cannot be described in one line
    DrAlexD committed Oct 2, 2023
    Configuration menu
    Copy the full SHA
    d01ba9e View commit details
    Browse the repository at this point in the history
  2. - fix

    DrAlexD committed Oct 2, 2023
    Configuration menu
    Copy the full SHA
    96e3c8f View commit details
    Browse the repository at this point in the history
  3. - fix

    DrAlexD committed Oct 2, 2023
    Configuration menu
    Copy the full SHA
    96a271c View commit details
    Browse the repository at this point in the history
  4. - fix affected classes

    DrAlexD committed Oct 2, 2023
    Configuration menu
    Copy the full SHA
    a10486b View commit details
    Browse the repository at this point in the history
  5. - fix affected classes

    DrAlexD committed Oct 2, 2023
    Configuration menu
    Copy the full SHA
    88f429f View commit details
    Browse the repository at this point in the history
  6. Configuration menu
    Copy the full SHA
    8c4d75c View commit details
    Browse the repository at this point in the history

Commits on Oct 9, 2023

  1. Configuration menu
    Copy the full SHA
    27fb72f View commit details
    Browse the repository at this point in the history
  2. Configuration menu
    Copy the full SHA
    7a85200 View commit details
    Browse the repository at this point in the history
  3. - added non-fixed warning KDOC_EXTRA_PROPERTY for redundant `@param…

    …` tags in class-KDoc
    
    - added fixed warnings `KDOC_NO_CONSTRUCTOR_PROPERTY` and `KDOC_NO_CONSTRUCTOR_PROPERTY_WITH_COMMENT` due to `private` properties and parameters must have `@param` tags in class-KDoc
    DrAlexD committed Oct 9, 2023
    Configuration menu
    Copy the full SHA
    19e59ff View commit details
    Browse the repository at this point in the history
  4. Configuration menu
    Copy the full SHA
    eec619c View commit details
    Browse the repository at this point in the history
  5. - fix

    DrAlexD committed Oct 9, 2023
    Configuration menu
    Copy the full SHA
    77fc1ba View commit details
    Browse the repository at this point in the history
  6. - fix

    DrAlexD committed Oct 9, 2023
    Configuration menu
    Copy the full SHA
    2e180cb View commit details
    Browse the repository at this point in the history
  7. - fix

    DrAlexD committed Oct 9, 2023
    Configuration menu
    Copy the full SHA
    67d18fa View commit details
    Browse the repository at this point in the history

Commits on Oct 10, 2023

  1. - fix

    DrAlexD committed Oct 10, 2023
    Configuration menu
    Copy the full SHA
    43fadfc View commit details
    Browse the repository at this point in the history
  2. - fix

    DrAlexD committed Oct 10, 2023
    Configuration menu
    Copy the full SHA
    d16ad71 View commit details
    Browse the repository at this point in the history
  3. - fix

    DrAlexD committed Oct 10, 2023
    Configuration menu
    Copy the full SHA
    78d8012 View commit details
    Browse the repository at this point in the history

Commits on Oct 11, 2023

  1. - added configuration for @param tags creation: `isParamTagsForPara…

    …meters` and `isParamTagsForPrivateProperties`
    
    - fix affected classes
    DrAlexD committed Oct 11, 2023
    Configuration menu
    Copy the full SHA
    62c5bd3 View commit details
    Browse the repository at this point in the history
  2. - fix

    DrAlexD committed Oct 11, 2023
    Configuration menu
    Copy the full SHA
    91016b9 View commit details
    Browse the repository at this point in the history
  3. - fix

    DrAlexD committed Oct 11, 2023
    Configuration menu
    Copy the full SHA
    b7ba451 View commit details
    Browse the repository at this point in the history

Commits on Oct 12, 2023

  1. - fix docs

    DrAlexD committed Oct 12, 2023
    Configuration menu
    Copy the full SHA
    5cfbb44 View commit details
    Browse the repository at this point in the history
  2. - fix docs

    DrAlexD committed Oct 12, 2023
    Configuration menu
    Copy the full SHA
    62bf445 View commit details
    Browse the repository at this point in the history

Commits on Oct 16, 2023

  1. - fix docs

    DrAlexD committed Oct 16, 2023
    Configuration menu
    Copy the full SHA
    e986c4d View commit details
    Browse the repository at this point in the history
  2. - fix

    DrAlexD committed Oct 16, 2023
    Configuration menu
    Copy the full SHA
    275e45c View commit details
    Browse the repository at this point in the history
  3. Configuration menu
    Copy the full SHA
    b03af2c View commit details
    Browse the repository at this point in the history