Skip to content
This repository was archived by the owner on Feb 26, 2023. It is now read-only.

Checkstyle - #1198

Merged
yDelouis merged 5 commits into
androidannotations:developfrom
WonderCsabo:checkstyle
Dec 27, 2014
Merged

Checkstyle#1198
yDelouis merged 5 commits into
androidannotations:developfrom
WonderCsabo:checkstyle

Conversation

@WonderCsabo

@WonderCsabo WonderCsabo commented Oct 19, 2014

Copy link
Copy Markdown
Member

Related to #1088.

I also plan to ensure proper JavaDoc on all annotations (and all methods in the annotations). That will come later in another commit in this branch.

@WonderCsabo
WonderCsabo force-pushed the checkstyle branch 3 times, most recently from d9422f4 to d6da8d3 Compare October 19, 2014 19:45
@WonderCsabo

WonderCsabo commented Oct 19, 2014

Copy link
Copy Markdown
Member Author

I wanted to execute the license:check goal as well with the build, but unfortunately it does not work well with child modules (cannot find the header file). If somebody has a fix for that i would appreciate it.

@WonderCsabo
WonderCsabo force-pushed the checkstyle branch 6 times, most recently from 04c880f to 6f4fea8 Compare October 20, 2014 16:58
@WonderCsabo

WonderCsabo commented Oct 20, 2014

Copy link
Copy Markdown
Member Author

Great, there is a bug conflict between JavaDoc with Java 8 and checkstyle. The first requires @return tags for every non-void method (even for annotations!), the latter prohibits @return tags in methods in annotations. This is a know problem in Checkstyle... I'll add @return everywhere and remove the JavaDocTag check.

