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

Commit 08398d92 authored by Anton Hansson's avatar Anton Hansson
Browse files

Fix broken docs in media 

IntDefs are not present in the generated documentation, so can not
be referenced via @link/@see tags. Additionally, the "one of ..."
strings are auto-generated via the presence of IntDef, so shouldn't
be enumerated manually.

Bug: 303184203
Test: m docs
Change-Id: I70173065912abf7df11f480a858f4c50c5a9a74e
parent 7039b4f7

media/java/android/media/AudioAttributes.java

+1 −12
Original line number Diff line number Diff line
@@ -875,18 +875,7 @@ public final class AudioAttributes implements Parcelable { 
        /**

         * Sets the attribute describing what is the intended use of the audio signal,

         * such as alarm or ringtone.

         * @param usage one of {@link AttributeSdkUsage#USAGE_UNKNOWN},

         *     {@link AttributeSdkUsage#USAGE_MEDIA},

         *     {@link AttributeSdkUsage#USAGE_VOICE_COMMUNICATION},

         *     {@link AttributeSdkUsage#USAGE_VOICE_COMMUNICATION_SIGNALLING},

         *     {@link AttributeSdkUsage#USAGE_ALARM}, {@link AudioAttributes#USAGE_NOTIFICATION},

         *     {@link AttributeSdkUsage#USAGE_NOTIFICATION_RINGTONE},

         *     {@link AttributeSdkUsage#USAGE_NOTIFICATION_EVENT},

         *     {@link AttributeSdkUsage#USAGE_ASSISTANT},

         *     {@link AttributeSdkUsage#USAGE_ASSISTANCE_ACCESSIBILITY},

         *     {@link AttributeSdkUsage#USAGE_ASSISTANCE_NAVIGATION_GUIDANCE},

         *     {@link AttributeSdkUsage#USAGE_ASSISTANCE_SONIFICATION},

         *     {@link AttributeSdkUsage#USAGE_GAME}.

         * @param usage the usage to set.

         * @return the same Builder instance.

         */

        public Builder setUsage(@AttributeSdkUsage int usage) {

media/java/android/media/AudioMetadata.java

+9 −10
Original line number Diff line number Diff line
@@ -226,16 +226,15 @@ public final class AudioMetadata { 
         *

         * An Integer value representing presentation content classifier.

         *

         * @see AudioPresentation.ContentClassifier

         * One of {@link AudioPresentation#CONTENT_UNKNOWN},

         *     {@link AudioPresentation#CONTENT_MAIN},

         *     {@link AudioPresentation#CONTENT_MUSIC_AND_EFFECTS},

         *     {@link AudioPresentation#CONTENT_VISUALLY_IMPAIRED},

         *     {@link AudioPresentation#CONTENT_HEARING_IMPAIRED},

         *     {@link AudioPresentation#CONTENT_DIALOG},

         *     {@link AudioPresentation#CONTENT_COMMENTARY},

         *     {@link AudioPresentation#CONTENT_EMERGENCY},

         *     {@link AudioPresentation#CONTENT_VOICEOVER}.

         * @see AudioPresentation#CONTENT_UNKNOWN

         * @see AudioPresentation#CONTENT_MAIN

         * @see AudioPresentation#CONTENT_MUSIC_AND_EFFECTS

         * @see AudioPresentation#CONTENT_VISUALLY_IMPAIRED

         * @see AudioPresentation#CONTENT_HEARING_IMPAIRED

         * @see AudioPresentation#CONTENT_DIALOG

         * @see AudioPresentation#CONTENT_COMMENTARY

         * @see AudioPresentation#CONTENT_EMERGENCY

         * @see AudioPresentation#CONTENT_VOICEOVER

         */

        @NonNull public static final Key<Integer> KEY_PRESENTATION_CONTENT_CLASSIFIER =

                createKey("presentation-content-classifier", Integer.class);

media/java/android/media/tv/SectionRequest.java

+1 −1
Original line number Diff line number Diff line
@@ -81,7 +81,7 @@ public final class SectionRequest extends BroadcastInfoRequest implements Parcel 
    /**

     * Gets the version number of requested session. If it is null, value will be -1.

     * <p>The consistency of version numbers between request and response depends on

     * {@link BroadcastInfoRequest.RequestOption}. If the request has RequestOption value

     * {@link BroadcastInfoRequest#getOption()}. If the request has RequestOption value

     * REQUEST_OPTION_AUTO_UPDATE, then the response may be set to the latest version which may be

     * different from the version of the request. Otherwise, response with a different version from

     * its request will be considered invalid.

media/java/android/media/tv/SectionResponse.java

+1 −1
Original line number Diff line number Diff line
@@ -76,7 +76,7 @@ public final class SectionResponse extends BroadcastInfoResponse implements Parc 
    /**

     * Gets the Version number of requested session. If it is null, value will be -1.

     * <p>The consistency of version numbers between request and response depends on

     * {@link BroadcastInfoRequest.RequestOption}. If the request has RequestOption value

     * {@link BroadcastInfoRequest#getOption()}. If the request has RequestOption value

     * REQUEST_OPTION_AUTO_UPDATE, then the response may be set to the latest version which may be

     * different from the version of the request. Otherwise, response with a different version from

     * its request will be considered invalid.

media/java/android/media/tv/TableRequest.java

+1 −1
Original line number Diff line number Diff line
@@ -129,7 +129,7 @@ public final class TableRequest extends BroadcastInfoRequest implements Parcelab 
    /**

     * Gets the version number of requested table. If it is null, value will be -1.

     * <p>The consistency of version numbers between request and response depends on

     * {@link BroadcastInfoRequest.RequestOption}. If the request has RequestOption value

     * {@link BroadcastInfoRequest#getOption()}. If the request has RequestOption value

     * REQUEST_OPTION_AUTO_UPDATE, then the response may be set to the latest version which may be

     * different from the version of the request. Otherwise, response with a different version from

     * its request will be considered invalid.