Skip to content

Commit 11e5621

Browse files
WonderCsaboWonderCsabo
committed
Adding @return to all method JavaDoc
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.
1 parent f643816 commit 11e5621

82 files changed

Lines changed: 322 additions & 24 deletions

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: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,13 +76,15 @@
7676

7777
/**
7878
* The R.id.* fields which refer to the TextViews.
79+
*
80+
* @return the ids of the TextViews.
7981
*/
8082
int[] value() default ResId.DEFAULT_VALUE;
8183

8284
/**
8385
* The resource names as a strings which refer to the TextViews.
8486
*
85-
* @return
87+
* @return the resource names of the TextViews.
8688
*/
8789
String[] resName() default "";
8890

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

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

187189
/**
188190
* Minimum delay, in milliseconds, before the background task is executed.
189191
*
192+
* @return the delay of the execution
190193
*/
191194
int delay() default 0;
192195

@@ -196,6 +199,7 @@
196199
* All background tasks having the same <code>serial</code> will be executed
197200
* sequentially.
198201
*
202+
* @return the serial execution group
199203
**/
200204
String serial() default "";
201205
}

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

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,9 @@
6262
public @interface Bean {
6363

6464
/**
65-
* The implementation class.
65+
* The implementation class of the injected bean.
66+
*
67+
* @return the implementation class
6668
*/
6769
Class<?> value() default Void.class;
6870
}

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

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,11 +84,15 @@
8484

8585
/**
8686
* The R.id.* fields which refer to the TextViews.
87+
*
88+
* @return the ids of the TextViews.
8789
*/
8890
int[] value() default ResId.DEFAULT_VALUE;
8991

9092
/**
9193
* The resource names as a strings which refer to the TextViews.
94+
*
95+
* @return the resource names of the TextViews.
9296
*/
9397
String[] resName() default "";
9498

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

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,12 +77,16 @@
7777
/**
7878
* The R.id.* fields which refer to the CompoundButtons or subclasses of
7979
* CompoundButton.
80+
*
81+
* @return the ids of the CompoundButtons
8082
*/
8183
int[] value() default ResId.DEFAULT_VALUE;
8284

8385
/**
8486
* The resource names as strings which refer to the CompoundButtons or
8587
* subclasses of CompoundButton.
88+
*
89+
* @return the resource names of the CompoundButtons
8690
*/
8791
String[] resName() default "";
8892
}

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

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,11 +64,15 @@
6464

6565
/**
6666
* The R.id.* fields which refer to the Views.
67+
*
68+
* @return the ids of the Views
6769
*/
6870
int[] value() default ResId.DEFAULT_VALUE;
6971

7072
/**
7173
* The resource names as strings which refer to the Views.
74+
*
75+
* @return the resource names of the Views
7276
*/
7377
String[] resName() default "";
7478

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,8 @@
4747

4848
/**
4949
* R.layout.* field which refers the the title layout.
50+
*
51+
* @return the id of the layout
5052
*/
5153
int value();
5254
}

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

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -90,11 +90,15 @@
9090

9191
/**
9292
* The R.layout.* field which refer to the layout.
93+
*
94+
* @return the id of the layout
9395
*/
9496
int value() default ResId.DEFAULT_VALUE;
9597

9698
/**
9799
* The resource name as a string which refer to the layout.
100+
*
101+
* @return the resource name of the layout
98102
*/
99103
String resName() default "";
100104
}

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -110,6 +110,8 @@ public enum Scope {
110110

111111
/**
112112
* The scope of the enhanced bean.
113+
*
114+
* @return the scope of the bean.
113115
*/
114116
Scope scope() default Scope.Default;
115117

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

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -111,11 +111,15 @@
111111

112112
/**
113113
* The R.layout.* field which refer to the layout.
114+
*
115+
* @return the id of the layout
114116
*/
115117
int value() default ResId.DEFAULT_VALUE;
116118

117119
/**
118120
* The resource name as a string which refer to the layout.
121+
*
122+
* @return the resource name of the layout
119123
*/
120124
String resName() default "";
121125

0 commit comments

Comments
 (0)