From cc6ff2bc6011294367d9a8c644f811449e952eb7 Mon Sep 17 00:00:00 2001
From: Wink Saville <wink@google.com>
Date: Wed, 2 Dec 2009 09:46:38 -0800
Subject: [PATCH] Cleanup @hide and @deprecated directives.

Bug: 2294396
Change-Id: Icb34706a203fb34e52c67b904328e91a7803d4fc
---
 api/current.xml                               | 178 ++++++++++++++++++
 .../telephony/NeighboringCellInfo.java        |  15 +-
 .../android/telephony/PhoneStateListener.java |   8 +-
 .../android/telephony/SignalStrength.java     |  28 ++-
 4 files changed, 212 insertions(+), 17 deletions(-)

diff --git a/api/current.xml b/api/current.xml
index 1dbe58f58e236..51df39b0ad313 100644
--- a/api/current.xml
+++ b/api/current.xml
@@ -124750,6 +124750,20 @@
  deprecated="not deprecated"
  visibility="public"
 >
+<parameter name="rssi" type="int">
+</parameter>
+<parameter name="location" type="java.lang.String">
+</parameter>
+<parameter name="radioType" type="int">
+</parameter>
+</constructor>
+<constructor name="NeighboringCellInfo"
+ type="android.telephony.NeighboringCellInfo"
+ static="false"
+ final="false"
+ deprecated="not deprecated"
+ visibility="public"
+>
 <parameter name="in" type="android.os.Parcel">
 </parameter>
 </constructor>
@@ -125561,6 +125575,21 @@
 <parameter name="state" type="int">
 </parameter>
 </method>
+<method name="onDataConnectionStateChanged"
+ return="void"
+ abstract="false"
+ native="false"
+ synchronized="false"
+ static="false"
+ final="false"
+ deprecated="not deprecated"
+ visibility="public"
+>
+<parameter name="state" type="int">
+</parameter>
+<parameter name="networkType" type="int">
+</parameter>
+</method>
 <method name="onMessageWaitingIndicatorChanged"
  return="void"
  abstract="false"
@@ -125600,6 +125629,19 @@
 <parameter name="asu" type="int">
 </parameter>
 </method>
+<method name="onSignalStrengthsChanged"
+ return="void"
+ abstract="false"
+ native="false"
+ synchronized="false"
+ static="false"
+ final="false"
+ deprecated="not deprecated"
+ visibility="public"
+>
+<parameter name="signalStrength" type="android.telephony.SignalStrength">
+</parameter>
+</method>
 <field name="LISTEN_CALL_FORWARDING_INDICATOR"
  type="int"
  transient="false"
@@ -125695,6 +125737,17 @@
  value="2"
  static="true"
  final="true"
+ deprecated="deprecated"
+ visibility="public"
+>
+</field>
+<field name="LISTEN_SIGNAL_STRENGTHS"
+ type="int"
+ transient="false"
+ volatile="false"
+ value="256"
+ static="true"
+ final="true"
  deprecated="not deprecated"
  visibility="public"
 >
@@ -125976,6 +126029,131 @@
 >
 </field>
 </class>
+<class name="SignalStrength"
+ extends="java.lang.Object"
+ abstract="false"
+ static="false"
+ final="false"
+ deprecated="not deprecated"
+ visibility="public"
+>
+<implements name="android.os.Parcelable">
+</implements>
+<method name="describeContents"
+ return="int"
+ abstract="false"
+ native="false"
+ synchronized="false"
+ static="false"
+ final="false"
+ deprecated="not deprecated"
+ visibility="public"
+>
+</method>
+<method name="getCdmaDbm"
+ return="int"
+ abstract="false"
+ native="false"
+ synchronized="false"
+ static="false"
+ final="false"
+ deprecated="not deprecated"
+ visibility="public"
+>
+</method>
+<method name="getCdmaEcio"
+ return="int"
+ abstract="false"
+ native="false"
+ synchronized="false"
+ static="false"
+ final="false"
+ deprecated="not deprecated"
+ visibility="public"
+>
+</method>
+<method name="getEvdoDbm"
+ return="int"
+ abstract="false"
+ native="false"
+ synchronized="false"
+ static="false"
+ final="false"
+ deprecated="not deprecated"
+ visibility="public"
+>
+</method>
+<method name="getEvdoEcio"
+ return="int"
+ abstract="false"
+ native="false"
+ synchronized="false"
+ static="false"
+ final="false"
+ deprecated="not deprecated"
+ visibility="public"
+>
+</method>
+<method name="getEvdoSnr"
+ return="int"
+ abstract="false"
+ native="false"
+ synchronized="false"
+ static="false"
+ final="false"
+ deprecated="not deprecated"
+ visibility="public"
+>
+</method>
+<method name="getGsmBitErrorRate"
+ return="int"
+ abstract="false"
+ native="false"
+ synchronized="false"
+ static="false"
+ final="false"
+ deprecated="not deprecated"
+ visibility="public"
+>
+</method>
+<method name="getGsmSignalStrength"
+ return="int"
+ abstract="false"
+ native="false"
+ synchronized="false"
+ static="false"
+ final="false"
+ deprecated="not deprecated"
+ visibility="public"
+>
+</method>
+<method name="isGsm"
+ return="boolean"
+ abstract="false"
+ native="false"
+ synchronized="false"
+ static="false"
+ final="false"
+ deprecated="not deprecated"
+ visibility="public"
+>
+</method>
+<method name="writeToParcel"
+ return="void"
+ abstract="false"
+ native="false"
+ synchronized="false"
+ static="false"
+ final="false"
+ deprecated="not deprecated"
+ visibility="public"
+>
+<parameter name="out" type="android.os.Parcel">
+</parameter>
+<parameter name="flags" type="int">
+</parameter>
+</method>
+</class>
 <class name="SmsManager"
  extends="java.lang.Object"
  abstract="false"
