Update program selector API doc

Added DAB_DMB_SID_EXT as priamry identifier type documentation of
primary identifier.

Bug: 382761381
Flag: DOCS_ONLY
Test: atest BroadcastRadioTests
Change-Id: I38854529927d8c2bf073d194df7c7f2e0fed037b

1 files changed, 14 insertions, 16 deletions

diff --git a/core/java/android/hardware/radio/ProgramSelector.java b/core/java/android/hardware/radio/ProgramSelector.java
index 42028f67f400..e5717ac87d88 100644
--- a/core/java/android/hardware/radio/ProgramSelector.java
+++ b/core/java/android/hardware/radio/ProgramSelector.java
@@ -43,22 +43,20 @@ import java.util.stream.Stream;
  *     <li>DAB channel info</li>
  * </ui>
  *
- * <p>The primary ID uniquely identifies a station and can be used for equality
- * check. The secondary IDs are supplementary and can speed up tuning process,
- * but the primary ID is sufficient (ie. after a full band scan).
- *
- * <p>Two selectors with different secondary IDs, but the same primary ID are
- * considered equal. In particular, secondary IDs vector may get updated for
+ * <p>Except for DAB radio, two selectors with different secondary IDs, but the same primary
+ * ID are considered equal. In particular, secondary IDs vector may get updated for
  * an entry on the program list (ie. when a better frequency for a given
- * station is found).
+ * station is found). For DAB radio, two selectors with the same primary ID and the same
+ * DAB frequency and DAB ensemble secondary IDs (if exist) are considered equal.
  *
  * <p>The primaryId of a given programType MUST be of a specific type:
  * <ui>
- *     <li>AM, FM: RDS_PI if the station broadcasts RDS, AMFM_FREQUENCY otherwise;</li>
- *     <li>AM_HD, FM_HD: HD_STATION_ID_EXT;</li>
- *     <li>DAB: DAB_SIDECC;</li>
- *     <li>DRMO: DRMO_SERVICE_ID;</li>
- *     <li>SXM: SXM_SERVICE_ID;</li>
+ *     <li>AM, FM: {@link #IDENTIFIER_TYPE_RDS_PI} if the station broadcasts RDS,
+ *     {@link #IDENTIFIER_TYPE_AMFM_FREQUENCY} otherwise;</li>
+ *     <li>AM_HD, FM_HD: {@link #IDENTIFIER_TYPE_HD_STATION_ID_EXT};</li>
+ *     <li>DAB: {@link #IDENTIFIER_TYPE_DAB_SID_EXT} or
+ *     {@link #IDENTIFIER_TYPE_DAB_DMB_SID_EXT};</li>
+ *     <li>DRMO: {@link #IDENTIFIER_TYPE_DRMO_SERVICE_ID};</li>
  *     <li>VENDOR: VENDOR_PRIMARY.</li>
  * </ui>
  * @hide
@@ -597,9 +595,9 @@ public final class ProgramSelector implements Parcelable {
      * negatives. In particular, it may be way off for certain regions.
      * The main purpose is to avoid passing improper units, ie. MHz instead of kHz.
      *
-     * @param isAm true, if AM, false if FM.
+     * @param isAm {@code true}, if AM, {@code false} if FM.
      * @param frequencyKhz the frequency in kHz.
-     * @return true, if the frequency is roughly valid.
+     * @return {@code true}, if the frequency is roughly valid.
      */
     private static boolean isValidAmFmFrequency(boolean isAm, int frequencyKhz) {
         if (isAm) {
@@ -785,8 +783,8 @@ public final class ProgramSelector implements Parcelable {
          * ProgramLists for category entries.
          *
          * @see ProgramList.Filter#areCategoriesIncluded
-         * @return False if this identifier's type is not tunable (e.g. DAB ensemble or
-         *         vendor-specified type). True otherwise.
+         * @return {@link false} if this identifier's type is not tunable (e.g. DAB ensemble or
+         *         vendor-specified type). {@link true} otherwise.
          */
         public boolean isCategoryType() {
             return (mType >= IDENTIFIER_TYPE_VENDOR_START && mType <= IDENTIFIER_TYPE_VENDOR_END)