Skip to content

Checkstyle improvements #539

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
Closed
iluwatar opened this issue Feb 5, 2017 · 4 comments
Closed

Checkstyle improvements #539

iluwatar opened this issue Feb 5, 2017 · 4 comments
Labels
info: good first issue info: help wanted
Milestone
1.15.0

Comments

@iluwatar
Copy link
Owner

iluwatar commented Feb 5, 2017

Currently Checkstyle does not check for type Javadocs.Rule JavadocType should be added. Rule that causes trouble and should be removed is AvoidStarImport since IntelliJ IDEA likes to organize imports automatically this way.
@muditporwal
Copy link
Contributor

Will this suffice ?

<module name="JavadocType"/>

Or need more customization ?

<module name="JavadocType">
  <property name="authorFormat" value="\S"/>
</module>

@iluwatar
Copy link
Owner Author

Is authorFormat necessary? My suggestion would be like this.

<module name="JavadocType">
    <property name="scope" value="public"/>
</module>

And remove the star import.

<module name="AvoidStarImport"/>

@muditporwal
Copy link
Contributor

How do we get the missing JavaDoc ? Is it ok for me to suggest javadoc in my pull request (the build is breaking at the moment) ?

@iluwatar
Copy link
Owner Author

Yes, please suggest changes so that build works.

iluwatar added a commit that referenced this issue Apr 1, 2017
@iluwatar
Merge pull request #548 from muditporwal/master
3f272bf 
Checkstyle improvements #539 : Added JavaDocType Rule
@iluwatar iluwatar added this to the 1.15.0 milestone Apr 1, 2017
@iluwatar iluwatar closed this as completed Apr 1, 2017
iluwatar added a commit that referenced this issue Apr 1, 2017
@iluwatar
#539 Checkstyle fixes
c1c4411
iluwatar added a commit that referenced this issue Apr 1, 2017
@iluwatar
#539 More Checkstyle fixes
f3c4640
iluwatar added a commit that referenced this issue Apr 1, 2017
@iluwatar
#539 Checkstyle fix
139876f
kemitix added a commit to kemitix/java-design-patterns that referenced this issue Apr 1, 2017
@kemitix
Merge remote-tracking branch 'upstream/master' into data-bus
30315e7 
* upstream/master: (67 commits)
  Set version for next development iteration
  Reached milestone 1.15.0
  iluwatar#539 Checkstyle fix
  iluwatar#539 More Checkstyle fixes
  iluwatar#539 Checkstyle fixes
  iluwatar#497 Add missing puml and license headers
  iluwatar#77 Add missing license header
  Work on iluwatar#190: urm/puml updates * added pumlid where it was missing and possible * removed pumlid where it generated a bad image * regenerated some incorrect puml's * added 'left to right direction' puml prefix to some diagrams to improve the automatic layouting
  Removed AvoidStarImport Rule Added JavaDocType Rule
  Update App.java
  Update App.java
  Update after changes from review. Additional improvements.
  Pom.xml files fixed.
  iluwatar#66 Balking Pattern
  fixed pmd violation
  fixed checkstyle violations
  diagrams added
  comments, tests and description
  changed parent POM version iluwatar#69
  apply changes from review iluwatar#69
  ...

# Conflicts:
#	pom.xml
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
info: good first issue info: help wanted
Projects
None yet
Milestone
1.15.0
Development

No branches or pull requests
2 participants
@iluwatar @muditporwal