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

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

Open
romani opened this issue Feb 15, 2021 · 7 comments · May be fixed by #16049
Open

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

romani opened this issue Feb 15, 2021 · 7 comments · May be fixed by #16049
Labels
approved breaking compatibility

Comments

@romani
Copy link
Member

romani commented Feb 15, 2021 •
edited
Loading

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
@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 mentioned this issue Feb 15, 2021
Closed
@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
Issue checkstyle#9280: replace Scope with AccessModifierOption in…
ca05db8 
… JavadocVariableCheck
martin-mfg added a commit to martin-mfg/checkstyle that referenced this issue Feb 15, 2021
@martin-mfg
Issue checkstyle#9280: replace Scope with AccessModifierOption in…
57e4a4b 
… JavadocVariableCheck
martin-mfg added a commit to martin-mfg/checkstyle that referenced this issue Apr 25, 2021
@martin-mfg
Issue checkstyle#9280: replace Scope with AccessModifierOption in…
97b8d1f 
… JavadocVariableCheck
martin-mfg added a commit to martin-mfg/checkstyle that referenced this issue Apr 30, 2021
@martin-mfg
Issue checkstyle#9280: replace Scope with AccessModifierOption in…
566c7e7 
… JavadocVariableCheck
martin-mfg added a commit to martin-mfg/checkstyle that referenced this issue Apr 30, 2021
@martin-mfg
Issue checkstyle#9280: replace Scope with AccessModifierOption in…
8870091 
… JavadocVariableCheck
martin-mfg added a commit to martin-mfg/checkstyle that referenced this issue May 19, 2021
@martin-mfg
Issue checkstyle#9280: replace Scope with AccessModifierOption in…
b5fbec6 
… JavadocVariableCheck
martin-mfg added a commit to martin-mfg/checkstyle that referenced this issue May 19, 2021
@martin-mfg
Issue checkstyle#9280: replace Scope with AccessModifierOption in…
67a1acf 
… JavadocVariableCheck
martin-mfg added a commit to martin-mfg/checkstyle that referenced this issue Jun 24, 2021
@martin-mfg
Issue checkstyle#9280: replace Scope with AccessModifierOption in…
66fbb11 
… JavadocVariableCheck
martin-mfg added a commit to martin-mfg/checkstyle that referenced this issue Jul 17, 2021
@martin-mfg
Issue checkstyle#9280: replace Scope with AccessModifierOption in…
f262b1c 
… JavadocVariableCheck
martin-mfg added a commit to martin-mfg/checkstyle that referenced this issue Jul 30, 2021
@martin-mfg
Issue checkstyle#9280: replace Scope with AccessModifierOption in…
ab3c591 
… JavadocVariableCheck
martin-mfg added a commit to martin-mfg/checkstyle that referenced this issue Aug 1, 2021
@martin-mfg
Issue checkstyle#9280: replace Scope with AccessModifierOption in…
0b10279 
… JavadocVariableCheck
github-actions bot pushed a commit to martin-mfg/checkstyle that referenced this issue Aug 1, 2021
@martin-mfg @romani
Issue checkstyle#9280: replace Scope with AccessModifierOption in…
a8dfe40 
… JavadocVariableCheck
martin-mfg added a commit to martin-mfg/checkstyle that referenced this issue Aug 8, 2021
@martin-mfg
Issue checkstyle#9280: replace Scope with AccessModifierOption in…
378442a 
… JavadocVariableCheck
martin-mfg added a commit to martin-mfg/checkstyle that referenced this issue Aug 9, 2021
@martin-mfg
Issue checkstyle#9280: replace Scope with AccessModifierOption in…
0cd2326 
… JavadocVariableCheck
martin-mfg added a commit to martin-mfg/checkstyle that referenced this issue Aug 9, 2021
@martin-mfg
Issue checkstyle#9280: replace Scope with AccessModifierOption in…
907e2c7 
… JavadocVariableCheck
martin-mfg added a commit to martin-mfg/checkstyle that referenced this issue Aug 13, 2021
@martin-mfg
Issue checkstyle#9280: replace Scope with AccessModifierOption in…
b4d0e9b 
… JavadocVariableCheck
martin-mfg added a commit to martin-mfg/checkstyle that referenced this issue Aug 16, 2021
@martin-mfg
Issue checkstyle#9280: replace Scope with AccessModifierOption in…
2693ff0 
… JavadocVariableCheck
martin-mfg added a commit to martin-mfg/checkstyle that referenced this issue Aug 16, 2021
@martin-mfg
Issue checkstyle#9280: replace Scope with AccessModifierOption in…
e575f81 
… JavadocVariableCheck
martin-mfg added a commit to martin-mfg/checkstyle that referenced this issue Aug 16, 2021
@martin-mfg
Issue checkstyle#9280: replace Scope with AccessModifierOption in…
e56aebf 
… JavadocVariableCheck
martin-mfg added a commit to martin-mfg/checkstyle that referenced this issue Sep 5, 2021
@martin-mfg
Issue checkstyle#9280: replace Scope with AccessModifierOption in…
c1f55bf 
… JavadocVariableCheck
martin-mfg added a commit to martin-mfg/checkstyle that referenced this issue Sep 5, 2021
@martin-mfg
Issue checkstyle#9280: replace Scope with AccessModifierOption in…
b3aee80 
… JavadocVariableCheck
martin-mfg added a commit to martin-mfg/checkstyle that referenced this issue Sep 5, 2021
@martin-mfg
Issue checkstyle#9280: replace Scope with AccessModifierOption in…
92c7bc1 
… JavadocVariableCheck
martin-mfg added a commit to martin-mfg/checkstyle that referenced this issue Sep 6, 2021
@martin-mfg
Issue checkstyle#9280: replace Scope with AccessModifierOption in…
2065303 
… JavadocVariableCheck
martin-mfg added a commit to martin-mfg/checkstyle that referenced this issue Sep 6, 2021
@martin-mfg
Issue checkstyle#9280: replace Scope with AccessModifierOption in…
0427178 
… JavadocVariableCheck
martin-mfg added a commit to martin-mfg/checkstyle that referenced this issue Sep 6, 2021
@martin-mfg
Issue checkstyle#9280: replace Scope with AccessModifierOption in…
b34a140 
… JavadocVariableCheck
martin-mfg added a commit to martin-mfg/checkstyle that referenced this issue Oct 12, 2021
@martin-mfg
Issue checkstyle#9280: replace Scope with AccessModifierOption in…
03e11f7 
… JavadocVariableCheck
@philwebb philwebb mentioned this issue Feb 15, 2023
Closed
@ShivamPandey00
Copy link
Contributor

