Skip to content

Commit f82dc91

Browse files
WonderCsaboWonderCsabo
committed
Check JavaDoc with Checkstyle for all annotations
1 parent bc99f07 commit f82dc91

85 files changed

Lines changed: 681 additions & 75 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.

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

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,8 +74,16 @@
7474
@Target(ElementType.METHOD)
7575
public @interface AfterTextChange {
7676

77+
/**
78+
* The R.id.* fields which refer to the TextViews.
79+
*/
7780
int[] value() default ResId.DEFAULT_VALUE;
7881

82+
/**
83+
* The resource names as a strings which refer to the TextViews.
84+
*
85+
* @return
86+
*/
7987
String[] resName() default "";
8088

8189
}

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

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -181,15 +181,12 @@
181181
* boolean mayInterruptIfRunning = true;
182182
* BackgroundExecutor.cancelAll("my_background_id", mayInterruptIfRunning);
183183
* </pre>
184-
*
185-
* @return the identifier for task cancellation
186184
**/
187185
String id() default "";
188186

189187
/**
190188
* Minimum delay, in milliseconds, before the background task is executed.
191189
*
192-
* @return the minimum delay before execution
193190
*/
194191
int delay() default 0;
195192

@@ -199,7 +196,6 @@
199196
* All background tasks having the same <code>serial</code> will be executed
200197
* sequentially.
201198
*
202-
* @return the serial execution group
203199
**/
204200
String serial() default "";
205201
}

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

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,5 +60,9 @@
6060
@Retention(RetentionPolicy.CLASS)
6161
@Target(ElementType.FIELD)
6262
public @interface Bean {
63+
64+
/**
65+
* The implementation class.
66+
*/
6367
Class<?> value() default Void.class;
6468
}

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

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

85+
/**
86+
* The R.id.* fields which refer to the TextViews.
87+
*/
8588
int[] value() default ResId.DEFAULT_VALUE;
8689

90+
/**
91+
* The resource names as a strings which refer to the TextViews.
92+
*/
8793
String[] resName() default "";
8894

8995
}

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

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,12 +69,20 @@
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+
*/
7781
int[] value() default ResId.DEFAULT_VALUE;
7882

83+
/**
84+
* The resource names as strings which refer to the CompoundButtons or
85+
* subclasses of CompoundButton.
86+
*/
7987
String[] resName() default "";
8088
}

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

Lines changed: 8 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,14 @@
6162
@Target(ElementType.METHOD)
6263
public @interface Click {
6364

65+
/**
66+
* The R.id.* fields which refer to the Views.
67+
*/
6468
int[] value() default ResId.DEFAULT_VALUE;
6569

70+
/**
71+
* The resource names as strings which refer to the Views.
72+
*/
6673
String[] resName() default "";
6774

6875
}

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

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,5 +44,9 @@
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+
*/
4751
int value();
4852
}

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

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,14 @@
8787
@Retention(RetentionPolicy.CLASS)
8888
@Target(ElementType.TYPE)
8989
public @interface EActivity {
90+
91+
/**
92+
* The R.layout.* field which refer to the layout.
93+
*/
9094
int value() default ResId.DEFAULT_VALUE;
9195

96+
/**
97+
* The resource name as a string which refer to the layout.
98+
*/
9299
String resName() default "";
93100
}

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

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -41,8 +41,8 @@
4141
* Most annotations are supported in {@link EBean} classes, except the ones
4242
* related to extras. Views related annotations will only work if the bean was
4343
* injected in an activity with a layout containing the views you're dealing
44-
* with. If your bean needs a {@link android.content.Context} you can inject on by
45-
* using an {@link RootContext} annotated field.
44+
* with. If your bean needs a {@link android.content.Context} you can inject on
45+
* by using an {@link RootContext} annotated field.
4646
* </p>
4747
* <p>
4848
* Beans have two possible scopes : default or singleton. Default scope should
@@ -91,10 +91,13 @@
9191
@Target(ElementType.TYPE)
9292
public @interface EBean {
9393

94+
/**
95+
* The scope of an enhanced bean.
96+
*/
9497
public enum Scope {
9598

9699
/**
97-
* A new instance of the bean is created each time it is needed
100+
* A new instance of the bean is created each time it is needed.
98101
*/
99102
Default, //
100103

@@ -105,6 +108,9 @@ public enum Scope {
105108
Singleton, //
106109
}
107110

111+
/**
112+
* The scope of the enhanced bean.
113+
*/
108114
Scope scope() default Scope.Default;
109115

110116
}

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

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -108,8 +108,15 @@
108108
@Retention(RetentionPolicy.CLASS)
109109
@Target(ElementType.TYPE)
110110
public @interface EFragment {
111+
112+
/**
113+
* The R.layout.* field which refer to the layout.
114+
*/
111115
int value() default ResId.DEFAULT_VALUE;
112116

117+
/**
118+
* The resource name as a string which refer to the layout.
119+
*/
113120
String resName() default "";
114121

115122
/**

0 commit comments

Comments
 (0)