am cc6ff2bc: Cleanup @hide and @deprecated directives.

Merge commit 'cc6ff2bc6011294367d9a8c644f811449e952eb7' into eclair-mr2

* commit 'cc6ff2bc6011294367d9a8c644f811449e952eb7':
  Cleanup @hide and @deprecated directives.

3 files changed, 34 insertions, 17 deletions

diff --git a/telephony/java/android/telephony/NeighboringCellInfo.java b/telephony/java/android/telephony/NeighboringCellInfo.java
index 1d69761..ad7dfc9 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 ea6593e..9bfd900 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 8ed0065..c9e304a 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() {