Skip to content

Commit aee04f2

Browse files
nbransbynbransby
committed
add javadoc generation
1 parent 71582e2 commit aee04f2

12 files changed

+75
-77
lines changed

‎build.gradle.kts

+1
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ version = project.property("version") as String
2727

2828
java {
2929
withSourcesJar()
30+
withJavadocJar()
3031
sourceCompatibility = JavaVersion.VERSION_11
3132
}
3233

‎src/main/java/android/os/Parcelable.java

-3
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,6 @@
5858
* }</pre>
5959
*/
6060
public interface Parcelable {
61-
/** @hide */
6261
@IntDef(flag = true, prefix = { "PARCELABLE_" }, value = {
6362
PARCELABLE_WRITE_RETURN_VALUE,
6463
PARCELABLE_ELIDE_DUPLICATES,
@@ -82,7 +81,6 @@ public interface Parcelable {
8281
* across its inner data members. This flag instructs the inner data
8382
* types to omit that data during marshaling. Exact behavior may vary
8483
* on a case by case basis.
85-
* @hide
8684
*/
8785
public static final int PARCELABLE_ELIDE_DUPLICATES = 0x0002;
8886

@@ -92,7 +90,6 @@ public interface Parcelable {
9290
* marshalled.
9391
*/
9492

95-
/** @hide */
9693
@IntDef(flag = true, prefix = { "CONTENTS_" }, value = {
9794
CONTENTS_FILE_DESCRIPTOR,
9895
})

‎src/main/java/android/os/RemoteException.java

+3-3
Original file line numberDiff line numberDiff line change
@@ -30,13 +30,13 @@ public RemoteException(String message) {
3030
super(message);
3131
}
3232

33-
/** @hide */
33+
/** */
3434
public RemoteException(String message, Throwable cause, boolean enableSuppression,
3535
boolean writableStackTrace) {
3636
super(message, cause, enableSuppression, writableStackTrace);
3737
}
3838

39-
/** {@hide} */
39+
/** {} */
4040
public RuntimeException rethrowAsRuntimeException() {
4141
throw new RuntimeException(this);
4242
}
@@ -52,7 +52,7 @@ public RuntimeException rethrowAsRuntimeException() {
5252
* failure of a call, or any default values returned. For this reason, we
5353
* want to strongly throw when there was trouble with the transaction.
5454
*
55-
* @hide
55+
*
5656
*/
5757
public RuntimeException rethrowFromSystemServer() {
5858
if (this instanceof DeadObjectException) {

‎src/main/java/android/text/Spannable.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ public interface Spannable
5252
*
5353
* See {@link Spanned} for an explanation of what the flags mean.
5454
*
55-
* @hide
55+
*
5656
*/
5757
default void removeSpan(Object what, int flags) {
5858
removeSpan(what);

‎src/main/java/android/text/TextUtils.java

+54-54
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ public class TextUtils {
4848
private static final String ELLIPSIS_NORMAL = "\u2026"; // HORIZONTAL ELLIPSIS (…)
4949
private static final String ELLIPSIS_TWO_DOTS = "\u2025"; // TWO DOT LEADER (‥)
5050

51-
/** {@hide} */
51+
/** {} */
5252
@NonNull
5353
public static String getEllipsisString(@NonNull TruncateAt method) {
5454
return (method == TruncateAt.END_SMALL) ? ELLIPSIS_TWO_DOTS : ELLIPSIS_NORMAL;
@@ -373,8 +373,8 @@ public interface StringSplitter extends Iterable<String> {
373373
* A simple string splitter.
374374
*
375375
* <p>If the final character in the string to split is the delimiter then no empty string will
376-
* be returned for the empty string after that delimeter. That is, splitting <tt>"a,b,"</tt> on
377-
* comma will return <tt>"a", "b"</tt>, not <tt>"a", "b", ""</tt>.
376+
* be returned for the empty string after that delimeter. That is, splitting "a,b," on
377+
* comma will return "a", "b", not "a", "b", "".
378378
*/
379379
public static class SimpleStringSplitter implements StringSplitter, Iterator<String> {
380380
private String mString;
@@ -443,29 +443,29 @@ public static boolean isEmpty(@Nullable CharSequence str) {
443443
return str == null || str.length() == 0;
444444
}
445445

446-
/** {@hide} */
446+
/** {} */
447447
public static String nullIfEmpty(@Nullable String str) {
448448
return isEmpty(str) ? null : str;
449449
}
450450

451-
/** {@hide} */
451+
/** {} */
452452
public static String emptyIfNull(@Nullable String str) {
453453
return str == null ? "" : str;
454454
}
455455

456-
/** {@hide} */
456+
/** {} */
457457
public static String firstNotEmpty(@Nullable String a, @NonNull String b) {
458458
return !isEmpty(a) ? a : Preconditions.checkStringNotEmpty(b);
459459
}
460460

461-
/** {@hide} */
461+
/** {} */
462462
public static int length(@Nullable String s) {
463463
return isEmpty(s) ? 0 : s.length();
464464
}
465465

466466
/**
467467
* @return interned string if it's null.
468-
* @hide
468+
*
469469
*/
470470
public static String safeIntern(String s) {
471471
return (s != null) ? s.intern() : null;
@@ -577,61 +577,61 @@ public void getChars(int start, int end, char[] dest, int destoff) {
577577
private int mEnd;
578578
}
579579

580-
/** @hide */
580+
/** */
581581
public static final int ALIGNMENT_SPAN = 1;
582-
/** @hide */
582+
/** */
583583
public static final int FIRST_SPAN = ALIGNMENT_SPAN;
584-
/** @hide */
584+
/** */
585585
public static final int FOREGROUND_COLOR_SPAN = 2;
586-
/** @hide */
586+
/** */
587587
public static final int RELATIVE_SIZE_SPAN = 3;
588-
/** @hide */
588+
/** */
589589
public static final int SCALE_X_SPAN = 4;
590-
/** @hide */
590+
/** */
591591
public static final int STRIKETHROUGH_SPAN = 5;
592-
/** @hide */
592+
/** */
593593
public static final int UNDERLINE_SPAN = 6;
594-
/** @hide */
594+
/** */
595595
public static final int STYLE_SPAN = 7;
596-
/** @hide */
596+
/** */
597597
public static final int BULLET_SPAN = 8;
598-
/** @hide */
598+
/** */
599599
public static final int QUOTE_SPAN = 9;
600-
/** @hide */
600+
/** */
601601
public static final int LEADING_MARGIN_SPAN = 10;
602-
/** @hide */
602+
/** */
603603
public static final int URL_SPAN = 11;
604-
/** @hide */
604+
/** */
605605
public static final int BACKGROUND_COLOR_SPAN = 12;
606-
/** @hide */
606+
/** */
607607
public static final int TYPEFACE_SPAN = 13;
608-
/** @hide */
608+
/** */
609609
public static final int SUPERSCRIPT_SPAN = 14;
610-
/** @hide */
610+
/** */
611611
public static final int SUBSCRIPT_SPAN = 15;
612-
/** @hide */
612+
/** */
613613
public static final int ABSOLUTE_SIZE_SPAN = 16;
614-
/** @hide */
614+
/** */
615615
public static final int TEXT_APPEARANCE_SPAN = 17;
616-
/** @hide */
616+
/** */
617617
public static final int ANNOTATION = 18;
618-
/** @hide */
618+
/** */
619619
public static final int SUGGESTION_SPAN = 19;
620-
/** @hide */
620+
/** */
621621
public static final int SPELL_CHECK_SPAN = 20;
622-
/** @hide */
622+
/** */
623623
public static final int SUGGESTION_RANGE_SPAN = 21;
624-
/** @hide */
624+
/** */
625625
public static final int EASY_EDIT_SPAN = 22;
626-
/** @hide */
626+
/** */
627627
public static final int LOCALE_SPAN = 23;
628-
/** @hide */
628+
/** */
629629
public static final int TTS_SPAN = 24;
630-
/** @hide */
630+
/** */
631631
public static final int ACCESSIBILITY_CLICKABLE_SPAN = 25;
632-
/** @hide */
632+
/** */
633633
public static final int ACCESSIBILITY_URL_SPAN = 26;
634-
/** @hide */
634+
/** */
635635
public static final int LAST_SPAN = ACCESSIBILITY_URL_SPAN;
636636

637637
/**
@@ -1069,7 +1069,7 @@ public static void copySpansFrom(Spanned source, int start, int end,
10691069
*
10701070
* If copySpans is set, source must be an instance of Spanned.
10711071
*
1072-
* {@hide}
1072+
* {}
10731073
*/
10741074
@NonNull
10751075
public static CharSequence toUpperCase(@Nullable Locale locale, @NonNull CharSequence source,
@@ -1137,7 +1137,7 @@ public enum TruncateAt {
11371137
END,
11381138
MARQUEE,
11391139
/**
1140-
* @hide
1140+
*
11411141
*/
11421142
END_SMALL
11431143
}
@@ -1195,7 +1195,7 @@ public static CharSequence ellipsize(CharSequence text,
11951195
* If <code>callback</code> is non-null, it will be called to
11961196
* report the start and end of the ellipsized range.
11971197
*
1198-
* @hide
1198+
*
11991199
*/
12001200
public static CharSequence ellipsize(CharSequence text,
12011201
TextPaint paint,
@@ -1383,7 +1383,7 @@ public static CharSequence ellipsize(CharSequence text,
13831383
* @deprecated Do not use. This is not internationalized, and has known issues
13841384
* with right-to-left text, languages that have more than one plural form, languages
13851385
* that use a different character as a comma-like separator, etc.
1386-
* Use {@link #listEllipsize} instead.
1386+
* Use listEllipsize instead.
13871387
*/
13881388
@Deprecated
13891389
public static CharSequence commaEllipsize(CharSequence text,
@@ -1395,7 +1395,7 @@ public static CharSequence commaEllipsize(CharSequence text,
13951395
}
13961396

13971397
/**
1398-
* @hide
1398+
*
13991399
*/
14001400
@Deprecated
14011401
public static CharSequence commaEllipsize(CharSequence text, TextPaint p,
@@ -1667,7 +1667,7 @@ public static boolean isDigitsOnly(CharSequence str) {
16671667
}
16681668

16691669
/**
1670-
* @hide
1670+
*
16711671
*/
16721672
public static boolean isPrintableAscii(final char c) {
16731673
final int asciiFirst = 0x20;
@@ -1676,7 +1676,7 @@ public static boolean isPrintableAscii(final char c) {
16761676
}
16771677

16781678
/**
1679-
* @hide
1679+
*
16801680
*/
16811681
public static boolean isPrintableAsciiOnly(final CharSequence str) {
16821682
final int len = str.length();
@@ -1822,7 +1822,7 @@ public static int getCapsMode(CharSequence cs, int off, int reqModes) {
18221822
* Does a comma-delimited list 'delimitedString' contain a certain item?
18231823
* (without allocating memory)
18241824
*
1825-
* @hide
1825+
*
18261826
*/
18271827
public static boolean delimitedStringContains(
18281828
String delimitedString, char delimiter, String item) {
@@ -1862,7 +1862,7 @@ public static boolean delimitedStringContains(
18621862
* @param spanned The Spanned from which spans were extracted
18631863
* @return A subset of spans where empty spans ({@link Spanned#getSpanStart(Object)} ==
18641864
* {@link Spanned#getSpanEnd(Object)} have been removed. The initial order is preserved
1865-
* @hide
1865+
*
18661866
*/
18671867
@SuppressWarnings("unchecked")
18681868
public static <T> T[] removeEmptySpans(T[] spans, Spanned spanned, Class<T> klass) {
@@ -1901,7 +1901,7 @@ public static <T> T[] removeEmptySpans(T[] spans, Spanned spanned, Class<T> klas
19011901
* Pack 2 int values into a long, useful as a return value for a range
19021902
* @see #unpackRangeStartFromLong(long)
19031903
* @see #unpackRangeEndFromLong(long)
1904-
* @hide
1904+
*
19051905
*/
19061906
public static long packRangeInLong(int start, int end) {
19071907
return (((long) start) << 32) | end;
@@ -1911,7 +1911,7 @@ public static long packRangeInLong(int start, int end) {
19111911
* Get the start value from a range packed in a long by {@link #packRangeInLong(int, int)}
19121912
* @see #unpackRangeEndFromLong(long)
19131913
* @see #packRangeInLong(int, int)
1914-
* @hide
1914+
*
19151915
*/
19161916
public static int unpackRangeStartFromLong(long range) {
19171917
return (int) (range >>> 32);
@@ -1921,7 +1921,7 @@ public static int unpackRangeStartFromLong(long range) {
19211921
* Get the end value from a range packed in a long by {@link #packRangeInLong(int, int)}
19221922
* @see #unpackRangeStartFromLong(long)
19231923
* @see #packRangeInLong(int, int)
1924-
* @hide
1924+
*
19251925
*/
19261926
public static int unpackRangeEndFromLong(long range) {
19271927
return (int) (range & 0x00000000FFFFFFFFL);
@@ -1949,15 +1949,15 @@ public static int unpackRangeEndFromLong(long range) {
19491949
// /**
19501950
// * Return localized string representing the given number of selected items.
19511951
// *
1952-
// * @hide
1952+
// *
19531953
// */
19541954
// public static CharSequence formatSelectedCount(int count) {
19551955
// return Resources.getSystem().getQuantityString(R.plurals.selected_count, count, count);
19561956
// }
19571957

19581958
/**
19591959
* Returns whether or not the specified spanned text has a style span.
1960-
* @hide
1960+
*
19611961
*/
19621962
public static boolean hasStyleSpan(@NonNull Spanned spanned) {
19631963
Preconditions.checkArgument(spanned != null);
@@ -1976,7 +1976,7 @@ public static boolean hasStyleSpan(@NonNull Spanned spanned) {
19761976
* {@link NoCopySpan}'s are removed from the copy. Otherwise the given {@code charSequence} is
19771977
* returned as it is.
19781978
*
1979-
* @hide
1979+
*
19801980
*/
19811981
@Nullable
19821982
public static CharSequence trimNoCopySpans(@Nullable CharSequence charSequence) {
@@ -1990,7 +1990,7 @@ public static CharSequence trimNoCopySpans(@Nullable CharSequence charSequence)
19901990
/**
19911991
* Prepends {@code start} and appends {@code end} to a given {@link StringBuilder}
19921992
*
1993-
* @hide
1993+
*
19941994
*/
19951995
public static void wrap(StringBuilder builder, String start, String end) {
19961996
builder.insert(0, start);
@@ -2008,7 +2008,7 @@ public static void wrap(StringBuilder builder, String start, String end) {
20082008
* the length() is smaller than {@link #PARCEL_SAFE_TEXT_LENGTH}. Used for text that is parceled
20092009
* into a {@link Parcelable}.
20102010
*
2011-
* @hide
2011+
*
20122012
*/
20132013
@Nullable
20142014
public static <T extends CharSequence> T trimToParcelableSize(@Nullable T text) {
@@ -2022,7 +2022,7 @@ public static <T extends CharSequence> T trimToParcelableSize(@Nullable T text)
20222022
*
20232023
* @param size length of the result, should be greater than 0
20242024
*
2025-
* @hide
2025+
*
20262026
*/
20272027
@Nullable
20282028
public static <T extends CharSequence> T trimToSize(@Nullable T text,

‎src/main/java/android/util/AndroidException.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ public AndroidException(Exception cause) {
3535
super(cause);
3636
}
3737

38-
/** @hide */
38+
/** */
3939
protected AndroidException(String message, Throwable cause, boolean enableSuppression,
4040
boolean writableStackTrace) {
4141
super(message, cause, enableSuppression, writableStackTrace);

‎src/main/java/android/util/Base64OutputStream.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ public Base64OutputStream(OutputStream out, int flags) {
5555
* constants in {@link Base64}
5656
* @param encode true to encode, false to decode
5757
*
58-
* @hide
58+
*
5959
*/
6060
public Base64OutputStream(OutputStream out, int flags, boolean encode) {
6161
super(out);

0 commit comments

Comments
 (0)