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

JavadocVariable: new property 'accessModifiers' as substitution of 'scope' and 'excludeScope' #9280

Closed
romani opened this issue Feb 15, 2021 · 8 comments · Fixed by #16049
Closed

Comments

@romani
Copy link
Member

romani commented Feb 15, 2021

JavadocVariable - https://checkstyle.org/config_javadoc.html#JavadocVariable
https://checkstyle.org/checks/javadoc/javadocvariable.html#JavadocVariable

Example of user confusion and problem with such type - #3183

have have issues with Scope enumeration
we should switch to AccessModifier here like we did for ParameterNameCheck.
New property need t be created as substitution to 2 old properties.
https://checkstyle.org/property_types.html#AccessModifierOption.5B.5D
https://checkstyle.org/config_naming.html#ParameterName_Properties

TODO: after completion close #3183

local classes (named classes in methods or any other blocks) and antonymous classes should be skipped by Check for validation, see details at #13749


Migration notes:

    <module name="JavadocVariable">
       <property name="severity" value="warning"/>
-      <property name="scope" value="protected"/>
+      <property name="accessModifiers" value="protected"/>
     </module>

There might be few more violations, user needs to fix the or suppress.
Examples of migration:

@romani romani changed the title JavadocVariable: ugrate properties 'scope' and 'excludeScope' to use AccessModifierOption type instead of Scope JavadocVariable: upgrade property 'scope' to use AccessModifierOption type instead of Scope; remove property 'excludeScope' Feb 15, 2021
@romani romani changed the title JavadocVariable: upgrade property 'scope' to use AccessModifierOption type instead of Scope; remove property 'excludeScope' JavadocVariable: new property 'accessModifiers' as substitution of 'scope' and 'excludeScope' Feb 15, 2021
martin-mfg added a commit to martin-mfg/checkstyle that referenced this issue Feb 15, 2021
martin-mfg added a commit to martin-mfg/checkstyle that referenced this issue Feb 15, 2021
martin-mfg added a commit to martin-mfg/checkstyle that referenced this issue Apr 25, 2021
martin-mfg added a commit to martin-mfg/checkstyle that referenced this issue Apr 30, 2021
martin-mfg added a commit to martin-mfg/checkstyle that referenced this issue Apr 30, 2021
martin-mfg added a commit to martin-mfg/checkstyle that referenced this issue May 19, 2021
martin-mfg added a commit to martin-mfg/checkstyle that referenced this issue May 19, 2021
martin-mfg added a commit to martin-mfg/checkstyle that referenced this issue Jun 24, 2021
martin-mfg added a commit to martin-mfg/checkstyle that referenced this issue Jul 17, 2021
martin-mfg added a commit to martin-mfg/checkstyle that referenced this issue Jul 30, 2021
martin-mfg added a commit to martin-mfg/checkstyle that referenced this issue Aug 1, 2021
github-actions bot pushed a commit to martin-mfg/checkstyle that referenced this issue Aug 1, 2021
martin-mfg added a commit to martin-mfg/checkstyle that referenced this issue Aug 8, 2021
martin-mfg added a commit to martin-mfg/checkstyle that referenced this issue Aug 9, 2021
martin-mfg added a commit to martin-mfg/checkstyle that referenced this issue Aug 9, 2021
martin-mfg added a commit to martin-mfg/checkstyle that referenced this issue Aug 13, 2021
martin-mfg added a commit to martin-mfg/checkstyle that referenced this issue Aug 16, 2021
martin-mfg added a commit to martin-mfg/checkstyle that referenced this issue Aug 16, 2021
martin-mfg added a commit to martin-mfg/checkstyle that referenced this issue Aug 16, 2021
martin-mfg added a commit to martin-mfg/checkstyle that referenced this issue Sep 5, 2021
martin-mfg added a commit to martin-mfg/checkstyle that referenced this issue Sep 5, 2021
martin-mfg added a commit to martin-mfg/checkstyle that referenced this issue Sep 5, 2021
martin-mfg added a commit to martin-mfg/checkstyle that referenced this issue Sep 6, 2021
martin-mfg added a commit to martin-mfg/checkstyle that referenced this issue Sep 6, 2021
martin-mfg added a commit to martin-mfg/checkstyle that referenced this issue Sep 6, 2021
kkoutsilis added a commit to kkoutsilis/checkstyle that referenced this issue Feb 10, 2025
… of 'scope' and 'excludeScope' in JavadocVariableCheck
kkoutsilis added a commit to kkoutsilis/checkstyle that referenced this issue Feb 10, 2025
… of 'scope' and 'excludeScope' in JavadocVariableCheck
kkoutsilis added a commit to kkoutsilis/checkstyle that referenced this issue Feb 12, 2025
… of 'scope' and 'excludeScope' in JavadocVariableCheck
kkoutsilis added a commit to kkoutsilis/checkstyle that referenced this issue Feb 18, 2025
… of 'scope' and 'excludeScope' in JavadocVariableCheck
kkoutsilis added a commit to kkoutsilis/checkstyle that referenced this issue Feb 18, 2025
… of 'scope' and 'excludeScope' in JavadocVariableCheck
kkoutsilis added a commit to kkoutsilis/checkstyle that referenced this issue Feb 18, 2025
… of 'scope' and 'excludeScope' in JavadocVariableCheck
kkoutsilis added a commit to kkoutsilis/checkstyle that referenced this issue Feb 18, 2025
… of 'scope' and 'excludeScope' in JavadocVariableCheck
kkoutsilis added a commit to kkoutsilis/checkstyle that referenced this issue Feb 18, 2025
… of 'scope' and 'excludeScope' in JavadocVariableCheck
kkoutsilis added a commit to kkoutsilis/checkstyle that referenced this issue Feb 18, 2025
… of 'scope' and 'excludeScope' in JavadocVariableCheck
kkoutsilis added a commit to kkoutsilis/checkstyle that referenced this issue Feb 18, 2025
… of 'scope' and 'excludeScope' in JavadocVariableCheck
kkoutsilis added a commit to kkoutsilis/checkstyle that referenced this issue Feb 18, 2025
… of 'scope' and 'excludeScope' in JavadocVariableCheck
kkoutsilis added a commit to kkoutsilis/checkstyle that referenced this issue Feb 19, 2025
… of 'scope' and 'excludeScope' in JavadocVariableCheck
kkoutsilis added a commit to kkoutsilis/checkstyle that referenced this issue Feb 19, 2025
… of 'scope' and 'excludeScope' in JavadocVariableCheck
kkoutsilis added a commit to kkoutsilis/checkstyle that referenced this issue Feb 23, 2025
… of 'scope' and 'excludeScope' in JavadocVariableCheck
kkoutsilis added a commit to kkoutsilis/checkstyle that referenced this issue Feb 23, 2025
… of 'scope' and 'excludeScope' in JavadocVariableCheck
kkoutsilis added a commit to kkoutsilis/checkstyle that referenced this issue Feb 23, 2025
… of 'scope' and 'excludeScope' in JavadocVariableCheck
kkoutsilis added a commit to kkoutsilis/checkstyle that referenced this issue Feb 23, 2025
… of 'scope' and 'excludeScope' in JavadocVariableCheck
kkoutsilis added a commit to kkoutsilis/checkstyle that referenced this issue Mar 2, 2025
… of 'scope' and 'excludeScope' in JavadocVariableCheck
kkoutsilis added a commit to kkoutsilis/checkstyle that referenced this issue Mar 2, 2025
… of 'scope' and 'excludeScope' in JavadocVariableCheck
kkoutsilis added a commit to kkoutsilis/checkstyle that referenced this issue Mar 2, 2025
… of 'scope' and 'excludeScope' in JavadocVariableCheck
kkoutsilis added a commit to kkoutsilis/checkstyle that referenced this issue Mar 3, 2025
… of 'scope' and 'excludeScope' in JavadocVariableCheck
kkoutsilis added a commit to kkoutsilis/checkstyle that referenced this issue Mar 5, 2025
… of 'scope' and 'excludeScope' in JavadocVariableCheck
kkoutsilis added a commit to kkoutsilis/checkstyle that referenced this issue Mar 5, 2025
… of 'scope' and 'excludeScope' in JavadocVariableCheck
kkoutsilis added a commit to kkoutsilis/checkstyle that referenced this issue Mar 6, 2025
… of 'scope' and 'excludeScope' in JavadocVariableCheck
kkoutsilis added a commit to kkoutsilis/checkstyle that referenced this issue Mar 6, 2025
… of 'scope' and 'excludeScope' in JavadocVariableCheck
kkoutsilis added a commit to kkoutsilis/checkstyle that referenced this issue Mar 6, 2025
… of 'scope' and 'excludeScope' in JavadocVariableCheck
romani pushed a commit that referenced this issue Mar 7, 2025
…' and 'excludeScope' in JavadocVariableCheck
@github-actions github-actions bot added this to the 10.22.0 milestone Mar 7, 2025
@romani
Copy link
Member Author

romani commented Mar 7, 2025

@kkoutsilis , thanks a lot for making it happen!!!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
4 participants