Skip to content

Commit 3f128ff

Browse files
yDelouisyDelouis
committed
Merge pull request androidannotations#1198 from WonderCsabo/checkstyle
Conflicts: AndroidAnnotations/androidannotations/src/main/java/org/androidannotations/helper/CaseHelper.java
2 parents a96f299 + 11e5621 commit 3f128ff

237 files changed

Lines changed: 2924 additions & 1454 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.travis.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ before_script:
2222
- export TERM=dumb
2323

2424
script:
25-
- mvn -f AndroidAnnotations/pom.xml install
25+
- mvn -f AndroidAnnotations/pom.xml install -P travis
2626
- mvn -f examples/maveneclipse/pom.xml install -Dandroidannotations.version=3.3-SNAPSHOT
2727
- ./examples/gradle/gradlew build --build-file examples/gradle/build.gradle
2828

‎AndroidAnnotations/androidannotations-api/pom.xml‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,21 @@
11
<?xml version="1.0" encoding="UTF-8"?>
2+
<!--
3+
4+
Copyright (C) 2010-2014 eBusiness Information, Excilys Group
5+
6+
Licensed under the Apache License, Version 2.0 (the "License"); you may not
7+
use this file except in compliance with the License. You may obtain a copy of
8+
the License at
9+
10+
http://www.apache.org/licenses/LICENSE-2.0
11+
12+
Unless required by applicable law or agreed To in writing, software
13+
distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
14+
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
15+
License for the specific language governing permissions and limitations under
16+
the License.
17+
18+
-->
219
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
320
<modelVersion>4.0.0</modelVersion>
421

‎AndroidAnnotations/androidannotations-api/src/main/java/org/androidannotations/annotations/AfterTextChange.java‎

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,6 @@
1515
*/
1616
package org.androidannotations.annotations;
1717

18-
import android.text.Editable;
19-
2018
import java.lang.annotation.ElementType;
2119
import java.lang.annotation.Retention;
2220
import java.lang.annotation.RetentionPolicy;
@@ -25,8 +23,8 @@
2523
/**
2624
* <p>
2725
* This annotation is intended to be used on methods to receive events defined
28-
* by {@link android.text.TextWatcher#afterTextChanged(Editable s)} after the
29-
* text is changed on the targeted TextView or subclass of TextView.
26+
* by {@link android.text.TextWatcher#afterTextChanged(android.text.Editable s)}
27+
* after the text is changed on the targeted TextView or subclass of TextView.
3028
* </p>
3129
* <p>
3230
* The annotation value should be one or several R.id.* fields that refers to
@@ -76,8 +74,18 @@
7674
@Target(ElementType.METHOD)
7775
public @interface AfterTextChange {
7876

77+
/**
78+
* The R.id.* fields which refer to the TextViews.
79+
*
80+
* @return the ids of the TextViews.
81+
*/
7982
int[] value() default ResId.DEFAULT_VALUE;
8083

84+
/**
85+
* The resource names as a strings which refer to the TextViews.
86+
*
87+
* @return the resource names of the TextViews.
88+
*/
8189
String[] resName() default "";
8290

8391
}

‎AndroidAnnotations/androidannotations-api/src/main/java/org/androidannotations/annotations/AfterViews.java‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,6 @@
1515
*/
1616
package org.androidannotations.annotations;
1717

18-
import android.app.Activity;
19-
2018
import java.lang.annotation.ElementType;
2119
import java.lang.annotation.Retention;
2220
import java.lang.annotation.RetentionPolicy;
@@ -25,7 +23,8 @@
2523
/**
2624
* <p>
2725
* Methods annotated with @{@link AfterViews} will be called after
28-
* {@link Activity#setContentView(int)} is called by the generated activity.
26+
* {@link android.app.Activity#setContentView(int) setContentView(int)} is
27+
* called by the generated activity.
2928
* </p>
3029
* <p>
3130
* This occurs AFTER <code>setContentView(View)</code> which is called at the

‎AndroidAnnotations/androidannotations-api/src/main/java/org/androidannotations/annotations/Background.java‎

Lines changed: 19 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,6 @@
1919
import java.lang.annotation.Retention;
2020
import java.lang.annotation.RetentionPolicy;
2121
import java.lang.annotation.Target;
22-
import java.util.concurrent.Future;
23-
import java.util.concurrent.ScheduledThreadPoolExecutor;
2422

2523
/**
2624
* <p>
@@ -30,7 +28,9 @@
3028
* The annotated method MUST return void and MAY contain parameters.
3129
* </p>
3230
* <p>
33-
* The generated code is based on {@link org.androidannotations.api.BackgroundExecutor} methods.
31+
* The generated code is based on
32+
* {@link org.androidannotations.api.BackgroundExecutor BackgroundExecutor}
33+
* methods.
3434
* </p>
3535
*
3636
* <h2>Cancellation</h2>
@@ -66,20 +66,25 @@
6666
* <b>Note</b>: Cancellation may or may not be successful. If the task wasn't
6767
* executed yet, it will be removed from the pool. But it could fail if task has
6868
* already completed, has already been cancelled, or could not be cancelled for
69-
* some other reason. See {@link Future#cancel(boolean)} for more information.
69+
* some other reason. See {@link java.util.concurrent.Future#cancel(boolean)
70+
* Future#cancel(boolean)} for more information.
7071
* </p>
7172
*
7273
* <h2>Execution flow</h2>
7374
* <p>
74-
* By default, all tasks will be put in a {@link ScheduledThreadPoolExecutor}
75-
* with a core pool size of <code>2 * numberOfCpu</code>. Which means that
76-
* background methods will be executed in <b>PARALLEL</b>. You can change this
77-
* by calling <code>BackgroundExecutor.setExecutor(...)</code>.
75+
* By default, all tasks will be put in a
76+
* {@link java.util.concurrent.ScheduledThreadPoolExecutor
77+
* ScheduledThreadPoolExecutor} with a core pool size of
78+
* <code>2 * numberOfCpu</code>. Which means that background methods will be
79+
* executed in <b>PARALLEL</b>. You can change this by calling
80+
* <code>BackgroundExecutor.setExecutor(...)</code>.
7881
* </p>
7982
* <p>
8083
* If you want execute ALL background methods SEQUENTIALLY, the best way is to
81-
* change the executor of {@link org.androidannotations.api.BackgroundExecutor} to a
82-
* {@link ScheduledThreadPoolExecutor} with a core pool size of <code>1</code>.
84+
* change the executor of {@link org.androidannotations.api.BackgroundExecutor
85+
* BackgroundExecutor} to a
86+
* {@link java.util.concurrent.ScheduledThreadPoolExecutor
87+
* ScheduledThreadPoolExecutor} with a core pool size of <code>1</code>.
8388
* </p>
8489
* <p>
8590
* If you want execute some background methods SEQUENTIALLY, you should simply
@@ -146,6 +151,7 @@
146151
* <b>Example</b> :
147152
*
148153
* <blockquote>
154+
*
149155
* <pre>
150156
* &#064;EBean
151157
* public class MyBean {
@@ -175,15 +181,15 @@
175181
* boolean mayInterruptIfRunning = true;
176182
* BackgroundExecutor.cancelAll(&quot;my_background_id&quot;, mayInterruptIfRunning);
177183
* </pre>
178-
*
179-
* @return the identifier for task cancellation
184+
*
185+
* @return the task id for cancellation
180186
**/
181187
String id() default "";
182188