@WonderCsabo
WonderCsabo force-pushed the checkstyle branch 2 times, most recently from 9273fea to 0f691e0 Compare October 20, 2014 19:25
@WonderCsabo WonderCsabo mentioned this pull request Oct 22, 2014
Closed
@WonderCsabo
Add checkstyle
edf3791
@WonderCsabo
Update license plugin
bc99f07
@WonderCsabo
Check JavaDoc with Checkstyle for all annotations
f82dc91
@WonderCsabo
Move Checkstyle execution to a separate profile for Travis
f643816 
It can be really annoying for contributors for always fixing the code
due to broken build by Checkstyle even before starting implementing a
feature. That's why the Checkstyle execution is moved to a separate
profile what will be used by Travis CI. Contributors are still
encouraged to run Checkstyle manually before pushing code, but Travis
will reject malformatted code in the PRs anyway.
@WonderCsabo
Adding @return to all method JavaDoc
11e5621 
JDK8 JavaDoc needs @return on all non-void methods. Unfortunetaly
Checkstyle does not know about this
(http://sourceforge.net/p/checkstyle/bugs/543/), so we have to disable
the JavaDocMethod check for now.
@WonderCsabo

WonderCsabo commented Dec 22, 2014

Copy link
Copy Markdown
Member Author

@yDelouis i rebased this onto develop. Can you review this soon? Rebasing this amount of code is painful (as you already know 😏 ).

@WonderCsabo WonderCsabo mentioned this pull request Dec 25, 2014
Closed
yDelouis added a commit that referenced this pull request Dec 27, 2014
@yDelouis
Merge pull request #1198 from WonderCsabo/checkstyle
5155a84 
Conflicts:
	.travis.yml
	AndroidAnnotations/androidannotations-api/src/main/java/org/androidannotations/annotations/ReceiverAction.java
	AndroidAnnotations/androidannotations/src/main/java/org/androidannotations/handler/BaseAnnotationHandler.java
	AndroidAnnotations/androidannotations/src/main/java/org/androidannotations/handler/OrmLiteDaoHandler.java
	AndroidAnnotations/androidannotations/src/main/java/org/androidannotations/handler/ReceiverActionHandler.java
	AndroidAnnotations/androidannotations/src/main/java/org/androidannotations/handler/ServiceActionHandler.java
	AndroidAnnotations/androidannotations/src/main/java/org/androidannotations/helper/CaseHelper.java
	AndroidAnnotations/androidannotations/src/main/java/org/androidannotations/helper/IntentBuilder.java
	AndroidAnnotations/androidannotations/src/main/java/org/androidannotations/helper/ValidatorHelper.java
	AndroidAnnotations/androidannotations/src/main/java/org/androidannotations/holder/EActivityHolder.java
	AndroidAnnotations/androidannotations/src/main/java/org/androidannotations/holder/EFragmentHolder.java
	AndroidAnnotations/androidannotations/src/main/java/org/androidannotations/holder/EServiceHolder.java
	AndroidAnnotations/androidannotations/src/main/java/org/androidannotations/holder/EViewHolder.java
	AndroidAnnotations/androidannotations/src/test/java/org/androidannotations/copyannotations/HasOtherAnnotations.java
	AndroidAnnotations/functional-test-1-5/pom.xml
	AndroidAnnotations/functional-test-1-5/src/main/java/org/androidannotations/test15/AwaitingResultFragment.java
	AndroidAnnotations/pom.xml
yDelouis added a commit to yDelouis/androidannotations that referenced this pull request Dec 27, 2014
@yDelouis
Merge pull request androidannotations#1198 from WonderCsabo/checkstyle
b13d926 
Conflicts:
	.travis.yml
	AndroidAnnotations/androidannotations-api/src/main/java/org/androidannotations/annotations/ReceiverAction.java
	AndroidAnnotations/androidannotations/src/main/java/org/androidannotations/handler/BaseAnnotationHandler.java
	AndroidAnnotations/androidannotations/src/main/java/org/androidannotations/handler/OrmLiteDaoHandler.java
	AndroidAnnotations/androidannotations/src/main/java/org/androidannotations/handler/ReceiverActionHandler.java
	AndroidAnnotations/androidannotations/src/main/java/org/androidannotations/handler/ServiceActionHandler.java
	AndroidAnnotations/androidannotations/src/main/java/org/androidannotations/helper/CaseHelper.java
	AndroidAnnotations/androidannotations/src/main/java/org/androidannotations/helper/IntentBuilder.java
	AndroidAnnotations/androidannotations/src/main/java/org/androidannotations/helper/ValidatorHelper.java
	AndroidAnnotations/androidannotations/src/main/java/org/androidannotations/holder/EActivityHolder.java
	AndroidAnnotations/androidannotations/src/main/java/org/androidannotations/holder/EFragmentHolder.java
	AndroidAnnotations/androidannotations/src/main/java/org/androidannotations/holder/EServiceHolder.java
	AndroidAnnotations/androidannotations/src/main/java/org/androidannotations/holder/EViewHolder.java
	AndroidAnnotations/androidannotations/src/test/java/org/androidannotations/copyannotations/HasOtherAnnotations.java
	AndroidAnnotations/functional-test-1-5/pom.xml
	AndroidAnnotations/functional-test-1-5/src/main/java/org/androidannotations/test15/AwaitingResultFragment.java
	AndroidAnnotations/pom.xml
yDelouis added a commit to yDelouis/androidannotations that referenced this pull request Dec 27, 2014
@yDelouis
Merge pull request androidannotations#1198 from WonderCsabo/checkstyle
3f25768 
Conflicts:
	.travis.yml
	AndroidAnnotations/androidannotations-api/src/main/java/org/androidannotations/annotations/ReceiverAction.java
	AndroidAnnotations/androidannotations/src/main/java/org/androidannotations/handler/BaseAnnotationHandler.java
	AndroidAnnotations/androidannotations/src/main/java/org/androidannotations/handler/OrmLiteDaoHandler.java
	AndroidAnnotations/androidannotations/src/main/java/org/androidannotations/handler/ReceiverActionHandler.java
	AndroidAnnotations/androidannotations/src/main/java/org/androidannotations/handler/ServiceActionHandler.java
	AndroidAnnotations/androidannotations/src/main/java/org/androidannotations/helper/CaseHelper.java
	AndroidAnnotations/androidannotations/src/main/java/org/androidannotations/helper/IntentBuilder.java
	AndroidAnnotations/androidannotations/src/main/java/org/androidannotations/helper/ValidatorHelper.java
	AndroidAnnotations/androidannotations/src/main/java/org/androidannotations/holder/EActivityHolder.java
	AndroidAnnotations/androidannotations/src/main/java/org/androidannotations/holder/EFragmentHolder.java
	AndroidAnnotations/androidannotations/src/main/java/org/androidannotations/holder/EServiceHolder.java
	AndroidAnnotations/androidannotations/src/main/java/org/androidannotations/holder/EViewHolder.java
	AndroidAnnotations/androidannotations/src/test/java/org/androidannotations/copyannotations/HasOtherAnnotations.java
	AndroidAnnotations/functional-test-1-5/pom.xml
	AndroidAnnotations/functional-test-1-5/src/main/java/org/androidannotations/test15/AwaitingResultFragment.java
	AndroidAnnotations/pom.xml
yDelouis added a commit to yDelouis/androidannotations that referenced this pull request Dec 27, 2014
@yDelouis
Merge pull request androidannotations#1198 from WonderCsabo/checkstyle
3f128ff 
Conflicts:
	AndroidAnnotations/androidannotations/src/main/java/org/androidannotations/helper/CaseHelper.java
@yDelouis
yDelouis merged commit 11e5621 into androidannotations:develop Dec 27, 2014
@yDelouis yDelouis added this to the 3.3 milestone Dec 27, 2014
@WonderCsabo
WonderCsabo deleted the checkstyle branch December 27, 2014 21:04
@WonderCsabo

WonderCsabo commented Dec 27, 2014

Copy link
Copy Markdown
Member Author

I added a note about checkstyle of the contribution page of the wiki.

@WonderCsabo

WonderCsabo commented Dec 28, 2014

Copy link
Copy Markdown
Member Author

I just realized i did not add the test classes for Checkstyle reporting. I do that later in a separate PR.

@philwebb philwebb mentioned this pull request Sep 8, 2015
Closed
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

3.3

Development

Successfully merging this pull request may close these issues.

2 participants

@WonderCsabo @yDelouis