I am on it

@romani
Copy link
Member Author

romani commented Mar 26, 2023

@coderdeadpool, this might be very complicated for you, please do second and third gsoc labeled issues first.

@rnveach rnveach mentioned this issue Nov 17, 2023
Open
@AayushSaini101
Copy link
Contributor

@romani Can i take this

@romani
Copy link
Member Author

romani commented Nov 17, 2023

Any approved issue can to taken. Yes.

@romani
Copy link
Member Author

romani commented Nov 17, 2023

@AayushSaini101 , please finish PRs that you already started or close them https://github.com/checkstyle/checkstyle/pulls/aayushRedHat

@nrmancuso
Copy link
Member

We have a two year old PR open for this issue already: #9277

@romani
Copy link
Member Author

romani commented Dec 2, 2023

we recently run into edge case with scope property but for another Check - #13749 , and I am not sure how accessModifiersOption is going to handle it.
We need sombody to think on how inner class in method scope can be separated by accessModifiersOption

kkoutsilis added a commit to kkoutsilis/checkstyle that referenced this issue Dec 24, 2024
@kkoutsilis
Issue checkstyle#9280: New property 'accessModifiers' as substitution…
4aae949 
… of 'scope' and 'excludeScope' in JavadocVariableCheck
kkoutsilis added a commit to kkoutsilis/checkstyle that referenced this issue Dec 24, 2024
@kkoutsilis
Issue checkstyle#9280: New property 'accessModifiers' as substitution…
6bc45a8 
… of 'scope' and 'excludeScope' in JavadocVariableCheck
@kkoutsilis kkoutsilis linked a pull request Dec 24, 2024 that will close this issue
Open
kkoutsilis added a commit to kkoutsilis/checkstyle that referenced this issue Dec 27, 2024
@kkoutsilis
Issue checkstyle#9280: New property 'accessModifiers' as substitution…
d98f95a 
… of 'scope' and 'excludeScope' in JavadocVariableCheck
kkoutsilis added a commit to kkoutsilis/checkstyle that referenced this issue Dec 28, 2024
@kkoutsilis
Issue checkstyle#9280: New property 'accessModifiers' as substitution…
b8fd691 
… of 'scope' and 'excludeScope' in JavadocVariableCheck
kkoutsilis added a commit to kkoutsilis/checkstyle that referenced this issue Dec 28, 2024
@kkoutsilis
Issue checkstyle#9280: New property 'accessModifiers' as substitution…
effb94d 
… of 'scope' and 'excludeScope' in JavadocVariableCheck
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
approved breaking compatibility
Projects
None yet
Milestone
No milestone
4 participants
@romani @nrmancuso @AayushSaini101 @ShivamPandey00