From 3aef8e1d1b2f0b87d470bcccf37ba4ebb6560c45 Mon Sep 17 00:00:00 2001 From: Joe Fernandez Date: Tue, 20 Dec 2011 10:38:34 -0800 Subject: docs: Add developer guide cross-references, Project ACRE, round 4 Change-Id: I1b43414aaec8ea217b39a0d780c80a25409d0991 --- core/java/android/animation/AnimatorSet.java | 7 +++++++ core/java/android/animation/ObjectAnimator.java | 7 +++++++ core/java/android/animation/ValueAnimator.java | 7 +++++++ core/java/android/animation/package.html | 10 +++++----- core/java/android/app/SearchManager.java | 9 +++++---- .../android/app/admin/DeviceAdminReceiver.java | 7 +++++++ .../android/app/admin/DevicePolicyManager.java | 7 +++++++ core/java/android/app/admin/package.html | 5 +++-- core/java/android/appwidget/AppWidgetManager.java | 6 ++++++ core/java/android/appwidget/AppWidgetProvider.java | 9 +++++++-- core/java/android/appwidget/package.html | 11 +++++------ core/java/android/bluetooth/BluetoothAdapter.java | 6 ++++++ core/java/android/bluetooth/BluetoothDevice.java | 6 ++++++ .../android/bluetooth/BluetoothServerSocket.java | 6 ++++++ core/java/android/bluetooth/BluetoothSocket.java | 6 ++++++ core/java/android/bluetooth/package.html | 5 +++-- core/java/android/content/ClipData.java | 7 +++++++ core/java/android/content/ClipDescription.java | 7 +++++++ core/java/android/content/ClipboardManager.java | 7 +++++++ .../content/SearchRecentSuggestionsProvider.java | 6 ++++++ core/java/android/hardware/usb/UsbAccessory.java | 6 ++++++ core/java/android/hardware/usb/UsbDevice.java | 6 ++++++ core/java/android/hardware/usb/UsbInterface.java | 6 ++++++ core/java/android/hardware/usb/UsbManager.java | 9 +++++++-- core/java/android/hardware/usb/package.html | 15 ++++++++++---- core/java/android/nfc/NfcAdapter.java | 6 ++++++ core/java/android/nfc/NfcManager.java | 6 ++++++ core/java/android/nfc/package.html | 9 +++++++-- .../android/provider/SearchRecentSuggestions.java | 7 +++++++ core/java/android/test/package.html | 7 ++++++- core/java/android/widget/SearchView.java | 9 +++++---- .../graphics/drawable/AnimationDrawable.java | 9 +++++++-- graphics/java/android/renderscript/Allocation.java | 5 +++++ graphics/java/android/renderscript/Element.java | 6 ++++++ .../java/android/renderscript/RSSurfaceView.java | 6 ++++++ .../java/android/renderscript/RenderScript.java | 9 ++++++--- .../java/android/renderscript/RenderScriptGL.java | 8 +++++++- graphics/java/android/renderscript/Type.java | 5 +++++ graphics/java/android/renderscript/package.html | 23 +++++++++++----------- .../java/android/location/LocationListener.java | 7 +++++++ .../java/android/location/LocationManager.java | 7 +++++++ location/java/android/location/package.html | 6 +++--- .../test/ActivityInstrumentationTestCase2.java | 6 ++++++ .../android/test/InstrumentationTestRunner.java | 10 +++++++++- test-runner/src/android/test/ServiceTestCase.java | 6 ++++++ .../src/android/test/mock/MockContentResolver.java | 6 ++++++ test-runner/src/android/test/mock/package.html | 7 ++++++- voip/java/android/net/sip/SipAudioCall.java | 9 ++++++++- voip/java/android/net/sip/SipManager.java | 9 ++++++++- voip/java/android/net/sip/SipProfile.java | 7 +++++++ voip/java/android/net/sip/package.html | 8 +++++++- 51 files changed, 327 insertions(+), 59 deletions(-) diff --git a/core/java/android/animation/AnimatorSet.java b/core/java/android/animation/AnimatorSet.java index 0b68dd8..c5a4171 100644 --- a/core/java/android/animation/AnimatorSet.java +++ b/core/java/android/animation/AnimatorSet.java @@ -39,6 +39,13 @@ import java.util.List; * result in none of the affected animations being played. Because of this (and because * circular dependencies do not make logical sense anyway), circular dependencies * should be avoided, and the dependency flow of animations should only be in one direction. + * + *
+ *

Developer Guides

+ *

For more information about animating with {@code AnimatorSet}, read the + * Property + * Animation developer guide.

