Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 6503bd8e authored by Jeff Sharkey's avatar Jeff Sharkey
Browse files

Auto-generate docs based on annotations. 

We have a handful of annotations that we've been sprinkling across
the platform APIs, such as @Nullable, @NonNull, @IntDef, etc.  It
would be really helpful to surface these contracts to developers
through the SDK docs.

This change allows annotations like those mentioned above to declare
the following new javadoc fields:

@memberDoc: docs to append to a field or method definition.
@paramDoc: docs to append to a @param definition.
@returnDoc: docs to append to a @return definition.

This change also builds a docstring to describe the list of all
constants listed in an @IntDef annotation.  Sadly AnnotationDesc
only passes along raw constant values, so we need the help of the
new "prefix" annotation argument to help find the field names.

Test: builds
Bug: 37526420
Change-Id: I4cfc00dd904e5dfa945b406d546e36846b7c0c28
parent 4132f860

core/java/android/annotation/BytesLong.java

0 → 100644
+36 −0
Original line number Original line Diff line number Diff line 
/*

 * Copyright (C) 2017 The Android Open Source Project

 *

 * Licensed under the Apache License, Version 2.0 (the "License");

 * you may not use this file except in compliance with the License.

 * You may obtain a copy of the License at

 *

 *      http://www.apache.org/licenses/LICENSE-2.0

 *

 * Unless required by applicable law or agreed to in writing, software

 * distributed under the License is distributed on an "AS IS" BASIS,

 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

 * See the License for the specific language governing permissions and

 * limitations under the License.

 */



package android.annotation;



import static java.lang.annotation.ElementType.FIELD;

import static java.lang.annotation.ElementType.METHOD;

import static java.lang.annotation.ElementType.PARAMETER;

import static java.lang.annotation.RetentionPolicy.SOURCE;



import java.lang.annotation.Retention;

import java.lang.annotation.Target;



/**

 * @memberDoc Value is a non-negative number of bytes.

 * @paramDoc Value is a non-negative number of bytes.

 * @returnDoc Value is a non-negative number of bytes.

 * @hide

 */

@Retention(SOURCE)

@Target({METHOD, PARAMETER, FIELD})

public @interface BytesLong {

}

core/java/android/annotation/CurrentTimeMillisLong.java

0 → 100644
+39 −0
Original line number Original line Diff line number Diff line 
/*

 * Copyright (C) 2017 The Android Open Source Project

 *

 * Licensed under the Apache License, Version 2.0 (the "License");

 * you may not use this file except in compliance with the License.

 * You may obtain a copy of the License at

 *

 *      http://www.apache.org/licenses/LICENSE-2.0

 *

 * Unless required by applicable law or agreed to in writing, software

 * distributed under the License is distributed on an "AS IS" BASIS,

 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

 * See the License for the specific language governing permissions and

 * limitations under the License.

 */



package android.annotation;



import static java.lang.annotation.ElementType.FIELD;

import static java.lang.annotation.ElementType.METHOD;

import static java.lang.annotation.ElementType.PARAMETER;

import static java.lang.annotation.RetentionPolicy.SOURCE;



import java.lang.annotation.Retention;

import java.lang.annotation.Target;



/**

 * @memberDoc Value is a non-negative timestamp in the

 *            {@link System#currentTimeMillis()} time base.

 * @paramDoc Value is a non-negative timestamp in the

 *           {@link System#currentTimeMillis()} time base.

 * @returnDoc Value is a non-negative timestamp in the

 *            {@link System#currentTimeMillis()} time base.

 * @hide

 */

@Retention(SOURCE)

@Target({METHOD, PARAMETER, FIELD})

public @interface CurrentTimeMillisLong {

}

core/java/android/annotation/DurationMillisLong.java

0 → 100644
+36 −0
Original line number Original line Diff line number Diff line 
/*

 * Copyright (C) 2017 The Android Open Source Project

 *

 * Licensed under the Apache License, Version 2.0 (the "License");

 * you may not use this file except in compliance with the License.

 * You may obtain a copy of the License at

 *

 *      http://www.apache.org/licenses/LICENSE-2.0

 *

 * Unless required by applicable law or agreed to in writing, software

 * distributed under the License is distributed on an "AS IS" BASIS,

 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

 * See the License for the specific language governing permissions and

 * limitations under the License.

 */



package android.annotation;



import static java.lang.annotation.ElementType.FIELD;

import static java.lang.annotation.ElementType.METHOD;

import static java.lang.annotation.ElementType.PARAMETER;

import static java.lang.annotation.RetentionPolicy.SOURCE;



import java.lang.annotation.Retention;

import java.lang.annotation.Target;



/**

 * @memberDoc Value is a non-negative duration in milliseconds.

 * @paramDoc Value is a non-negative duration in milliseconds.

 * @returnDoc Value is a non-negative duration in milliseconds.

 * @hide

 */

@Retention(SOURCE)

@Target({METHOD, PARAMETER, FIELD})

public @interface DurationMillisLong {

}

core/java/android/annotation/ElapsedRealtimeLong.java

0 → 100644
+41 −0
Original line number Original line Diff line number Diff line 
/*

 * Copyright (C) 2017 The Android Open Source Project

 *

 * Licensed under the Apache License, Version 2.0 (the "License");

 * you may not use this file except in compliance with the License.

 * You may obtain a copy of the License at

 *

 *      http://www.apache.org/licenses/LICENSE-2.0

 *

 * Unless required by applicable law or agreed to in writing, software

 * distributed under the License is distributed on an "AS IS" BASIS,

 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

 * See the License for the specific language governing permissions and

 * limitations under the License.

 */



package android.annotation;



import static java.lang.annotation.ElementType.FIELD;

import static java.lang.annotation.ElementType.METHOD;

import static java.lang.annotation.ElementType.PARAMETER;

import static java.lang.annotation.RetentionPolicy.SOURCE;



import android.os.SystemClock;



import java.lang.annotation.Retention;

import java.lang.annotation.Target;



/**

 * @memberDoc Value is a non-negative timestamp in the

 *            {@link SystemClock#elapsedRealtime()} time base.

 * @paramDoc Value is a non-negative timestamp in the

 *           {@link SystemClock#elapsedRealtime()} time base.

 * @returnDoc Value is a non-negative timestamp in the

 *            {@link SystemClock#elapsedRealtime()} time base.

 * @hide

 */

@Retention(SOURCE)

@Target({METHOD, PARAMETER, FIELD})

public @interface ElapsedRealtimeLong {

}

core/java/android/annotation/IntDef.java

+3 −0
Original line number Original line Diff line number Diff line
@@ -51,6 +51,9 @@ import static java.lang.annotation.RetentionPolicy.CLASS; 
@Retention(CLASS)

@Retention(CLASS)

@Target({ANNOTATION_TYPE})

@Target({ANNOTATION_TYPE})

public @interface IntDef {

public @interface IntDef {

    /** Defines the constant prefix for this element */

    String[] prefix() default "";



    /** Defines the allowed constants for this element */

    /** Defines the allowed constants for this element */

    long[] value() default {};

    long[] value() default {};