Skip to content

Commit 051cdb3

Browse files
committed
Merge pull request androidannotations#1168 from nbelikov/1163_javadoc_for_jdk8
Fix JavaDoc compilation errors on JDK8
2 parents d65f5af + 2836248 commit 051cdb3

5 files changed

Lines changed: 30 additions & 19 deletions

File tree

AndroidAnnotations/androidannotations-api/src/main/java/org/androidannotations/annotations/IgnoredWhenDetached.java

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,17 +21,22 @@
2121
import java.lang.annotation.Target;
2222

2323
/**
24+
* <p>
2425
* When used standalone in an {@link EFragment} or in conjunction with the
2526
* {@link UiThread} or {@link Background} annotations, the annotated method will
2627
* be wrapped in an 'if attached' block such that no code will be executed if
2728
* the {@link EFragment} is no longer bound to its parent activity.
28-
* <p/>
29+
* </p>
30+
* <p>
2931
* Should be used on method that must meet the following criteria
30-
* <p/>
32+
* </p>
33+
* <p>
3134
* 1) Can only be used in conjunction with classes annotated with
3235
* {@link EFragment}
33-
* <p/>
36+
* </p>
37+
* <p>
3438
* 2) The annotated method MUST return void and MAY contain parameters.
39+
* </p>
3540
*
3641
* <blockquote> <b>Example</b> :
3742
*

AndroidAnnotations/androidannotations-api/src/main/java/org/androidannotations/annotations/Receiver.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -70,10 +70,10 @@
7070
* &#064;Receiver(actions = {@link android.net.wifi.WifiManager#WIFI_STATE_CHANGED_ACTION}, registerAt = RegisterAt.OnResumeOnPause)
7171
* public void onWifiStateChangedWithoutIntent();
7272
*
73-
* &#064;Receiver(actions = {@link android.Intent.ACTION_VIEW}, dataSchemes = "http")
73+
* &#064;Receiver(actions = {@link android.content.Intent#ACTION_VIEW}, dataSchemes = "http")
7474
* public void onHttpUrlOpened(Intent intent);
7575
*
76-
* &#064;Receiver(actions = {@link android.Intent.ACTION_VIEW}, dataSchemes = {"http", "https"})
76+
* &#064;Receiver(actions = {@link android.content.Intent#ACTION_VIEW}, dataSchemes = {"http", "https"})
7777
* public void onHttpOrHttpsUrlOpened(Intent intent);
7878
*
7979
* }

AndroidAnnotations/androidannotations-api/src/main/java/org/androidannotations/annotations/SupposeBackground.java

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,12 +23,13 @@
2323
import java.lang.annotation.Target;
2424

2525
/**
26+
* <p>
2627
* Ensures that the method is called from the background thread with (optionally) restrictions by allowed serials.
2728
* If it is not called from a supposed background thread, then {@link IllegalStateException}
2829
* will be thrown (by default).
29-
* <p/>
30+
* </p>
3031
* <blockquote> <b>Example</b> :
31-
* <p/>
32+
*
3233
* <pre>
3334
* &#064;EBean
3435
* public class MyBean {
@@ -46,7 +47,6 @@
4647
*
4748
* }
4849
* </pre>
49-
* <p/>
5050
* </blockquote>
5151
*
5252
* @see BackgroundExecutor#setWrongThreadListener(BackgroundExecutor.WrongThreadListener)
@@ -58,7 +58,8 @@
5858
public @interface SupposeBackground {
5959

6060
/**
61-
* Allowed serials to restrict a calling thread. If it is an empty list, then any background thread is allowed.
61+
* @return Allowed serials to restrict a calling thread. If it is an empty list,
62+
* then any background thread is allowed.
6263
*
6364
* @see BackgroundExecutor#checkBgThread(String...)
6465
*/

AndroidAnnotations/androidannotations-api/src/main/java/org/androidannotations/annotations/WakeLock.java

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929
* </p>
3030
* <p>
3131
* <b>NOTE</b>: To use WakeLocks you need the
32-
* {@link android.permission.WAKE_LOCK} permission.
32+
* <i>android.permission.WAKE_LOCK</i> permission.
3333
* </p>
3434
*
3535
* <b>Example</b>:
@@ -62,34 +62,34 @@
6262

6363
public enum Level {
6464
/**
65-
* @see android.os.PowerManager.FULL_WAKE_LOCK
65+
* @see android.os.PowerManager#FULL_WAKE_LOCK
6666
*/
6767
FULL_WAKE_LOCK,
6868

6969
/**
70-
* @see android.os.PowerManager.PARTIAL_WAKE_LOCK
70+
* @see android.os.PowerManager#PARTIAL_WAKE_LOCK
7171
*/
7272
PARTIAL_WAKE_LOCK,
7373

7474
/**
75-
* @see android.os.PowerManager.SCREEN_BRIGHT_WAKE_LOCK
75+
* @see android.os.PowerManager#SCREEN_BRIGHT_WAKE_LOCK
7676
*/
7777
SCREEN_BRIGHT_WAKE_LOCK,
7878

7979
/**
80-
* @see android.os.PowerManager.SCREEN_DIM_WAKE_LOCK
80+
* @see android.os.PowerManager#SCREEN_DIM_WAKE_LOCK
8181
*/
8282
SCREEN_DIM_WAKE_LOCK;
8383
}
8484

8585
public enum Flag {
8686
/**
87-
* @see android.os.PowerManager.ACQUIRE_CAUSES_WAKEUP
87+
* @see android.os.PowerManager#ACQUIRE_CAUSES_WAKEUP
8888
*/
8989
ACQUIRE_CAUSES_WAKEUP,
9090

9191
/**
92-
* @see android.os.PowerManager.ON_AFTER_RELEASE
92+
* @see android.os.PowerManager#ON_AFTER_RELEASE
9393
*/
9494
ON_AFTER_RELEASE
9595
}

AndroidAnnotations/androidannotations-api/src/main/java/org/androidannotations/annotations/sharedpreferences/DefaultStringSet.java

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,15 +23,19 @@
2323
import org.androidannotations.annotations.ResId;
2424

2525
/**
26+
* <p>
2627
* Use on methods in {@link SharedPref} annotated class. The generated method
2728
* will return an empty {@link java.util.Set} of Strings by default.
28-
* <p/>
29+
* </p>
30+
* <p>
2931
* The key of the preference will be the method name by default. This can be
3032
* overridden by specifying a string resource with the {@link #keyRes()}
3133
* parameter.
32-
* <p/>
34+
* </p>
35+
* <p>
3336
* <b>Implementation note:</b>
34-
* <p/>
37+
* </p>
38+
* <p>
3539
* Since {@code SharedPreferences.getStringSet} is only available from API 11,
3640
* the generated method serializes the {@code Set<String>} into a {@code String}
3741
* , and persists it with
@@ -40,6 +44,7 @@
4044
* From API 11 and up, the generated method simply uses the native
4145
* {@link android.content.SharedPreferences SharedPreferences}
4246
* {@code Set<String>} methods.
47+
* </p>
4348
*/
4449
@Retention(RetentionPolicy.CLASS)
4550
@Target(ElementType.METHOD)

0 commit comments

Comments
 (0)