+ *
*/ public final class AnimatorSet extends Animator { diff --git a/core/java/android/animation/ObjectAnimator.java b/core/java/android/animation/ObjectAnimator.java index d2d66b6..0372cb0 100644 --- a/core/java/android/animation/ObjectAnimator.java +++ b/core/java/android/animation/ObjectAnimator.java @@ -29,6 +29,13 @@ import java.util.ArrayList; * are then determined internally and the animation will call these functions as necessary to * animate the property. * + *
+ *

Developer Guides

+ *

For more information about animating with {@code ObjectAnimator}, read the + * Property + * Animation developer guide.

+ *
+ * * @see #setPropertyName(String) * */ diff --git a/core/java/android/animation/ValueAnimator.java b/core/java/android/animation/ValueAnimator.java index edd0fa3..55e95b0 100755 --- a/core/java/android/animation/ValueAnimator.java +++ b/core/java/android/animation/ValueAnimator.java @@ -38,6 +38,13 @@ import java.util.HashMap; * {@link AccelerateDecelerateInterpolator} class, which accelerates into and decelerates * out of an animation. This behavior can be changed by calling * {@link ValueAnimator#setInterpolator(TimeInterpolator)}.

+ * + *
+ *

Developer Guides

+ *

For more information about animating with {@code ValueAnimator}, read the + * Property + * Animation developer guide.

+ *
*/ public class ValueAnimator extends Animator { diff --git a/core/java/android/animation/package.html b/core/java/android/animation/package.html index 92eeb20..59178f7 100644 --- a/core/java/android/animation/package.html +++ b/core/java/android/animation/package.html @@ -7,15 +7,15 @@ color values are supported by default. You can animate any other type by telling to calculate the values for that given type with a custom {@link android.animation.TypeEvaluator}.

+

For more information, see the +Animation developer guide.

+{@more} +

You can set many different types of interpolators (contained in {@link android.view.animation}), specify {@link android.animation.Keyframe keyframes}, or group animations to play sequentially or simultaneously (with {@link android.animation.AnimatorSet}) to further control your animation behaviors.

-

-For a guide on how to use the property animation system, see the -Animation developer guide. -

- + \ No newline at end of file diff --git a/core/java/android/app/SearchManager.java b/core/java/android/app/SearchManager.java index 3aa159e..2ff45fb 100644 --- a/core/java/android/app/SearchManager.java +++ b/core/java/android/app/SearchManager.java @@ -48,10 +48,11 @@ import java.util.List; * {@link android.content.Context#getSystemService * context.getSystemService(Context.SEARCH_SERVICE)}. * - *
- *

For a guide to using the search dialog and adding search - * suggestions in your application, see the Dev Guide topic about Search.

+ *
+ *

Developer Guides

+ *

For more information about using the search dialog and adding search + * suggestions in your application, read the + * Search developer guide.

*
*/ public class SearchManager diff --git a/core/java/android/app/admin/DeviceAdminReceiver.java b/core/java/android/app/admin/DeviceAdminReceiver.java index 473aec6..43cd330 100644 --- a/core/java/android/app/admin/DeviceAdminReceiver.java +++ b/core/java/android/app/admin/DeviceAdminReceiver.java @@ -49,6 +49,13 @@ import android.os.Bundle; * A typical file would be:

* * {@sample development/samples/ApiDemos/res/xml/device_admin_sample.xml meta_data} + * + *
+ *

Developer Guides

+ *

For more information about device administration, read the + * Device Administration + * developer guide.

+ *
*/ public class DeviceAdminReceiver extends BroadcastReceiver { private static String TAG = "DevicePolicy"; diff --git a/core/java/android/app/admin/DevicePolicyManager.java b/core/java/android/app/admin/DevicePolicyManager.java index c89396b..4ed0766 100644 --- a/core/java/android/app/admin/DevicePolicyManager.java +++ b/core/java/android/app/admin/DevicePolicyManager.java @@ -40,6 +40,13 @@ import java.util.List; * Public interface for managing policies enforced on a device. Most clients * of this class must have published a {@link DeviceAdminReceiver} that the user * has currently enabled. + * + *
+ *

Developer Guides

+ *

For more information about managing policies for device adminstration, read the + * Device Administration + * developer guide.

+ *
*/ public class DevicePolicyManager { private static String TAG = "DevicePolicyManager"; diff --git a/core/java/android/app/admin/package.html b/core/java/android/app/admin/package.html index 1a81083..c363c25 100644 --- a/core/java/android/app/admin/package.html +++ b/core/java/android/app/admin/package.html @@ -4,8 +4,9 @@ security-aware applications that are useful in enterprise settings, in which IT professionals require rich control over employee devices.

-

For more information, see the Device Administration developer guide.

+

For more information, see the +Device Administration +developer guide.

{@more} diff --git a/core/java/android/appwidget/AppWidgetManager.java b/core/java/android/appwidget/AppWidgetManager.java index 09661a5..a7f7792 100644 --- a/core/java/android/appwidget/AppWidgetManager.java +++ b/core/java/android/appwidget/AppWidgetManager.java @@ -35,6 +35,12 @@ import java.util.WeakHashMap; /** * Updates AppWidget state; gets information about installed AppWidget providers and other * AppWidget related state. + * + *
+ *

Developer Guides

+ *

For more information about creating app widgets, read the + * App Widgets developer guide.

+ *
*/ public class AppWidgetManager { static final String TAG = "AppWidgetManager"; diff --git a/core/java/android/appwidget/AppWidgetProvider.java b/core/java/android/appwidget/AppWidgetProvider.java index f1bbede..00a5f0c 100755 --- a/core/java/android/appwidget/AppWidgetProvider.java +++ b/core/java/android/appwidget/AppWidgetProvider.java @@ -31,8 +31,13 @@ import android.os.Bundle; *

Extend this class and override one or more of the {@link #onUpdate}, {@link #onDeleted}, * {@link #onEnabled} or {@link #onDisabled} methods to implement your own AppWidget functionality. *

- *

For an example of how to write a AppWidget provider, see the - * AppWidgets documentation.

+ * + *
+ *

Developer Guides

+ *

For more information about how to write an app widget provider, read the + * App Widgets + * developer guide.

+ *
*/ public class AppWidgetProvider extends BroadcastReceiver { /** diff --git a/core/java/android/appwidget/package.html b/core/java/android/appwidget/package.html index 19fd2f7..aa72da2 100644 --- a/core/java/android/appwidget/package.html +++ b/core/java/android/appwidget/package.html @@ -2,11 +2,11 @@

Contains the components necessary to create "app widgets", which users can embed in other applications (such as the home screen) to quickly access application data and services without launching a new activity.

-

For more information, see the -App Widgets -developer guide.

+

For more information, see the +App Widgets developer guide.

{@more} +

The behavior of an app widget is published by an "app widget provider." An "app widget host" is a component that can contain app widgets (such as the Home screen).

@@ -24,9 +24,8 @@ details are left up to the widget hosts. For example, the home screen has one w widgets, but the lock screen could also contain widgets, and it would have a different way of adding, removing and otherwise managing widgets.

-

The App Widgets -developer guide shows you how to create an app widget provider. For information about implementing -an app widget host, see the {@link android.appwidget.AppWidgetHost} class.

+

For information about implementing an app widget host, see the {@link +android.appwidget.AppWidgetHost} class.

diff --git a/core/java/android/bluetooth/BluetoothAdapter.java b/core/java/android/bluetooth/BluetoothAdapter.java index 5f5ba50..899816c 100644 --- a/core/java/android/bluetooth/BluetoothAdapter.java +++ b/core/java/android/bluetooth/BluetoothAdapter.java @@ -62,6 +62,12 @@ import java.util.UUID; * permission and some also require the * {@link android.Manifest.permission#BLUETOOTH_ADMIN} permission. * + *
+ *

Developer Guides

+ *

For more information about using Bluetooth, read the + * Bluetooth developer guide.

+ *
+ * * {@see BluetoothDevice} * {@see BluetoothServerSocket} */ diff --git a/core/java/android/bluetooth/BluetoothDevice.java b/core/java/android/bluetooth/BluetoothDevice.java index 0306521..189e8fc 100644 --- a/core/java/android/bluetooth/BluetoothDevice.java +++ b/core/java/android/bluetooth/BluetoothDevice.java @@ -54,6 +54,12 @@ import java.util.UUID; *

Note: * Requires the {@link android.Manifest.permission#BLUETOOTH} permission. * + *

+ *

Developer Guides

+ *

For more information about using Bluetooth, read the + * Bluetooth developer guide.

+ *
+ * * {@see BluetoothAdapter} * {@see BluetoothSocket} */ diff --git a/core/java/android/bluetooth/BluetoothServerSocket.java b/core/java/android/bluetooth/BluetoothServerSocket.java index acce182..4021f7b 100644 --- a/core/java/android/bluetooth/BluetoothServerSocket.java +++ b/core/java/android/bluetooth/BluetoothServerSocket.java @@ -55,6 +55,12 @@ import java.io.IOException; *

Note: * Requires the {@link android.Manifest.permission#BLUETOOTH} permission. * + *

+ *

Developer Guides

+ *

For more information about using Bluetooth, read the + * Bluetooth developer guide.

+ *
+ * * {@see BluetoothSocket} */ public final class BluetoothServerSocket implements Closeable { diff --git a/core/java/android/bluetooth/BluetoothSocket.java b/core/java/android/bluetooth/BluetoothSocket.java index 9a13c3e..19d13ef 100644 --- a/core/java/android/bluetooth/BluetoothSocket.java +++ b/core/java/android/bluetooth/BluetoothSocket.java @@ -65,6 +65,12 @@ import java.util.concurrent.locks.ReentrantReadWriteLock; *

Note: * Requires the {@link android.Manifest.permission#BLUETOOTH} permission. * + *

+ *

Developer Guides

+ *

For more information about using Bluetooth, read the + * Bluetooth developer guide.

+ *
+ * * {@see BluetoothServerSocket} * {@see java.io.InputStream} * {@see java.io.OutputStream} diff --git a/core/java/android/bluetooth/package.html b/core/java/android/bluetooth/package.html index 37505fd..81bf1cf 100644 --- a/core/java/android/bluetooth/package.html +++ b/core/java/android/bluetooth/package.html @@ -3,8 +3,8 @@

Provides classes that manage Bluetooth functionality, such as scanning for devices, connecting with devices, and managing data transfer between devices.

-

For more information, see the Bluetooth developer guide.

+

For more information, see the +Bluetooth developer guide.

{@more}

The Bluetooth APIs let applications:

@@ -26,5 +26,6 @@ permission.

Note: Not all Android-powered devices provide Bluetooth functionality.

+ diff --git a/core/java/android/content/ClipData.java b/core/java/android/content/ClipData.java index d9c6b07..a8b1bf4 100644 --- a/core/java/android/content/ClipData.java +++ b/core/java/android/content/ClipData.java @@ -50,6 +50,13 @@ import java.util.ArrayList; * CharSequence of text, a single Intent object, or a Uri. See {@link Item} * for more details. * + *
+ *

Developer Guides

+ *

For more information about using the clipboard framework, read the + * Copy and Paste + * developer guide.

+ *
+ * * *

Implementing Paste or Drop

* diff --git a/core/java/android/content/ClipDescription.java b/core/java/android/content/ClipDescription.java index 0d9d807..b5fa20c 100644 --- a/core/java/android/content/ClipDescription.java +++ b/core/java/android/content/ClipDescription.java @@ -26,6 +26,13 @@ import java.util.ArrayList; * Meta-data describing the contents of a {@link ClipData}. Provides enough * information to know if you can handle the ClipData, but not the data * itself. + * + *
+ *

Developer Guides

+ *

For more information about using the clipboard framework, read the + * Copy and Paste + * developer guide.

+ *
*/ public class ClipDescription implements Parcelable { /** diff --git a/core/java/android/content/ClipboardManager.java b/core/java/android/content/ClipboardManager.java index a79f060..800d0d2 100644 --- a/core/java/android/content/ClipboardManager.java +++ b/core/java/android/content/ClipboardManager.java @@ -40,6 +40,13 @@ import java.util.ArrayList; * is expressed as a {@link ClipData} object, which defines the protocol * for data exchange between applications. * + *
+ *

Developer Guides

+ *

For more information about using the clipboard framework, read the + * Copy and Paste + * developer guide.

+ *
+ * * @see android.content.Context#getSystemService */ public class ClipboardManager extends android.text.ClipboardManager { diff --git a/core/java/android/content/SearchRecentSuggestionsProvider.java b/core/java/android/content/SearchRecentSuggestionsProvider.java index e1a8d21..d6f7d97 100644 --- a/core/java/android/content/SearchRecentSuggestionsProvider.java +++ b/core/java/android/content/SearchRecentSuggestionsProvider.java @@ -61,6 +61,12 @@ import android.util.Log; * for future searches by calling {@link android.provider.SearchRecentSuggestions#saveRecentQuery * SearchRecentSuggestions.saveRecentQuery()}. * + * + *
+ *

Developer Guides

+ *

For information about using search suggestions in your application, read the + * Search developer guide.

+ *
* * @see android.provider.SearchRecentSuggestions */ diff --git a/core/java/android/hardware/usb/UsbAccessory.java b/core/java/android/hardware/usb/UsbAccessory.java index c8ea825..7702044 100644 --- a/core/java/android/hardware/usb/UsbAccessory.java +++ b/core/java/android/hardware/usb/UsbAccessory.java @@ -37,6 +37,12 @@ import android.util.Log; * {@link UsbManager#ACTION_USB_ACCESSORY_ATTACHED} Intent. * The application can then call {@link UsbManager#openAccessory} to open a file descriptor * for reading and writing data to and from the accessory. + * + *
+ *

Developer Guides

+ *

For more information about communicating with USB hardware, read the + * USB developer guide.

+ *
*/ public class UsbAccessory implements Parcelable { diff --git a/core/java/android/hardware/usb/UsbDevice.java b/core/java/android/hardware/usb/UsbDevice.java index af3f7f0..9bd38f9 100644 --- a/core/java/android/hardware/usb/UsbDevice.java +++ b/core/java/android/hardware/usb/UsbDevice.java @@ -34,6 +34,12 @@ import java.io.FileDescriptor; * To communicate with the device, you open a {@link UsbDeviceConnection} for the device * and use {@link UsbRequest} to send and receive data on an endpoint. * {@link UsbDeviceConnection#controlTransfer} is used for control requests on endpoint zero. + * + *
+ *

Developer Guides

+ *

For more information about communicating with USB hardware, read the + * USB developer guide.

+ *
*/ public class UsbDevice implements Parcelable { diff --git a/core/java/android/hardware/usb/UsbInterface.java b/core/java/android/hardware/usb/UsbInterface.java index 3b51063..d6c54a8 100644 --- a/core/java/android/hardware/usb/UsbInterface.java +++ b/core/java/android/hardware/usb/UsbInterface.java @@ -26,6 +26,12 @@ import android.os.Parcelable; * piece of functionality, separate from the other interfaces. * An interface will have one or more {@link UsbEndpoint}s, which are the * channels by which the host transfers data with the device. + * + *
+ *

Developer Guides

+ *

For more information about communicating with USB hardware, read the + * USB developer guide.

+ *
*/ public class UsbInterface implements Parcelable { diff --git a/core/java/android/hardware/usb/UsbManager.java b/core/java/android/hardware/usb/UsbManager.java index 551926c..93f93c7 100644 --- a/core/java/android/hardware/usb/UsbManager.java +++ b/core/java/android/hardware/usb/UsbManager.java @@ -35,8 +35,13 @@ import java.util.HashMap; * {@link android.content.Context#getSystemService(java.lang.String) Context.getSystemService()}. * * {@samplecode - * UsbManager manager = (UsbManager) getSystemService(Context.USB_SERVICE); - * } + * UsbManager manager = (UsbManager) getSystemService(Context.USB_SERVICE);} + * + *
+ *

Developer Guides

+ *

For more information about communicating with USB hardware, read the + * USB developer guide.

+ *
*/ public class UsbManager { private static final String TAG = "UsbManager"; diff --git a/core/java/android/hardware/usb/package.html b/core/java/android/hardware/usb/package.html index 5fd5a30..b32e0df 100644 --- a/core/java/android/hardware/usb/package.html +++ b/core/java/android/hardware/usb/package.html @@ -1,9 +1,16 @@ -

Provides support to communicate with USB hardware peripherals that are connected to Android-powered -devices. Use {@link android.hardware.usb.UsbManager} to access the state of the USB and to +

Provides support to communicate with USB hardware peripherals that are connected to +Android-powered devices.

+ +

For more information, see the +USB developer guide.

+{@more} + +

Use {@link android.hardware.usb.UsbManager} to access the state of the USB and to communicate with connected hardware peripherals. Use {@link android.hardware.usb.UsbDevice} to -communicate with the hardware peripheral if the Android-powered device is acting as the USB host. Use -{@link android.hardware.usb.UsbAccessory} if the peripheral is acting as the USB host.

+communicate with the hardware peripheral if the Android-powered device is acting as the USB host. +Use {@link android.hardware.usb.UsbAccessory} if the peripheral is acting as the USB host.

+ \ No newline at end of file diff --git a/core/java/android/nfc/NfcAdapter.java b/core/java/android/nfc/NfcAdapter.java index 2857ac5..a903a5f 100644 --- a/core/java/android/nfc/NfcAdapter.java +++ b/core/java/android/nfc/NfcAdapter.java @@ -42,6 +42,12 @@ import android.util.Log; *

* Use the helper {@link #getDefaultAdapter(Context)} to get the default NFC * adapter for this Android device. + * + *

+ *

Developer Guides

+ *

For more information about using NFC, read the + * Near Field Communication developer guide.

+ *
*/ public final class NfcAdapter { static final String TAG = "NFC"; diff --git a/core/java/android/nfc/NfcManager.java b/core/java/android/nfc/NfcManager.java index 6ec2e21..ef5c7ba 100644 --- a/core/java/android/nfc/NfcManager.java +++ b/core/java/android/nfc/NfcManager.java @@ -28,6 +28,12 @@ import android.content.Context; * Alternately, you can just call the static helper * {@link NfcAdapter#getDefaultAdapter(android.content.Context)}. * + *
+ *

Developer Guides

+ *

For more information about using NFC, read the + * Near Field Communication developer guide.

+ *
+ * * @see Context#getSystemService * @see NfcAdapter#getDefaultAdapter(android.content.Context) */ diff --git a/core/java/android/nfc/package.html b/core/java/android/nfc/package.html index 97bb29d..9e028a5 100644 --- a/core/java/android/nfc/package.html +++ b/core/java/android/nfc/package.html @@ -1,7 +1,11 @@ -Provides access to Near Field Communication (NFC) functionality, allowing applications to read -NDEF message in NFC tags. A "tag" may actually be another device that appears as a tag. +

Provides access to Near Field Communication (NFC) functionality, allowing applications to read +NDEF message in NFC tags. A "tag" may actually be another device that appears as a tag.

+ +

For more information, see the +Near Field Communication developer guide.

+{@more}

Here's a summary of the classes:

@@ -24,5 +28,6 @@ type of data being shared and carries the data itself.

Note: Not all Android-powered devices provide NFC functionality.

+ diff --git a/core/java/android/provider/SearchRecentSuggestions.java b/core/java/android/provider/SearchRecentSuggestions.java index 13ad9d3..c165487 100644 --- a/core/java/android/provider/SearchRecentSuggestions.java +++ b/core/java/android/provider/SearchRecentSuggestions.java @@ -44,6 +44,13 @@ import java.util.concurrent.Semaphore; * *

For a working example, see SearchSuggestionSampleProvider and SearchQueryResults in * samples/ApiDemos/app. + * + *

+ *

Developer Guides

+ *

For information about using search suggestions in your application, read the + * Adding Recent Query + * Suggestions developer guide.

+ *
*/ public class SearchRecentSuggestions { // debugging support diff --git a/core/java/android/test/package.html b/core/java/android/test/package.html index 1972bed..770e9a5 100644 --- a/core/java/android/test/package.html +++ b/core/java/android/test/package.html @@ -1,5 +1,10 @@ -A framework for writing Android test cases and suites. +

A framework for writing Android test cases and suites.

+ +

For more information, see the +Testing developer guide.

+{@more} + \ No newline at end of file diff --git a/core/java/android/widget/SearchView.java b/core/java/android/widget/SearchView.java index f524ef0..9d2ff2e 100644 --- a/core/java/android/widget/SearchView.java +++ b/core/java/android/widget/SearchView.java @@ -75,10 +75,11 @@ import java.util.WeakHashMap; * If you want the search field to always be visible, then call setIconifiedByDefault(false). *

* - *

- * For more information, see the Search - * documentation. - *

+ *

+ *

Developer Guides

+ *

For information about using {@code SearchView}, read the + * Search developer guide.

+ *
* * @see android.view.MenuItem#SHOW_AS_ACTION_COLLAPSE_ACTION_VIEW * @attr ref android.R.styleable#SearchView_iconifiedByDefault diff --git a/graphics/java/android/graphics/drawable/AnimationDrawable.java b/graphics/java/android/graphics/drawable/AnimationDrawable.java index 7efdc6c..07de074 100644 --- a/graphics/java/android/graphics/drawable/AnimationDrawable.java +++ b/graphics/java/android/graphics/drawable/AnimationDrawable.java @@ -64,8 +64,13 @@ import android.util.AttributeSet; * // Start the animation (looped playback by default). * frameAnimation.start(); * - *

For more information, see the guide to Animation Resources.

+ * + *
+ *

Developer Guides

+ *

For more information about animating with {@code AnimationDrawable}, read the + * Drawable Animation + * developer guide.

+ *
* * @attr ref android.R.styleable#AnimationDrawable_visible * @attr ref android.R.styleable#AnimationDrawable_variablePadding diff --git a/graphics/java/android/renderscript/Allocation.java b/graphics/java/android/renderscript/Allocation.java index 12e5ada..f285f5b 100644 --- a/graphics/java/android/renderscript/Allocation.java +++ b/graphics/java/android/renderscript/Allocation.java @@ -62,6 +62,11 @@ import android.util.TypedValue; * The unchecked variants exist to allow apps to copy over arrays of structures from a * control language that does not support structures.

* + *
+ *

Developer Guides

+ *

For more information about creating an application that uses Renderscript, read the + * Renderscript developer guide.

+ *
**/ public class Allocation extends BaseObj { Type mType; diff --git a/graphics/java/android/renderscript/Element.java b/graphics/java/android/renderscript/Element.java index 8a9ca85..d378a78 100644 --- a/graphics/java/android/renderscript/Element.java +++ b/graphics/java/android/renderscript/Element.java @@ -40,6 +40,12 @@ import android.util.Log; *

The primary source of elements are from scripts. A script that exports a * bind point for a data structure generates a Renderscript element to represent the * data exported by the script. The other common source of elements is from bitmap formats.

+ * + *
+ *

Developer Guides

+ *

For more information about creating an application that uses Renderscript, read the + * Renderscript developer guide.

+ *
**/ public class Element extends BaseObj { int mSize; diff --git a/graphics/java/android/renderscript/RSSurfaceView.java b/graphics/java/android/renderscript/RSSurfaceView.java index a8e3107..6756fd0 100644 --- a/graphics/java/android/renderscript/RSSurfaceView.java +++ b/graphics/java/android/renderscript/RSSurfaceView.java @@ -31,6 +31,12 @@ import android.view.SurfaceView; /** * The Surface View for a graphics renderscript (RenderScriptGL) to draw on. + * + *
+ *

Developer Guides

+ *

For more information about creating an application that uses Renderscript, read the + * Renderscript developer guide.

+ *
*/ public class RSSurfaceView extends SurfaceView implements SurfaceHolder.Callback { private SurfaceHolder mSurfaceHolder; diff --git a/graphics/java/android/renderscript/RenderScript.java b/graphics/java/android/renderscript/RenderScript.java index 1305633..ad10832 100644 --- a/graphics/java/android/renderscript/RenderScript.java +++ b/graphics/java/android/renderscript/RenderScript.java @@ -32,13 +32,16 @@ import android.view.Surface; /** - * RenderScript base master class. An instance of this class creates native + * Renderscript base master class. An instance of this class creates native * worker threads for processing commands from this object. This base class * does not provide any extended capabilities beyond simple data processing. * For extended capabilities use derived classes such as RenderScriptGL. * - * - * + *
+ *

Developer Guides

+ *

For more information about creating an application that uses Renderscript, read the + * Renderscript developer guide.

+ *
**/ public class RenderScript { static final String LOG_TAG = "RenderScript_jni"; diff --git a/graphics/java/android/renderscript/RenderScriptGL.java b/graphics/java/android/renderscript/RenderScriptGL.java index 2dfcc83..2cfeb17 100644 --- a/graphics/java/android/renderscript/RenderScriptGL.java +++ b/graphics/java/android/renderscript/RenderScriptGL.java @@ -29,11 +29,17 @@ import android.view.SurfaceHolder; import android.view.SurfaceView; /** - * The Graphics derivitive of RenderScript. Extends the basic context to add a + * The Graphics derivitive of Renderscript. Extends the basic context to add a * root script which is the display window for graphical output. When the * system needs to update the display the currently bound root script will be * called. This script is expected to issue the rendering commands to repaint * the screen. + * + *
+ *

Developer Guides

+ *

For more information about creating an application that uses Renderscript, read the + * Renderscript developer guide.

+ *
**/ public class RenderScriptGL extends RenderScript { int mWidth; diff --git a/graphics/java/android/renderscript/Type.java b/graphics/java/android/renderscript/Type.java index f88af8b..70d1de4 100644 --- a/graphics/java/android/renderscript/Type.java +++ b/graphics/java/android/renderscript/Type.java @@ -35,6 +35,11 @@ import android.util.Log; * *

The LOD and Faces dimensions are booleans to indicate present or not present.

* + *
+ *

Developer Guides

+ *

For more information about creating an application that uses Renderscript, read the + * Renderscript developer guide.

+ *
**/ public class Type extends BaseObj { int mDimX; diff --git a/graphics/java/android/renderscript/package.html b/graphics/java/android/renderscript/package.html index 36a24ff..775645f 100644 --- a/graphics/java/android/renderscript/package.html +++ b/graphics/java/android/renderscript/package.html @@ -1,10 +1,16 @@

The Renderscript rendering and computational APIs offer a low-level, high performance means of -carrying out mathematical calculations and 3D graphics rendering. An example of Renderscript in -applications include the 3D carousel view that is present in Android 3.0 applications such as the -Books and YouTube applications. This API is intended for developers who are comfortable working with -native code and want to maximize their performance critical applications.

+carrying out mathematical calculations and 3D graphics rendering.

+ +

For more information, see the +Renderscript developer guide.

+{@more} + +

An example of Renderscript in applications include the 3D carousel view that is present in +Android 3.0 applications such as the Books and YouTube applications. This API is intended for +developers who are comfortable working with native code and want to maximize their performance +critical applications.

Renderscript adopts a control and slave architecture where the low-level native code is controlled by the higher level Android system that runs in the virtual machine (VM). The VM code handles resource @@ -14,7 +20,7 @@ the native Renderscript code, which you write in C (C99 standard). The Renderscr does the intensive computation and returns the result back to the Android VM.

You can find the Renderscript native -APIs in the <sdk_root>/platforms/android-3.0/renderscript directory. +APIs in the <sdk_root>/platforms/android-11/renderscript directory. The Android system APIs are broken into a few main groups:

Core

@@ -37,7 +43,7 @@ classes include:

  • Byte2, Byte3, and Byte4
  • Float2, Float3, Float4
  • Int2, Int3, Int4
    • -
  • Long2, Long3, Long4
    • +
  • Long2, Long3, Long4
  • Matrix2f, Matrix3f, Matrix4f
  • Short2, Short3, Short4
    • @@ -76,10 +82,5 @@ pipeline.

    -

    -For information on how to create an application that uses Renderscript, and also the -see 3D with -Renderscript dev guide. -

    diff --git a/location/java/android/location/LocationListener.java b/location/java/android/location/LocationListener.java index 0f5f388..88904c8 100644 --- a/location/java/android/location/LocationListener.java +++ b/location/java/android/location/LocationListener.java @@ -24,6 +24,13 @@ import android.os.Bundle; * LocationListener has been registered with the location manager service * using the {@link LocationManager#requestLocationUpdates(String, long, float, LocationListener)} * method. + * + *
    + *

    Developer Guides

    + *

    For more information about identifying user location, read the + * Obtaining User + * Location developer guide.

    + *
    */ public interface LocationListener { diff --git a/location/java/android/location/LocationManager.java b/location/java/android/location/LocationManager.java index 2817df8..91d8bc1 100644 --- a/location/java/android/location/LocationManager.java +++ b/location/java/android/location/LocationManager.java @@ -42,6 +42,13 @@ import java.util.List; * instantiate this class directly; instead, retrieve it through * {@link android.content.Context#getSystemService * Context.getSystemService(Context.LOCATION_SERVICE)}. + * + *
    + *

    Developer Guides

    + *

    For more information about using location services, read the + * Location and Maps + * developer guide.

    + *
    */ public class LocationManager { private static final String TAG = "LocationManager"; diff --git a/location/java/android/location/package.html b/location/java/android/location/package.html index be34774..1abe098 100644 --- a/location/java/android/location/package.html +++ b/location/java/android/location/package.html @@ -1,10 +1,10 @@ -

    Contains classes that define Android location-based and related services.

    -

    For more information about location services, see the documentation for Obtaining User Location.

    + +

    For more information, see the +Location and Maps developer guide.

    {@more} diff --git a/test-runner/src/android/test/ActivityInstrumentationTestCase2.java b/test-runner/src/android/test/ActivityInstrumentationTestCase2.java index 24b125e..c4bcf31 100644 --- a/test-runner/src/android/test/ActivityInstrumentationTestCase2.java +++ b/test-runner/src/android/test/ActivityInstrumentationTestCase2.java @@ -37,6 +37,12 @@ import java.lang.reflect.Method; * New tests should be written using this base class. * *

    If you prefer an isolated unit test, see {@link android.test.ActivityUnitTestCase}. + * + *

    + *

    Developer Guides

    + *

    For more information about application testing, read the + * Testing developer guide.

    + *
    */ public abstract class ActivityInstrumentationTestCase2 extends ActivityTestCase { diff --git a/test-runner/src/android/test/InstrumentationTestRunner.java b/test-runner/src/android/test/InstrumentationTestRunner.java index 70cf89e..43285fb 100644 --- a/test-runner/src/android/test/InstrumentationTestRunner.java +++ b/test-runner/src/android/test/InstrumentationTestRunner.java @@ -54,7 +54,15 @@ import junit.textui.ResultPrinter; /** * An {@link Instrumentation} that runs various types of {@link junit.framework.TestCase}s against - * an Android package (application). Typical usage: + * an Android package (application). + * + *
    + *

    Developer Guides

    + *

    For more information about application testing, read the + * Testing developer guide.

    + *
    + * + *

    Typical Usage

    *
      *
    1. Write {@link junit.framework.TestCase}s that perform unit, functional, or performance tests * against the classes in your package. Typically these are subclassed from: diff --git a/test-runner/src/android/test/ServiceTestCase.java b/test-runner/src/android/test/ServiceTestCase.java index 8fad5d6..06c1c5b 100644 --- a/test-runner/src/android/test/ServiceTestCase.java +++ b/test-runner/src/android/test/ServiceTestCase.java @@ -34,6 +34,12 @@ import java.util.Random; * Service, and hooks with which you can inject various dependencies and control * the environment in which your Service is tested. * + *
      + *

      Developer Guides

      + *

      For more information about application testing, read the + * Testing developer guide.

      + *
      + * *

      Lifecycle Support. * A Service is accessed with a specific sequence of * calls, as described in the diff --git a/test-runner/src/android/test/mock/MockContentResolver.java b/test-runner/src/android/test/mock/MockContentResolver.java index 26eb8e4..6c91f4e 100644 --- a/test-runner/src/android/test/mock/MockContentResolver.java +++ b/test-runner/src/android/test/mock/MockContentResolver.java @@ -43,6 +43,12 @@ import java.util.Map; * Users can also set an authority's entry in the map to null, so that a provider is completely * mocked out. *

      + * + *
      + *

      Developer Guides

      + *

      For more information about application testing, read the + * Testing developer guide.

      + *
      */ public class MockContentResolver extends ContentResolver { diff --git a/test-runner/src/android/test/mock/package.html b/test-runner/src/android/test/mock/package.html index 0f1bc6f4..29b2d80 100644 --- a/test-runner/src/android/test/mock/package.html +++ b/test-runner/src/android/test/mock/package.html @@ -1,5 +1,10 @@ -Utility classes providing stubs or mocks of various Android framework building blocks. +

      Utility classes providing stubs or mocks of various Android framework building blocks.

      + +

      For more information, see the +Testing developer guide.

      +{@more} + diff --git a/voip/java/android/net/sip/SipAudioCall.java b/voip/java/android/net/sip/SipAudioCall.java index fcdbd2c..1d67055 100644 --- a/voip/java/android/net/sip/SipAudioCall.java +++ b/voip/java/android/net/sip/SipAudioCall.java @@ -44,13 +44,20 @@ import java.util.Map; * *

      Note: Using this class require the * {@link android.Manifest.permission#INTERNET} and - * {@link android.Manifest.permission#USE_SIP} permissions.

      In addition, {@link + * {@link android.Manifest.permission#USE_SIP} permissions. In addition, {@link * #startAudio} requires the * {@link android.Manifest.permission#RECORD_AUDIO}, * {@link android.Manifest.permission#ACCESS_WIFI_STATE}, and * {@link android.Manifest.permission#WAKE_LOCK} permissions; and {@link #setSpeakerMode * setSpeakerMode()} requires the * {@link android.Manifest.permission#MODIFY_AUDIO_SETTINGS} permission.

      + * + *
      + *

      Developer Guides

      + *

      For more information about using SIP, read the + * Session Initiation Protocol + * developer guide.

      + *
      */ public class SipAudioCall { private static final String TAG = SipAudioCall.class.getSimpleName(); diff --git a/voip/java/android/net/sip/SipManager.java b/voip/java/android/net/sip/SipManager.java index cd0b5c4..74c3672 100644 --- a/voip/java/android/net/sip/SipManager.java +++ b/voip/java/android/net/sip/SipManager.java @@ -49,9 +49,16 @@ import java.text.ParseException; * SIP. You should always call {@link android.net.sip.SipManager#isVoipSupported * isVoipSupported()} to verify that the device supports VOIP calling and {@link * android.net.sip.SipManager#isApiSupported isApiSupported()} to verify that the device supports - * the SIP APIs.

      Your application must also request the {@link + * the SIP APIs. Your application must also request the {@link * android.Manifest.permission#INTERNET} and {@link android.Manifest.permission#USE_SIP} * permissions.

      + * + *
      + *

      Developer Guides

      + *

      For more information about using SIP, read the + * Session Initiation Protocol + * developer guide.

      + *
      */ public class SipManager { /** diff --git a/voip/java/android/net/sip/SipProfile.java b/voip/java/android/net/sip/SipProfile.java index 34d91dd..0ef754c 100644 --- a/voip/java/android/net/sip/SipProfile.java +++ b/voip/java/android/net/sip/SipProfile.java @@ -37,6 +37,13 @@ import javax.sip.address.URI; *

      You can create a {@link SipProfile} using {@link * SipProfile.Builder}. You can also retrieve one from a {@link SipSession}, using {@link * SipSession#getLocalProfile} and {@link SipSession#getPeerProfile}.

      + * + *
      + *

      Developer Guides

      + *

      For more information about using SIP, read the + * Session Initiation Protocol + * developer guide.

      + *
      */ public class SipProfile implements Parcelable, Serializable, Cloneable { private static final long serialVersionUID = 1L; diff --git a/voip/java/android/net/sip/package.html b/voip/java/android/net/sip/package.html index 790656b..eb683d0 100644 --- a/voip/java/android/net/sip/package.html +++ b/voip/java/android/net/sip/package.html @@ -3,6 +3,11 @@

      Provides access to Session Initiation Protocol (SIP) functionality, such as making and answering VOIP calls using SIP.

      +

      For more information, see the +Session Initiation Protocol +developer guide.

      +{@more} +

      To get started, you need to get an instance of the {@link android.net.sip.SipManager} by calling {@link android.net.sip.SipManager#newInstance newInstance()}.

      @@ -31,9 +36,10 @@ Not all Android-powered devices support VOIP functionality with SIP. Before perf activity, you should call {@link android.net.sip.SipManager#isVoipSupported isVoipSupported()} to verify that the device supports VOIP calling and {@link android.net.sip.SipManager#isApiSupported isApiSupported()} to verify that the device supports the -SIP APIs.

      +SIP APIs. Your application must also request the {@link android.Manifest.permission#INTERNET} and {@link android.Manifest.permission#USE_SIP} permissions in order to use the SIP APIs.

      + \ No newline at end of file -- cgit v1.1