10000 JavadocVariable: new property 'accessModifiers' as substitution of 'scope' and 'excludeScope' · Issue #9280 · checkstyle/checkstyle · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content
JavadocVariable: new property 'accessModifiers' as substitution of 'scope' and 'excludeScope'  #9280
Closed
@romani

Description

@romani

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:

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions

      0