183189
/**
184190
* Minimum delay, in milliseconds, before the background task is executed.
185191
*
186-
* @return the minimum delay before execution
192+
* @return the delay of the execution
187193
*/
188194
int delay() default 0;
189195

‎AndroidAnnotations/androidannotations-api/src/main/java/org/androidannotations/annotations/Bean.java‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,5 +60,11 @@
6060
@Retention(RetentionPolicy.CLASS)
6161
@Target(ElementType.FIELD)
6262
public @interface Bean {
63+
64+
/**
65+
* The implementation class of the injected bean.
66+
*
67+
* @return the implementation class
68+
*/
6369
Class<?> value() default Void.class;
6470
}

‎AndroidAnnotations/androidannotations-api/src/main/java/org/androidannotations/annotations/BeforeTextChange.java‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,8 +82,18 @@
8282
@Target(ElementType.METHOD)
8383
public @interface BeforeTextChange {
8484

85+
/**
86+
* The R.id.* fields which refer to the TextViews.
87+
*
88+
* @return the ids of the TextViews.
89+
*/
8590
int[] value() default ResId.DEFAULT_VALUE;
8691

92+
/**
93+
* The resource names as a strings which refer to the TextViews.
94+
*
95+
* @return the resource names of the TextViews.
96+
*/
8797
String[] resName() default "";
8898

8999
}

‎AndroidAnnotations/androidannotations-api/src/main/java/org/androidannotations/annotations/CheckedChange.java‎

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,12 +69,24 @@
6969
*
7070
* </blockquote>
7171
*
72-
* @author Rostislav Chekan
7372
*/
7473
@Retention(RetentionPolicy.CLASS)
7574
@Target(ElementType.METHOD)
7675
public @interface CheckedChange {
76+
77+
/**
78+
* The R.id.* fields which refer to the CompoundButtons or subclasses of
79+
* CompoundButton.
80+
*
81+
* @return the ids of the CompoundButtons
82+
*/
7783
int[] value() default ResId.DEFAULT_VALUE;
7884

85+
/**
86+
* The resource names as strings which refer to the CompoundButtons or
87+
* subclasses of CompoundButton.
88+
*
89+
* @return the resource names of the CompoundButtons
90+
*/
7991
String[] resName() default "";
8092
}

‎AndroidAnnotations/androidannotations-api/src/main/java/org/androidannotations/annotations/Click.java‎

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,8 @@
3434
* The method MAY have one parameter:
3535
* </p>
3636
* <ul>
37-
* <li>A {@link android.view.View} parameter to know which view has been clicked</li>
37+
* <li>A {@link android.view.View} parameter to know which view has been clicked
38+
* </li>
3839
* </ul>
3940
* <blockquote>
4041
*
@@ -61,8 +62,18 @@
6162
@Target(ElementType.METHOD)
6263
public @interface Click {
6364

65+
/**
66+
* The R.id.* fields which refer to the Views.
67+
*
68+
* @return the ids of the Views
69+
*/
6470
int[] value() default ResId.DEFAULT_VALUE;
6571

72+
/**
73+
* The resource names as strings which refer to the Views.
74+
*
75+
* @return the resource names of the Views
76+
*/
6677
String[] resName() default "";
6778

6879
}

‎AndroidAnnotations/androidannotations-api/src/main/java/org/androidannotations/annotations/CustomTitle.java‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,5 +44,11 @@
4444
@Retention(RetentionPolicy.CLASS)
4545
@Target(ElementType.TYPE)
4646
public @interface CustomTitle {
47+
48+
/**
49+
* R.layout.* field which refers the the title layout.
50+
*
51+
* @return the id of the layout
52+
*/
4753
int value();
4854
}

0 commit comments

Comments
 (0)