Skip to content

Commit 1878e0d

Browse files
mathieubonifacemathieuboniface
committed
Enhanced javadoc formatting for @ProgressChange, @TrackingTouchStart and @TrackingTouchStop
1 parent a74b1c8 commit 1878e0d

3 files changed

Lines changed: 43 additions & 9 deletions

File tree

‎AndroidAnnotations/androidannotations/src/main/java/com/googlecode/androidannotations/annotations/ProgressChange.java‎

Lines changed: 19 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -21,16 +21,25 @@
2121
import java.lang.annotation.Target;
2222

2323
/**
24+
* <blockquote>
25+
*
2426
* This annotation is intended to be used on methods to receive events defined
2527
* by
2628
* {@link android.widget.SeekBar.OnSeekBarChangeListener#onProgressChanged(android.widget.SeekBar, int, boolean)}
2729
* when the progress level of a SeekBar has changed.
2830
*
31+
* </blockquote> <blockquote>
32+
*
2933
* The annotation value should be one or several R.id.* fields that refers to an
3034
* android.widget.SeekBar. If not set, the method name will be used as the
3135
* R.id.* field name.
3236
*
37+
* </blockquote> <blockquote>
38+
*
3339
* The method may have multiple parameter :
40+
*
41+
* </blockquote> <blockquote>
42+
*
3443
* <ul>
3544
* <li>A {@link android.widget.SeekBar} parameter to determine which view has
3645
* targeted this event
@@ -39,46 +48,47 @@
3948
* triggered by the user
4049
* </ul>
4150
*
51+
* </blockquote> <blockquote>
52+
*
4253
* All of those parameters are optional.
4354
*
44-
* Some usage examples of &#064;ProgressChange annotation: <blockquote>
55+
* </blockquote> <blockquote>
56+
*
57+
* Some usage examples of &#064;ProgressChange annotation:
4558
*
4659
* <pre>
4760
* &#064;ProgressChange(<b>R.id.seekBar</b>)
4861
* void onProgressChangeOnSeekBar(SeekBar seekBar, int progress, boolean fromUser) {
4962
* // Something Here
5063
* }
51-
* </pre>
5264
*
53-
* </blockquote> <blockquote>
5465
*
55-
* <pre>
5666
* &#064;ProgressChange(<b>R.id.seekBar</b>)
5767
* void onProgressChangeOnSeekBar(SeekBar seekBar, int progress) {
5868
* // Something Here
5969
* }
6070
* </pre>
6171
*
62-
* </blockquote> <blockquote>
63-
*
6472
* <pre>
6573
* &#064;ProgressChange(<b>{R.id.seekBar1, R.id.seekBar2}</b>)
6674
* void onProgressChangeOnSeekBar(SeekBar seekBar) {
6775
* // Something Here
6876
* }
6977
* </pre>
7078
*
71-
* </blockquote> <blockquote>
72-
*
7379
* <pre>
7480
* &#064;ProgressChange(<b>{R.id.seekBar1, R.id.seekBar2}</b>)
7581
* void onProgressChangeOnSeekBar() {
7682
* // Something Here
7783
* }
7884
* </pre>
7985
*
80-
* </blockquote> <blockquote>
86+
* </blockquote>
87+
*
88+
* @since 2.7
8189
*
90+
* @see com.googlecode.androidannotations.annotations.TrackingTouchStart
91+
* @see com.googlecode.androidannotations.annotations.TrackingTouchStop
8292
*/
8393
@Retention(RetentionPolicy.CLASS)
8494
@Target(ElementType.METHOD)

‎AndroidAnnotations/androidannotations/src/main/java/com/googlecode/androidannotations/annotations/TrackingTouchStart.java‎

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

2525
/**
26+
* <blockquote>
27+
*
2628
* This annotation is intended to be used on methods to receive events defined
2729
* by
2830
* {@link android.widget.SeekBar.OnSeekBarChangeListener#onStartTrackingTouch(SeekBar seekBar)}
2931
* when the user begins to move the cursor of the targeted SeekBar.
3032
*
33+
* </blockquote> <blockquote>
34+
*
3135
* The annotation value should be one or several R.id.* fields that refers to an
3236
* android.widget.SeekBar. If not set, the method name will be used as the
3337
* R.id.* field name.
3438
*
39+
* </blockquote> <blockquote>
40+
*
3541
* The method can have zero or one parameter of type SeekBar.
3642
*
43+
* </blockquote>
44+
*
45+
* @since 2.7
46+
*
47+
* @see com.googlecode.androidannotations.annotations.TrackingTouchStop
48+
* @see com.googlecode.androidannotations.annotations.ProgressChange
3749
*/
3850
@Retention(RetentionPolicy.CLASS)
3951
@Target(ElementType.METHOD)

‎AndroidAnnotations/androidannotations/src/main/java/com/googlecode/androidannotations/annotations/TrackingTouchStop.java‎

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

2525
/**
26+
* <blockquote>
27+
*
2628
* This annotation is intended to be used on methods to receive events defined
2729
* by
2830
* {@link android.widget.SeekBar.OnSeekBarChangeListener#onStopTrackingTouch(SeekBar seekBar)}
2931
* when the user has finished to move the cursor of the targeted SeekBar.
3032
*
33+
* </blockquote> <blockquote>
34+
*
3135
* The annotation value should be one or several R.id.* fields that refers to an
3236
* android.widget.SeekBar. If not set, the method name will be used as the
3337
* R.id.* field name.
3438
*
39+
* </blockquote> <blockquote>
40+
*
3541
* The method can have zero or one parameter of type SeekBar.
3642
*
43+
* </blockquote>
44+
*
45+
* @since 2.7
46+
*
47+
* @see com.googlecode.androidannotations.annotations.TrackingTouchStart
48+
* @see com.googlecode.androidannotations.annotations.ProgressChange
3749
*/
3850
@Retention(RetentionPolicy.CLASS)
3951
@Target(ElementType.METHOD)

0 commit comments

Comments
 (0)