diff --git a/telephony/java/android/telephony/NeighboringCellInfo.java b/telephony/java/android/telephony/NeighboringCellInfo.java
index 1d697618b3344..ad7dfc9e28587 100644
--- a/telephony/java/android/telephony/NeighboringCellInfo.java
+++ b/telephony/java/android/telephony/NeighboringCellInfo.java
@@ -68,12 +68,13 @@ public class NeighboringCellInfo implements Parcelable
     private int mNetworkType;
 
     /**
-     * @deprecated
      * Empty constructor.  Initializes the RSSI and CID.
      *
      * NeighboringCellInfo is one time shot for the neighboring cells based on
      * the radio network type at that moment. Its constructor needs radio network
      * type.
+     *
+     * @deprecated by {@link #NeighboringCellInfo(int, String, int)}
      */
     @Deprecated
     public NeighboringCellInfo() {
@@ -85,12 +86,13 @@ public class NeighboringCellInfo implements Parcelable
     }
 
     /**
-     * @deprecated
      * Initialize the object from rssi and cid.
      *
      * NeighboringCellInfo is one time shot for the neighboring cells based on
      * the radio network type at that moment. Its constructor needs radio network
      * type.
+     *
+     * @deprecated by {@link #NeighboringCellInfo(int, String, int)}
      */
     @Deprecated
     public NeighboringCellInfo(int rssi, int cid) {
@@ -99,7 +101,6 @@ public class NeighboringCellInfo implements Parcelable
     }
 
     /**
-     * @hide
      * Initialize the object from rssi, location string, and radioType
      * radioType is one of following
      * {@link TelephonyManager#NETWORK_TYPE_GPRS TelephonyManager.NETWORK_TYPE_GPRS},
@@ -223,12 +224,14 @@ public class NeighboringCellInfo implements Parcelable
         return mNetworkType;
     }
     /**
-     * @deprecated
      * Set the cell id.
      *
      * NeighboringCellInfo is a one time shot for the neighboring cells based on
      * the radio network type at that moment. It shouldn't be changed after
      * creation.
+     *
+     * @deprecated cid value passed as in location parameter passed to constructor
+     *              {@link #NeighboringCellInfo(int, String, int)}
      */
     @Deprecated
     public void setCid(int cid) {
@@ -236,12 +239,14 @@ public class NeighboringCellInfo implements Parcelable
     }
 
     /**
-     * @deprecated
      * Set the signal strength of the cell.
      *
      * NeighboringCellInfo is a one time shot for the neighboring cells based on
      * the radio network type at that moment. It shouldn't be changed after
      * creation.
+     *
+     * @deprecated initial rssi value passed as parameter to constructor
+     *              {@link #NeighboringCellInfo(int, String, int)}
      */
     @Deprecated
     public void setRssi(int rssi) {
diff --git a/telephony/java/android/telephony/PhoneStateListener.java b/telephony/java/android/telephony/PhoneStateListener.java
index ea6593e2ecc86..9bfd900c6e59d 100644
--- a/telephony/java/android/telephony/PhoneStateListener.java
+++ b/telephony/java/android/telephony/PhoneStateListener.java
@@ -49,8 +49,9 @@ public class PhoneStateListener {
      *
      * @see #onSignalStrengthChanged
      *
-     * TODO: @deprecated to be deprecated by LISTEN_SIGNAL_STRENGTHS, @see #onSignalStrengthsChanged
+     * @deprecated by {@link #LISTEN_SIGNAL_STRENGTHS}
      */
+    @Deprecated
     public static final int LISTEN_SIGNAL_STRENGTH                          = 0x00000002;
 
     /**
@@ -127,8 +128,6 @@ public class PhoneStateListener {
      * icon.
      *
      * @see #onSignalStrengthsChanged
-     *
-     * @hide
      */
     public static final int LISTEN_SIGNAL_STRENGTHS                         = 0x00000100;
 
@@ -206,7 +205,6 @@ public class PhoneStateListener {
     }
 
     /**
-     * @hide
      * same as above, but with the network type.  Both called.
      */
     public void onDataConnectionStateChanged(int state, int networkType) {
@@ -232,8 +230,6 @@ public class PhoneStateListener {
      * @see ServiceState#STATE_IN_SERVICE
      * @see ServiceState#STATE_OUT_OF_SERVICE
      * @see ServiceState#STATE_POWER_OFF
-     *
-     * @hide
      */
     public void onSignalStrengthsChanged(SignalStrength signalStrength) {
         // default implementation empty
diff --git a/telephony/java/android/telephony/SignalStrength.java b/telephony/java/android/telephony/SignalStrength.java
index 8ed0065cdd7ae..c9e304ac7446c 100644
--- a/telephony/java/android/telephony/SignalStrength.java
+++ b/telephony/java/android/telephony/SignalStrength.java
@@ -24,8 +24,6 @@ import android.util.Log;
 
 /**
  * Contains phone signal strength related information.
- *
- * @hide
  */
 public class SignalStrength implements Parcelable {
 
@@ -50,6 +48,7 @@ public class SignalStrength implements Parcelable {
      * @param m Bundle from intent notifier
      * @return newly created SignalStrength
      *
+     * @hide
      */
     public static SignalStrength newFromBundle(Bundle m) {
         SignalStrength ret;
@@ -61,6 +60,7 @@ public class SignalStrength implements Parcelable {
     /**
      * Empty constructor
      *
+     * @hide
      */
     public SignalStrength() {
         mGsmSignalStrength = 99;
@@ -76,6 +76,7 @@ public class SignalStrength implements Parcelable {
     /**
      * Constructor
      *
+     * @hide
      */
     public SignalStrength(int gsmSignalStrength, int gsmBitErrorRate,
             int cdmaDbm, int cdmaEcio,
@@ -94,6 +95,8 @@ public class SignalStrength implements Parcelable {
      * Copy constructors
      *
      * @param s Source SignalStrength
+     *
+     * @hide
      */
     public SignalStrength(SignalStrength s) {
         copyFrom(s);
@@ -115,6 +118,8 @@ public class SignalStrength implements Parcelable {
 
     /**
      * Construct a SignalStrength object from the given parcel.
+     *
+     * @hide
      */
     public SignalStrength(Parcel in) {
         mGsmSignalStrength = in.readInt();
@@ -127,6 +132,9 @@ public class SignalStrength implements Parcelable {
         isGsm = (in.readInt() != 0);
     }
 
+    /**
+     * {@link Parcelable#writeToParcel}
+     */
     public void writeToParcel(Parcel out, int flags) {
         out.writeInt(mGsmSignalStrength);
         out.writeInt(mGsmBitErrorRate);
@@ -138,10 +146,18 @@ public class SignalStrength implements Parcelable {
         out.writeInt(isGsm ? 1 : 0);
     }
 
+    /**
+     * {@link Parcelable#describeContents}
+     */
     public int describeContents() {
         return 0;
     }
 
+    /**
+     * {@link Parcelable.Creator}
+     *
+     * @hide
+     */
     public static final Parcelable.Creator<SignalStrength> CREATOR = new Parcelable.Creator() {
         public SignalStrength createFromParcel(Parcel in) {
             return new SignalStrength(in);
@@ -202,14 +218,14 @@ public class SignalStrength implements Parcelable {
     }
 
     /**
-     * @hide
+     * @return true if this is for GSM
      */
     public boolean isGsm() {
         return this.isGsm;
     }
 
     /**
-     * @hide
+     * @return hash code
      */
     @Override
     public int hashCode() {
@@ -221,7 +237,7 @@ public class SignalStrength implements Parcelable {
     }
 
     /**
-     * @hide
+     * @return true if the signal strengths are the same
      */
     @Override
     public boolean equals (Object o) {
@@ -248,7 +264,7 @@ public class SignalStrength implements Parcelable {
     }
 
     /**
-     * @hide
+     * @return string representation.
      */
     @Override
     public String toString() {