Skip to content

Commit a499220

Browse files
DaySDayS
committed
Add more javadoc
1 parent 94bf5b8 commit a499220

19 files changed

Lines changed: 374 additions & 113 deletions

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@
3333
* <h2>Cancellation</h2>
3434
* Since 3.0, you're able to cancel a background task by calling
3535
* <code>BackgroundExecutor.cancelAll("id")</code> where "id" matches the
36-
* {@link Background#id()} value.
36+
* {@link #id()} value.
3737
*
3838
* <p/>
3939
* <blockquote>
@@ -76,8 +76,8 @@
7676
* {@link ScheduledThreadPoolExecutor} with a core pool size of <code>1</code>.
7777
* <p/>
7878
* If you want execute some background methods SEQUENTIALLY, you should simply
79-
* use {@link Background#serial()} field. All task with the same serial key will
80-
* be executed sequentially.
79+
* use {@link #serial()} field. All task with the same serial key will be
80+
* executed sequentially.
8181
*
8282
* <p/>
8383
* <blockquote>
@@ -133,8 +133,8 @@
133133
*
134134
* <h2>Delay</h2>
135135
* Sometimes you may want to delay execution of a background method. To do so,
136-
* you should use the {@link Background#delay()} field.
137-
* </p>
136+
* you should use the {@link #delay()} field.
137+
* <p/>
138138
* <b>Example</b> :
139139
*
140140
* <pre>

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

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -51,10 +51,8 @@
5151
*
5252
* </blockquote>
5353
*
54+
* @see Touch
5455
* @see LongClick
55-
* @see ItemClick
56-
* @see ItemLongClick
57-
* @see ItemSelect
5856
*/
5957
@Retention(RetentionPolicy.CLASS)
6058
@Target(ElementType.METHOD)

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

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -48,14 +48,11 @@
4848
*
4949
* public void launchAction() {
5050
* // Note the use of generated class instead of original one
51-
* MyIntentService_.intent(this)
52-
* .myAction("test", 10L)
53-
* .start();
51+
* MyIntentService_.intent(this).myAction(&quot;test&quot;, 10L).start();
5452
* }
5553
*
5654
* }
5755
*
58-
* <pre>
5956
* &#064;EIntentService
6057
* public class MyIntentService extends IntentService {
6158
*

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

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -61,8 +61,6 @@
6161
*
6262
* @see ItemLongClick
6363
* @see ItemSelect
64-
* @see Click
65-
* @see LongClick
6664
*/
6765
@Retention(RetentionPolicy.CLASS)
6866
@Target(ElementType.METHOD)

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

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -61,8 +61,6 @@
6161
*
6262
* @see ItemClick
6363
* @see ItemSelect
64-
* @see Click
65-
* @see LongClick
6664
*/
6765
@Retention(RetentionPolicy.CLASS)
6866
@Target(ElementType.METHOD)

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

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -67,8 +67,6 @@
6767
*
6868
* @see ItemClick
6969
* @see ItemLongClick
70-
* @see Click
71-
* @see LongClick
7270
*/
7371
@Retention(RetentionPolicy.CLASS)
7472
@Target(ElementType.METHOD)

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

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -62,10 +62,8 @@
6262
*
6363
* </blockquote>
6464
*
65+
* @see Touch
6566
* @see Click
66-
* @see ItemClick
67-
* @see ItemLongClick
68-
* @see ItemSelect
6967
*/
7068
@Retention(RetentionPolicy.CLASS)
7169
@Target(ElementType.METHOD)

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

Lines changed: 14 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -21,61 +21,47 @@
2121
import java.lang.annotation.Target;
2222

2323
/**
24-
* <blockquote>
25-
*
2624
* This annotation is intended to be used on methods to receive events defined
2725
* by
2826
* {@link android.widget.SeekBar.OnSeekBarChangeListener#onProgressChanged(android.widget.SeekBar, int, boolean)}
2927
* when the progress level of a SeekBar has changed.
30-
*
31-
* </blockquote> <blockquote>
32-
*
28+
* <p/>
3329
* The annotation value should be one or several R.id.* fields that refers to an
3430
* android.widget.SeekBar. If not set, the method name will be used as the
3531
* R.id.* field name.
36-
*
37-
* </blockquote> <blockquote>
38-
*
39-
* The method may have multiple parameter :
40-
*
41-
* </blockquote> <blockquote>
42-
*
32+
* <p/>
33+
* The method MAY have multiple parameter :
34+
* <p/>
4335
* <ul>
4436
* <li>A {@link android.widget.SeekBar} parameter to determine which view has
45-
* targeted this event
46-
* <li>An int parameter to get the progress level of the SeekBar
47-
* <li>A boolean parameter to determine if this event is triggered by the user
37+
* targeted this event</li>
38+
* <li>An <code>int</code> parameter to get the progress level of the SeekBar</li>
39+
* <li>A <code>boolean</code> parameter to determine if this event was triggered
40+
* by the user</li>
4841
* </ul>
49-
*
50-
* </blockquote> <blockquote>
51-
*
42+
* <p/>
5243
* All these parameters are optional. Parameter names do not matter.
44+
* <p/>
45+
* <blockquote>
5346
*
54-
* </blockquote> <blockquote>
55-
*
56-
* Some usage examples of &#064;SeekBarProgressChange annotation:
47+
* Example :
5748
*
5849
* <pre>
5950
* &#064;ProgressChange(<b>R.id.seekBar</b>)
6051
* void onProgressChangeOnSeekBar(SeekBar seekBar, int progress, boolean fromUser) {
6152
* // Something Here
6253
* }
6354
*
64-
*
6555
* &#064;ProgressChange(<b>R.id.seekBar</b>)
6656
* void onProgressChangeOnSeekBar(SeekBar seekBar, int progress) {
6757
* // Something Here
6858
* }
69-
* </pre>
7059
*
71-
* <pre>
7260
* &#064;ProgressChange(<b>{R.id.seekBar1, R.id.seekBar2}</b>)
7361
* void onProgressChangeOnSeekBar(SeekBar seekBar) {
7462
* // Something Here
7563
* }
76-
* </pre>
7764
*
78-
* <pre>
7965
* &#064;ProgressChange(<b>{R.id.seekBar1, R.id.seekBar2}</b>)
8066
* void onProgressChangeOnSeekBar() {
8167
* // Something Here
@@ -86,8 +72,8 @@
8672
*
8773
* @since 2.7
8874
*
89-
* @see org.androidannotations.annotations.SeekBarTouchStart
90-
* @see org.androidannotations.annotations.SeekBarTouchStop
75+
* @see SeekBarTouchStart
76+
* @see SeekBarTouchStop
9177
*/
9278
@Retention(RetentionPolicy.CLASS)
9379
@Target(ElementType.METHOD)

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

Lines changed: 33 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -23,29 +23,53 @@
2323
import android.widget.SeekBar;
2424

2525
/**
26-
* <blockquote>
27-
*
2826
* This annotation is intended to be used on methods to receive events defined
2927
* by
3028
* {@link android.widget.SeekBar.OnSeekBarChangeListener#onStartTrackingTouch(SeekBar seekBar)}
3129
* when the user begins to move the cursor of the targeted SeekBar.
32-
*
33-
* </blockquote> <blockquote>
34-
*
30+
* <p/>
3531
* The annotation value should be one or several R.id.* fields that refers to an
3632
* android.widget.SeekBar. If not set, the method name will be used as the
3733
* R.id.* field name.
34+
* <p/>
35+
* The method MAY have one parameter :
36+
* <ul>
37+
* <li>A {@link android.widget.SeekBar} parameter to determine which view has
38+
* targeted this event</li>
39+
* </ul>
40+
* <p/>
41+
* <blockquote>
42+
*
43+
* Example :
44+
*
45+
* <pre>
46+
* &#064;SeekBarTouchStart(<b>R.id.seekBar</b>)
47+
* void onProgressStartOnSeekBar(SeekBar seekBar) {
48+
* // Something Here
49+
* }
50+
*
51+
* &#064;SeekBarTouchStart(<b>R.id.seekBar</b>)
52+
* void onProgressStartOnSeekBar() {
53+
* // Something Here
54+
* }
3855
*
39-
* </blockquote> <blockquote>
56+
* &#064;SeekBarTouchStart(<b>{R.id.seekBar1, R.id.seekBar2}</b>)
57+
* void onProgressStartOnSeekBar(SeekBar seekBar) {
58+
* // Something Here
59+
* }
4060
*
41-
* The method can have zero or one parameter of type SeekBar.
61+
* &#064;SeekBarTouchStart(<b>{R.id.seekBar1, R.id.seekBar2}</b>)
62+
* void onProgressStartOnSeekBar() {
63+
* // Something Here
64+
* }
65+
* </pre>
4266
*
4367
* </blockquote>
4468
*
4569
* @since 2.7
4670
*
47-
* @see org.androidannotations.annotations.SeekBarTouchStop
48-
* @see org.androidannotations.annotations.SeekBarProgressChange
71+
* @see SeekBarTouchStop
72+
* @see SeekBarProgressChange
4973
*/
5074
@Retention(RetentionPolicy.CLASS)
5175
@Target(ElementType.METHOD)

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

Lines changed: 33 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -23,29 +23,53 @@
2323
import android.widget.SeekBar;
2424

2525
/**
26-
* <blockquote>
27-
*
2826
* This annotation is intended to be used on methods to receive events defined
2927
* by
3028
* {@link android.widget.SeekBar.OnSeekBarChangeListener#onStopTrackingTouch(SeekBar seekBar)}
3129
* when the user has finished to move the cursor of the targeted SeekBar.
32-
*
33-
* </blockquote> <blockquote>
34-
*
30+
* <p/>
3531
* The annotation value should be one or several R.id.* fields that refers to an
3632
* android.widget.SeekBar. If not set, the method name will be used as the
3733
* R.id.* field name.
34+
* <p/>
35+
* The method MAY have one parameter :
36+
* <ul>
37+
* <li>A {@link android.widget.SeekBar} parameter to determine which view has
38+
* targeted this event</li>
39+
* </ul>
40+
* <p/>
41+
* <blockquote>
42+
*
43+
* Example :
44+
*
45+
* <pre>
46+
* &#064;SeekBarTouchStop(<b>R.id.seekBar</b>)
47+
* void onProgressStopOnSeekBar(SeekBar seekBar) {
48+
* // Something Here
49+
* }
50+
*
51+
* &#064;SeekBarTouchStop(<b>R.id.seekBar</b>)
52+
* void onProgressStopOnSeekBar() {
53+
* // Something Here
54+
* }
3855
*
39-
* </blockquote> <blockquote>
56+
* &#064;SeekBarTouchStop(<b>{R.id.seekBar1, R.id.seekBar2}</b>)
57+
* void onProgressStopOnSeekBar(SeekBar seekBar) {
58+
* // Something Here
59+
* }
4060
*
41-
* The method can have zero or one parameter of type SeekBar.
61+
* &#064;SeekBarTouchStop(<b>{R.id.seekBar1, R.id.seekBar2}</b>)
62+
* void onProgressStopOnSeekBar() {
63+
* // Something Here
64+
* }
65+
* </pre>
4266
*
4367
* </blockquote>
4468
*
4569
* @since 2.7
4670
*
47-
* @see org.androidannotations.annotations.SeekBarTouchStart
48-
* @see org.androidannotations.annotations.SeekBarProgressChange
71+
* @see SeekBarTouchStart
72+
* @see SeekBarProgressChange
4973
*/
5074
@Retention(RetentionPolicy.CLASS)
5175
@Target(ElementType.METHOD)

0 commit comments

Comments
 (0)