am bb7f590a: Merge "docs: Add developer guide cross-references, Project ACRE, round 4" into ics-mr1

* commit 'bb7f590a5a539486de5127071c7ade8ec988d755':
  docs: Add developer guide cross-references, Project ACRE, round 4
This commit is contained in:
Joe Fernandez
2011-12-22 15:57:09 -08:00
committed by Android Git Automerger
51 changed files with 327 additions and 59 deletions

View File

@@ -39,6 +39,13 @@ import java.util.List;
* result in none of the affected animations being played. Because of this (and because * result in none of the affected animations being played. Because of this (and because
* circular dependencies do not make logical sense anyway), circular dependencies * 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. * should be avoided, and the dependency flow of animations should only be in one direction.
*
* <div class="special reference">
* <h3>Developer Guides</h3>
* <p>For more information about animating with {@code AnimatorSet}, read the
* <a href="{@docRoot}guide/topics/graphics/prop-animation.html#choreography">Property
* Animation</a> developer guide.</p>
* </div>
*/ */
public final class AnimatorSet extends Animator { public final class AnimatorSet extends Animator {

View File

@@ -29,6 +29,13 @@ import java.util.ArrayList;
* are then determined internally and the animation will call these functions as necessary to * are then determined internally and the animation will call these functions as necessary to
* animate the property. * animate the property.
* *
* <div class="special reference">
* <h3>Developer Guides</h3>
* <p>For more information about animating with {@code ObjectAnimator}, read the
* <a href="{@docRoot}guide/topics/graphics/prop-animation.html#object-animator">Property
* Animation</a> developer guide.</p>
* </div>
*
* @see #setPropertyName(String) * @see #setPropertyName(String)
* *
*/ */

View File

@@ -38,6 +38,13 @@ import java.util.HashMap;
* {@link AccelerateDecelerateInterpolator} class, which accelerates into and decelerates * {@link AccelerateDecelerateInterpolator} class, which accelerates into and decelerates
* out of an animation. This behavior can be changed by calling * out of an animation. This behavior can be changed by calling
* {@link ValueAnimator#setInterpolator(TimeInterpolator)}.</p> * {@link ValueAnimator#setInterpolator(TimeInterpolator)}.</p>
*
* <div class="special reference">
* <h3>Developer Guides</h3>
* <p>For more information about animating with {@code ValueAnimator}, read the
* <a href="{@docRoot}guide/topics/graphics/prop-animation.html#value-animator">Property
* Animation</a> developer guide.</p>
* </div>
*/ */
public class ValueAnimator extends Animator { public class ValueAnimator extends Animator {

View File

@@ -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}. to calculate the values for that given type with a custom {@link android.animation.TypeEvaluator}.
</p> </p>
<p>For more information, see the
<a href="{@docRoot}guide/topics/graphics/animation.html">Animation</a> developer guide.</p>
{@more}
<p> <p>
You can set many different types of interpolators (contained in {@link android.view.animation}), 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 specify {@link android.animation.Keyframe keyframes}, or group animations to play sequentially
or simultaneously (with {@link android.animation.AnimatorSet}) to further control your animation or simultaneously (with {@link android.animation.AnimatorSet}) to further control your animation
behaviors.</p> behaviors.</p>
<p>
For a guide on how to use the property animation system, see the
<a href="{@docRoot}guide/topics/graphics/animation.html">Animation</a> developer guide.
</p>
</body> </body>
</html> </html>

View File

@@ -48,10 +48,11 @@ import java.util.List;
* {@link android.content.Context#getSystemService * {@link android.content.Context#getSystemService
* context.getSystemService(Context.SEARCH_SERVICE)}. * context.getSystemService(Context.SEARCH_SERVICE)}.
* *
* <div class="special"> * <div class="special reference">
* <p>For a guide to using the search dialog and adding search * <h3>Developer Guides</h3>
* suggestions in your application, see the Dev Guide topic about <strong><a * <p>For more information about using the search dialog and adding search
* href="{@docRoot}guide/topics/search/index.html">Search</a></strong>.</p> * suggestions in your application, read the
* <a href="{@docRoot}guide/topics/search/index.html">Search</a> developer guide.</p>
* </div> * </div>
*/ */
public class SearchManager public class SearchManager

View File

@@ -49,6 +49,13 @@ import android.os.Bundle;
* A typical file would be:</p> * A typical file would be:</p>
* *
* {@sample development/samples/ApiDemos/res/xml/device_admin_sample.xml meta_data} * {@sample development/samples/ApiDemos/res/xml/device_admin_sample.xml meta_data}
*
* <div class="special reference">
* <h3>Developer Guides</h3>
* <p>For more information about device administration, read the
* <a href="{@docRoot}guide/topics/admin/device-admin.html">Device Administration</a>
* developer guide.</p>
* </div>
*/ */
public class DeviceAdminReceiver extends BroadcastReceiver { public class DeviceAdminReceiver extends BroadcastReceiver {
private static String TAG = "DevicePolicy"; private static String TAG = "DevicePolicy";

View File

@@ -40,6 +40,13 @@ import java.util.List;
* Public interface for managing policies enforced on a device. Most clients * Public interface for managing policies enforced on a device. Most clients
* of this class must have published a {@link DeviceAdminReceiver} that the user * of this class must have published a {@link DeviceAdminReceiver} that the user
* has currently enabled. * has currently enabled.
*
* <div class="special reference">
* <h3>Developer Guides</h3>
* <p>For more information about managing policies for device adminstration, read the
* <a href="{@docRoot}guide/topics/admin/device-admin.html">Device Administration</a>
* developer guide.</p>
* </div>
*/ */
public class DevicePolicyManager { public class DevicePolicyManager {
private static String TAG = "DevicePolicyManager"; private static String TAG = "DevicePolicyManager";

View File

@@ -4,8 +4,9 @@
security-aware applications that are useful in enterprise settings, in which IT professionals security-aware applications that are useful in enterprise settings, in which IT professionals
require rich control over employee devices.</p> require rich control over employee devices.</p>
<p>For more information, see the <a <p>For more information, see the
href="{@docRoot}guide/topics/admin/device-admin.html">Device Administration</a> developer guide.</p> <a href="{@docRoot}guide/topics/admin/device-admin.html">Device Administration</a>
developer guide.</p>
{@more} {@more}
</BODY> </BODY>

View File

@@ -35,6 +35,12 @@ import java.util.WeakHashMap;
/** /**
* Updates AppWidget state; gets information about installed AppWidget providers and other * Updates AppWidget state; gets information about installed AppWidget providers and other
* AppWidget related state. * AppWidget related state.
*
* <div class="special reference">
* <h3>Developer Guides</h3>
* <p>For more information about creating app widgets, read the
* <a href="{@docRoot}guide/topics/appwidgets/index.html">App Widgets</a> developer guide.</p>
* </div>
*/ */
public class AppWidgetManager { public class AppWidgetManager {
static final String TAG = "AppWidgetManager"; static final String TAG = "AppWidgetManager";

View File

@@ -31,8 +31,13 @@ import android.os.Bundle;
* <p>Extend this class and override one or more of the {@link #onUpdate}, {@link #onDeleted}, * <p>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. * {@link #onEnabled} or {@link #onDisabled} methods to implement your own AppWidget functionality.
* </p> * </p>
* <p>For an example of how to write a AppWidget provider, see the *
* <a href="{@docRoot}guide/topics/appwidgets/index.html#Providers">AppWidgets</a> documentation.</p> * <div class="special reference">
* <h3>Developer Guides</h3>
* <p>For more information about how to write an app widget provider, read the
* <a href="{@docRoot}guide/topics/appwidgets/index.html#AppWidgetProvider">App Widgets</a>
* developer guide.</p>
* </div>
*/ */
public class AppWidgetProvider extends BroadcastReceiver { public class AppWidgetProvider extends BroadcastReceiver {
/** /**

View File

@@ -2,11 +2,11 @@
<p>Contains the components necessary to create "app widgets", which users can embed in other <p>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 applications (such as the home screen) to quickly access application data and services without
launching a new activity.</p> launching a new activity.</p>
<p>For more information, see the
<a href="{@docRoot}guide/topics/appwidgets/index.html">App Widgets</a>
developer guide.</p>
<p>For more information, see the
<a href="{@docRoot}guide/topics/appwidgets/index.html">App Widgets</a> developer guide.</p>
{@more} {@more}
<p>The behavior of an app widget is published by an "app widget provider." An "app widget host" is <p>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).</p> a component that can contain app widgets (such as the Home screen).</p>
@@ -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 widgets, but the lock screen could also contain widgets, and it would have a different way of
adding, removing and otherwise managing widgets.</p> adding, removing and otherwise managing widgets.</p>
<p>The <a href="{@docRoot}guide/topics/appwidgets/index.html">App Widgets</a> <p>For information about implementing an app widget host, see the {@link
developer guide shows you how to create an app widget provider. For information about implementing android.appwidget.AppWidgetHost} class.</p>
an app widget host, see the {@link android.appwidget.AppWidgetHost} class.</p>
</body> </body>

View File

@@ -62,6 +62,12 @@ import java.util.UUID;
* permission and some also require the * permission and some also require the
* {@link android.Manifest.permission#BLUETOOTH_ADMIN} permission. * {@link android.Manifest.permission#BLUETOOTH_ADMIN} permission.
* *
* <div class="special reference">
* <h3>Developer Guides</h3>
* <p>For more information about using Bluetooth, read the
* <a href="{@docRoot}guide/topics/wireless/bluetooth.html">Bluetooth</a> developer guide.</p>
* </div>
*
* {@see BluetoothDevice} * {@see BluetoothDevice}
* {@see BluetoothServerSocket} * {@see BluetoothServerSocket}
*/ */

View File

@@ -54,6 +54,12 @@ import java.util.UUID;
* <p class="note"><strong>Note:</strong> * <p class="note"><strong>Note:</strong>
* Requires the {@link android.Manifest.permission#BLUETOOTH} permission. * Requires the {@link android.Manifest.permission#BLUETOOTH} permission.
* *
* <div class="special reference">
* <h3>Developer Guides</h3>
* <p>For more information about using Bluetooth, read the
* <a href="{@docRoot}guide/topics/wireless/bluetooth.html">Bluetooth</a> developer guide.</p>
* </div>
*
* {@see BluetoothAdapter} * {@see BluetoothAdapter}
* {@see BluetoothSocket} * {@see BluetoothSocket}
*/ */

View File

@@ -55,6 +55,12 @@ import java.io.IOException;
* <p class="note"><strong>Note:</strong> * <p class="note"><strong>Note:</strong>
* Requires the {@link android.Manifest.permission#BLUETOOTH} permission. * Requires the {@link android.Manifest.permission#BLUETOOTH} permission.
* *
* <div class="special reference">
* <h3>Developer Guides</h3>
* <p>For more information about using Bluetooth, read the
* <a href="{@docRoot}guide/topics/wireless/bluetooth.html">Bluetooth</a> developer guide.</p>
* </div>
*
* {@see BluetoothSocket} * {@see BluetoothSocket}
*/ */
public final class BluetoothServerSocket implements Closeable { public final class BluetoothServerSocket implements Closeable {

View File

@@ -65,6 +65,12 @@ import java.util.concurrent.locks.ReentrantReadWriteLock;
* <p class="note"><strong>Note:</strong> * <p class="note"><strong>Note:</strong>
* Requires the {@link android.Manifest.permission#BLUETOOTH} permission. * Requires the {@link android.Manifest.permission#BLUETOOTH} permission.
* *
* <div class="special reference">
* <h3>Developer Guides</h3>
* <p>For more information about using Bluetooth, read the
* <a href="{@docRoot}guide/topics/wireless/bluetooth.html">Bluetooth</a> developer guide.</p>
* </div>
*
* {@see BluetoothServerSocket} * {@see BluetoothServerSocket}
* {@see java.io.InputStream} * {@see java.io.InputStream}
* {@see java.io.OutputStream} * {@see java.io.OutputStream}

View File

@@ -3,8 +3,8 @@
<p>Provides classes that manage Bluetooth functionality, such as scanning for <p>Provides classes that manage Bluetooth functionality, such as scanning for
devices, connecting with devices, and managing data transfer between devices.</p> devices, connecting with devices, and managing data transfer between devices.</p>
<p>For more information, see the <a <p>For more information, see the
href="{@docRoot}guide/topics/wireless/bluetooth.html">Bluetooth</a> developer guide.</p> <a href="{@docRoot}guide/topics/wireless/bluetooth.html">Bluetooth</a> developer guide.</p>
{@more} {@more}
<p>The Bluetooth APIs let applications:</p> <p>The Bluetooth APIs let applications:</p>
@@ -26,5 +26,6 @@ permission.
<p class="note"><strong>Note:</strong> <p class="note"><strong>Note:</strong>
Not all Android-powered devices provide Bluetooth functionality.</p> Not all Android-powered devices provide Bluetooth functionality.</p>
</BODY> </BODY>
</HTML> </HTML>

View File

@@ -50,6 +50,13 @@ import java.util.ArrayList;
* CharSequence of text, a single Intent object, or a Uri. See {@link Item} * CharSequence of text, a single Intent object, or a Uri. See {@link Item}
* for more details. * for more details.
* *
* <div class="special reference">
* <h3>Developer Guides</h3>
* <p>For more information about using the clipboard framework, read the
* <a href="{@docRoot}guide/topics/clipboard/copy-paste.html">Copy and Paste</a>
* developer guide.</p>
* </div>
*
* <a name="ImplementingPaste"></a> * <a name="ImplementingPaste"></a>
* <h3>Implementing Paste or Drop</h3> * <h3>Implementing Paste or Drop</h3>
* *

View File

@@ -26,6 +26,13 @@ import java.util.ArrayList;
* Meta-data describing the contents of a {@link ClipData}. Provides enough * Meta-data describing the contents of a {@link ClipData}. Provides enough
* information to know if you can handle the ClipData, but not the data * information to know if you can handle the ClipData, but not the data
* itself. * itself.
*
* <div class="special reference">
* <h3>Developer Guides</h3>
* <p>For more information about using the clipboard framework, read the
* <a href="{@docRoot}guide/topics/clipboard/copy-paste.html">Copy and Paste</a>
* developer guide.</p>
* </div>
*/ */
public class ClipDescription implements Parcelable { public class ClipDescription implements Parcelable {
/** /**

View File

@@ -40,6 +40,13 @@ import java.util.ArrayList;
* is expressed as a {@link ClipData} object, which defines the protocol * is expressed as a {@link ClipData} object, which defines the protocol
* for data exchange between applications. * for data exchange between applications.
* *
* <div class="special reference">
* <h3>Developer Guides</h3>
* <p>For more information about using the clipboard framework, read the
* <a href="{@docRoot}guide/topics/clipboard/copy-paste.html">Copy and Paste</a>
* developer guide.</p>
* </div>
*
* @see android.content.Context#getSystemService * @see android.content.Context#getSystemService
*/ */
public class ClipboardManager extends android.text.ClipboardManager { public class ClipboardManager extends android.text.ClipboardManager {

View File

@@ -61,6 +61,12 @@ import android.util.Log;
* for future searches by calling {@link android.provider.SearchRecentSuggestions#saveRecentQuery * for future searches by calling {@link android.provider.SearchRecentSuggestions#saveRecentQuery
* SearchRecentSuggestions.saveRecentQuery()}.</li> * SearchRecentSuggestions.saveRecentQuery()}.</li>
* </ul> * </ul>
*
* <div class="special reference">
* <h3>Developer Guides</h3>
* <p>For information about using search suggestions in your application, read the
* <a href="{@docRoot}guide/topics/search/index.html">Search</a> developer guide.</p>
* </div>
* *
* @see android.provider.SearchRecentSuggestions * @see android.provider.SearchRecentSuggestions
*/ */

View File

@@ -37,6 +37,12 @@ import android.util.Log;
* {@link UsbManager#ACTION_USB_ACCESSORY_ATTACHED} Intent. * {@link UsbManager#ACTION_USB_ACCESSORY_ATTACHED} Intent.
* The application can then call {@link UsbManager#openAccessory} to open a file descriptor * The application can then call {@link UsbManager#openAccessory} to open a file descriptor
* for reading and writing data to and from the accessory. * for reading and writing data to and from the accessory.
*
* <div class="special reference">
* <h3>Developer Guides</h3>
* <p>For more information about communicating with USB hardware, read the
* <a href="{@docRoot}guide/topics/usb/index.html">USB</a> developer guide.</p>
* </div>
*/ */
public class UsbAccessory implements Parcelable { public class UsbAccessory implements Parcelable {

View File

@@ -34,6 +34,12 @@ import java.io.FileDescriptor;
* To communicate with the device, you open a {@link UsbDeviceConnection} for the device * 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. * and use {@link UsbRequest} to send and receive data on an endpoint.
* {@link UsbDeviceConnection#controlTransfer} is used for control requests on endpoint zero. * {@link UsbDeviceConnection#controlTransfer} is used for control requests on endpoint zero.
*
* <div class="special reference">
* <h3>Developer Guides</h3>
* <p>For more information about communicating with USB hardware, read the
* <a href="{@docRoot}guide/topics/usb/index.html">USB</a> developer guide.</p>
* </div>
*/ */
public class UsbDevice implements Parcelable { public class UsbDevice implements Parcelable {

View File

@@ -26,6 +26,12 @@ import android.os.Parcelable;
* piece of functionality, separate from the other interfaces. * piece of functionality, separate from the other interfaces.
* An interface will have one or more {@link UsbEndpoint}s, which are the * An interface will have one or more {@link UsbEndpoint}s, which are the
* channels by which the host transfers data with the device. * channels by which the host transfers data with the device.
*
* <div class="special reference">
* <h3>Developer Guides</h3>
* <p>For more information about communicating with USB hardware, read the
* <a href="{@docRoot}guide/topics/usb/index.html">USB</a> developer guide.</p>
* </div>
*/ */
public class UsbInterface implements Parcelable { public class UsbInterface implements Parcelable {

View File

@@ -35,8 +35,13 @@ import java.util.HashMap;
* {@link android.content.Context#getSystemService(java.lang.String) Context.getSystemService()}. * {@link android.content.Context#getSystemService(java.lang.String) Context.getSystemService()}.
* *
* {@samplecode * {@samplecode
* UsbManager manager = (UsbManager) getSystemService(Context.USB_SERVICE); * UsbManager manager = (UsbManager) getSystemService(Context.USB_SERVICE);}
* } *
* <div class="special reference">
* <h3>Developer Guides</h3>
* <p>For more information about communicating with USB hardware, read the
* <a href="{@docRoot}guide/topics/usb/index.html">USB</a> developer guide.</p>
* </div>
*/ */
public class UsbManager { public class UsbManager {
private static final String TAG = "UsbManager"; private static final String TAG = "UsbManager";

View File

@@ -1,9 +1,16 @@
<HTML> <HTML>
<BODY> <BODY>
<p>Provides support to communicate with USB hardware peripherals that are connected to Android-powered <p>Provides support to communicate with USB hardware peripherals that are connected to
devices. Use {@link android.hardware.usb.UsbManager} to access the state of the USB and to Android-powered devices.</p>
<p>For more information, see the
<a href="{@docRoot}guide/topics/usb/index.html">USB</a> developer guide.</p>
{@more}
<p>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 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 communicate with the hardware peripheral if the Android-powered device is acting as the USB host.
{@link android.hardware.usb.UsbAccessory} if the peripheral is acting as the USB host.</p> Use {@link android.hardware.usb.UsbAccessory} if the peripheral is acting as the USB host.</p>
</BODY> </BODY>
</HTML> </HTML>

View File

@@ -42,6 +42,12 @@ import android.util.Log;
* <p> * <p>
* Use the helper {@link #getDefaultAdapter(Context)} to get the default NFC * Use the helper {@link #getDefaultAdapter(Context)} to get the default NFC
* adapter for this Android device. * adapter for this Android device.
*
* <div class="special reference">
* <h3>Developer Guides</h3>
* <p>For more information about using NFC, read the
* <a href="{@docRoot}guide/topics/nfc/index.html">Near Field Communication</a> developer guide.</p>
* </div>
*/ */
public final class NfcAdapter { public final class NfcAdapter {
static final String TAG = "NFC"; static final String TAG = "NFC";

View File

@@ -28,6 +28,12 @@ import android.content.Context;
* Alternately, you can just call the static helper * Alternately, you can just call the static helper
* {@link NfcAdapter#getDefaultAdapter(android.content.Context)}. * {@link NfcAdapter#getDefaultAdapter(android.content.Context)}.
* *
* <div class="special reference">
* <h3>Developer Guides</h3>
* <p>For more information about using NFC, read the
* <a href="{@docRoot}guide/topics/nfc/index.html">Near Field Communication</a> developer guide.</p>
* </div>
*
* @see Context#getSystemService * @see Context#getSystemService
* @see NfcAdapter#getDefaultAdapter(android.content.Context) * @see NfcAdapter#getDefaultAdapter(android.content.Context)
*/ */

View File

@@ -1,7 +1,11 @@
<HTML> <HTML>
<BODY> <BODY>
Provides access to Near Field Communication (NFC) functionality, allowing applications to read <p>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. NDEF message in NFC tags. A "tag" may actually be another device that appears as a tag.</p>
<p>For more information, see the
<a href="{@docRoot}guide/topics/nfc/index.html">Near Field Communication</a> developer guide.</p>
{@more}
<p>Here's a summary of the classes:</p> <p>Here's a summary of the classes:</p>
@@ -24,5 +28,6 @@ type of data being shared and carries the data itself.</dd>
<p class="note"><strong>Note:</strong> <p class="note"><strong>Note:</strong>
Not all Android-powered devices provide NFC functionality.</p> Not all Android-powered devices provide NFC functionality.</p>
</BODY> </BODY>
</HTML> </HTML>

View File

@@ -44,6 +44,13 @@ import java.util.concurrent.Semaphore;
* *
* <p>For a working example, see SearchSuggestionSampleProvider and SearchQueryResults in * <p>For a working example, see SearchSuggestionSampleProvider and SearchQueryResults in
* samples/ApiDemos/app. * samples/ApiDemos/app.
*
* <div class="special reference">
* <h3>Developer Guides</h3>
* <p>For information about using search suggestions in your application, read the
* <a href="{@docRoot}guide/topics/search/adding-recent-query-suggestions.html">Adding Recent Query
* Suggestions</a> developer guide.</p>
* </div>
*/ */
public class SearchRecentSuggestions { public class SearchRecentSuggestions {
// debugging support // debugging support

View File

@@ -1,5 +1,10 @@
<HTML> <HTML>
<BODY> <BODY>
A framework for writing Android test cases and suites. <p>A framework for writing Android test cases and suites.</p>
<p>For more information, see the
<a href="{@docRoot}guide/topics/testing/index.html">Testing</a> developer guide.</p>
{@more}
</BODY> </BODY>
</HTML> </HTML>

View File

@@ -75,10 +75,11 @@ import java.util.WeakHashMap;
* If you want the search field to always be visible, then call setIconifiedByDefault(false). * If you want the search field to always be visible, then call setIconifiedByDefault(false).
* </p> * </p>
* *
* <p> * <div class="special reference">
* For more information, see the <a href="{@docRoot}guide/topics/search/index.html">Search</a> * <h3>Developer Guides</h3>
* documentation. * <p>For information about using {@code SearchView}, read the
* <p> * <a href="{@docRoot}guide/topics/search/index.html">Search</a> developer guide.</p>
* </div>
* *
* @see android.view.MenuItem#SHOW_AS_ACTION_COLLAPSE_ACTION_VIEW * @see android.view.MenuItem#SHOW_AS_ACTION_COLLAPSE_ACTION_VIEW
* @attr ref android.R.styleable#SearchView_iconifiedByDefault * @attr ref android.R.styleable#SearchView_iconifiedByDefault

View File

@@ -64,8 +64,13 @@ import android.util.AttributeSet;
* // Start the animation (looped playback by default). * // Start the animation (looped playback by default).
* frameAnimation.start(); * frameAnimation.start();
* </pre> * </pre>
* <p>For more information, see the guide to <a *
* href="{@docRoot}guide/topics/resources/animation-resource.html">Animation Resources</a>.</p> * <div class="special reference">
* <h3>Developer Guides</h3>
* <p>For more information about animating with {@code AnimationDrawable}, read the
* <a href="{@docRoot}guide/topics/graphics/drawable-animation.html">Drawable Animation</a>
* developer guide.</p>
* </div>
* *
* @attr ref android.R.styleable#AnimationDrawable_visible * @attr ref android.R.styleable#AnimationDrawable_visible
* @attr ref android.R.styleable#AnimationDrawable_variablePadding * @attr ref android.R.styleable#AnimationDrawable_variablePadding

View File

@@ -62,6 +62,11 @@ import android.util.TypedValue;
* The unchecked variants exist to allow apps to copy over arrays of structures from a * The unchecked variants exist to allow apps to copy over arrays of structures from a
* control language that does not support structures.</p> * control language that does not support structures.</p>
* *
* <div class="special reference">
* <h3>Developer Guides</h3>
* <p>For more information about creating an application that uses Renderscript, read the
* <a href="{@docRoot}guide/topics/graphics/renderscript.html">Renderscript</a> developer guide.</p>
* </div>
**/ **/
public class Allocation extends BaseObj { public class Allocation extends BaseObj {
Type mType; Type mType;

View File

@@ -40,6 +40,12 @@ import android.util.Log;
* <p>The primary source of elements are from scripts. A script that exports a * <p>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 * 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.</p> * data exported by the script. The other common source of elements is from bitmap formats.</p>
*
* <div class="special reference">
* <h3>Developer Guides</h3>
* <p>For more information about creating an application that uses Renderscript, read the
* <a href="{@docRoot}guide/topics/graphics/renderscript.html">Renderscript</a> developer guide.</p>
* </div>
**/ **/
public class Element extends BaseObj { public class Element extends BaseObj {
int mSize; int mSize;

View File

@@ -31,6 +31,12 @@ import android.view.SurfaceView;
/** /**
* The Surface View for a graphics renderscript (RenderScriptGL) to draw on. * The Surface View for a graphics renderscript (RenderScriptGL) to draw on.
*
* <div class="special reference">
* <h3>Developer Guides</h3>
* <p>For more information about creating an application that uses Renderscript, read the
* <a href="{@docRoot}guide/topics/graphics/renderscript.html">Renderscript</a> developer guide.</p>
* </div>
*/ */
public class RSSurfaceView extends SurfaceView implements SurfaceHolder.Callback { public class RSSurfaceView extends SurfaceView implements SurfaceHolder.Callback {
private SurfaceHolder mSurfaceHolder; private SurfaceHolder mSurfaceHolder;

View File

@@ -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 * worker threads for processing commands from this object. This base class
* does not provide any extended capabilities beyond simple data processing. * does not provide any extended capabilities beyond simple data processing.
* For extended capabilities use derived classes such as RenderScriptGL. * For extended capabilities use derived classes such as RenderScriptGL.
* *
* * <div class="special reference">
* * <h3>Developer Guides</h3>
* <p>For more information about creating an application that uses Renderscript, read the
* <a href="{@docRoot}guide/topics/graphics/renderscript.html">Renderscript</a> developer guide.</p>
* </div>
**/ **/
public class RenderScript { public class RenderScript {
static final String LOG_TAG = "RenderScript_jni"; static final String LOG_TAG = "RenderScript_jni";

View File

@@ -29,11 +29,17 @@ import android.view.SurfaceHolder;
import android.view.SurfaceView; 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 * 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 * 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 * called. This script is expected to issue the rendering commands to repaint
* the screen. * the screen.
*
* <div class="special reference">
* <h3>Developer Guides</h3>
* <p>For more information about creating an application that uses Renderscript, read the
* <a href="{@docRoot}guide/topics/graphics/renderscript.html">Renderscript</a> developer guide.</p>
* </div>
**/ **/
public class RenderScriptGL extends RenderScript { public class RenderScriptGL extends RenderScript {
int mWidth; int mWidth;

View File

@@ -35,6 +35,11 @@ import android.util.Log;
* *
* <p>The LOD and Faces dimensions are booleans to indicate present or not present.</p> * <p>The LOD and Faces dimensions are booleans to indicate present or not present.</p>
* *
* <div class="special reference">
* <h3>Developer Guides</h3>
* <p>For more information about creating an application that uses Renderscript, read the
* <a href="{@docRoot}guide/topics/graphics/renderscript.html">Renderscript</a> developer guide.</p>
* </div>
**/ **/
public class Type extends BaseObj { public class Type extends BaseObj {
int mDimX; int mDimX;

View File

@@ -1,10 +1,16 @@
<HTML> <HTML>
<BODY> <BODY>
<p>The Renderscript rendering and computational APIs offer a low-level, high performance means of <p>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 carrying out mathematical calculations and 3D graphics rendering.</p>
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 <p>For more information, see the
native code and want to maximize their performance critical applications.</p> <a href="{@docRoot}guide/topics/graphics/renderscript.html">Renderscript</a> developer guide.</p>
{@more}
<p>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.</p>
<p>Renderscript adopts a control and slave architecture where the low-level native code is controlled by the <p>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 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.</p> does the intensive computation and returns the result back to the Android VM.</p>
<p>You can find the Renderscript native <p>You can find the Renderscript native
APIs in the <code>&lt;sdk_root&gt;/platforms/android-3.0/renderscript</code> directory. APIs in the <code>&lt;sdk_root&gt;/platforms/android-11/renderscript</code> directory.
The Android system APIs are broken into a few main groups:</p> The Android system APIs are broken into a few main groups:</p>
<h4>Core</h4> <h4>Core</h4>
@@ -37,7 +43,7 @@ classes include:</p>
<li>Byte2, Byte3, and Byte4</li> <li>Byte2, Byte3, and Byte4</li>
<li>Float2, Float3, Float4</li> <li>Float2, Float3, Float4</li>
<li>Int2, Int3, Int4</li> <li>Int2, Int3, Int4</li>
<li>Long2, Long3, Long4</li> <li>Long2, Long3, Long4</li>
<li>Matrix2f, Matrix3f, Matrix4f</li> <li>Matrix2f, Matrix3f, Matrix4f</li>
<li>Short2, Short3, Short4</li> <li>Short2, Short3, Short4</li>
</ul> </ul>
@@ -75,11 +81,6 @@ pipeline.</p>
<li>Sampler</li> <li>Sampler</li>
</ul> </ul>
</p>
<p>
For information on how to create an application that uses Renderscript, and also the
see <a href="../../../guide/topics/graphics/renderscript.html">3D with
Renderscript</a> dev guide.
</p> </p>
</BODY> </BODY>
</HTML> </HTML>

View File

@@ -24,6 +24,13 @@ import android.os.Bundle;
* LocationListener has been registered with the location manager service * LocationListener has been registered with the location manager service
* using the {@link LocationManager#requestLocationUpdates(String, long, float, LocationListener)} * using the {@link LocationManager#requestLocationUpdates(String, long, float, LocationListener)}
* method. * method.
*
* <div class="special reference">
* <h3>Developer Guides</h3>
* <p>For more information about identifying user location, read the
* <a href="{@docRoot}guide/topics/location/obtaining-user-location.html">Obtaining User
* Location</a> developer guide.</p>
* </div>
*/ */
public interface LocationListener { public interface LocationListener {

View File

@@ -42,6 +42,13 @@ import java.util.List;
* instantiate this class directly; instead, retrieve it through * instantiate this class directly; instead, retrieve it through
* {@link android.content.Context#getSystemService * {@link android.content.Context#getSystemService
* Context.getSystemService(Context.LOCATION_SERVICE)}. * Context.getSystemService(Context.LOCATION_SERVICE)}.
*
* <div class="special reference">
* <h3>Developer Guides</h3>
* <p>For more information about using location services, read the
* <a href="{@docRoot}guide/topics/location/index.html">Location and Maps</a>
* developer guide.</p>
* </div>
*/ */
public class LocationManager { public class LocationManager {
private static final String TAG = "LocationManager"; private static final String TAG = "LocationManager";

View File

@@ -1,10 +1,10 @@
<html> <html>
<body> <body>
<p>Contains classes that define Android location-based and related services.</p> <p>Contains classes that define Android location-based and related services.</p>
<p>For more information about location services, see the documentation for <a
href="{@docRoot}guide/topics/location/obtaining-user-location.html">Obtaining User Location</a>.</p> <p>For more information, see the
<a href="{@docRoot}guide/topics/location/index.html">Location and Maps</a> developer guide.</p>
{@more} {@more}
</body> </body>

View File

@@ -37,6 +37,12 @@ import java.lang.reflect.Method;
* New tests should be written using this base class. * New tests should be written using this base class.
* *
* <p>If you prefer an isolated unit test, see {@link android.test.ActivityUnitTestCase}. * <p>If you prefer an isolated unit test, see {@link android.test.ActivityUnitTestCase}.
*
* <div class="special reference">
* <h3>Developer Guides</h3>
* <p>For more information about application testing, read the
* <a href="{@docRoot}guide/topics/testing/index.html">Testing</a> developer guide.</p>
* </div>
*/ */
public abstract class ActivityInstrumentationTestCase2<T extends Activity> public abstract class ActivityInstrumentationTestCase2<T extends Activity>
extends ActivityTestCase { extends ActivityTestCase {

View File

@@ -54,7 +54,15 @@ import junit.textui.ResultPrinter;
/** /**
* An {@link Instrumentation} that runs various types of {@link junit.framework.TestCase}s against * An {@link Instrumentation} that runs various types of {@link junit.framework.TestCase}s against
* an Android package (application). Typical usage: * an Android package (application).
*
* <div class="special reference">
* <h3>Developer Guides</h3>
* <p>For more information about application testing, read the
* <a href="{@docRoot}guide/topics/testing/index.html">Testing</a> developer guide.</p>
* </div>
*
* <h3>Typical Usage</h3>
* <ol> * <ol>
* <li>Write {@link junit.framework.TestCase}s that perform unit, functional, or performance tests * <li>Write {@link junit.framework.TestCase}s that perform unit, functional, or performance tests
* against the classes in your package. Typically these are subclassed from: * against the classes in your package. Typically these are subclassed from:

View File

@@ -34,6 +34,12 @@ import java.util.Random;
* Service, and hooks with which you can inject various dependencies and control * Service, and hooks with which you can inject various dependencies and control
* the environment in which your Service is tested. * the environment in which your Service is tested.
* *
* <div class="special reference">
* <h3>Developer Guides</h3>
* <p>For more information about application testing, read the
* <a href="{@docRoot}guide/topics/testing/index.html">Testing</a> developer guide.</p>
* </div>
*
* <p><b>Lifecycle Support.</b> * <p><b>Lifecycle Support.</b>
* A Service is accessed with a specific sequence of * A Service is accessed with a specific sequence of
* calls, as described in the * calls, as described in the

View File

@@ -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 * Users can also set an authority's entry in the map to null, so that a provider is completely
* mocked out. * mocked out.
* </p> * </p>
*
* <div class="special reference">
* <h3>Developer Guides</h3>
* <p>For more information about application testing, read the
* <a href="{@docRoot}guide/topics/testing/index.html">Testing</a> developer guide.</p>
* </div>
*/ */
public class MockContentResolver extends ContentResolver { public class MockContentResolver extends ContentResolver {

View File

@@ -1,5 +1,10 @@
<HTML> <HTML>
<BODY> <BODY>
Utility classes providing stubs or mocks of various Android framework building blocks. <p>Utility classes providing stubs or mocks of various Android framework building blocks.</p>
<p>For more information, see the
<a href="{@docRoot}guide/topics/testing/index.html">Testing</a> developer guide.</p>
{@more}
</BODY> </BODY>
</HTML> </HTML>

View File

@@ -44,13 +44,20 @@ import java.util.Map;
* *
* <p class="note"><strong>Note:</strong> Using this class require the * <p class="note"><strong>Note:</strong> Using this class require the
* {@link android.Manifest.permission#INTERNET} and * {@link android.Manifest.permission#INTERNET} and
* {@link android.Manifest.permission#USE_SIP} permissions.<br/><br/>In addition, {@link * {@link android.Manifest.permission#USE_SIP} permissions. In addition, {@link
* #startAudio} requires the * #startAudio} requires the
* {@link android.Manifest.permission#RECORD_AUDIO}, * {@link android.Manifest.permission#RECORD_AUDIO},
* {@link android.Manifest.permission#ACCESS_WIFI_STATE}, and * {@link android.Manifest.permission#ACCESS_WIFI_STATE}, and
* {@link android.Manifest.permission#WAKE_LOCK} permissions; and {@link #setSpeakerMode * {@link android.Manifest.permission#WAKE_LOCK} permissions; and {@link #setSpeakerMode
* setSpeakerMode()} requires the * setSpeakerMode()} requires the
* {@link android.Manifest.permission#MODIFY_AUDIO_SETTINGS} permission.</p> * {@link android.Manifest.permission#MODIFY_AUDIO_SETTINGS} permission.</p>
*
* <div class="special reference">
* <h3>Developer Guides</h3>
* <p>For more information about using SIP, read the
* <a href="{@docRoot}guide/topics/network/sip.html">Session Initiation Protocol</a>
* developer guide.</p>
* </div>
*/ */
public class SipAudioCall { public class SipAudioCall {
private static final String TAG = SipAudioCall.class.getSimpleName(); private static final String TAG = SipAudioCall.class.getSimpleName();

View File

@@ -49,9 +49,16 @@ import java.text.ParseException;
* SIP. You should always call {@link android.net.sip.SipManager#isVoipSupported * SIP. You should always call {@link android.net.sip.SipManager#isVoipSupported
* isVoipSupported()} to verify that the device supports VOIP calling and {@link * isVoipSupported()} to verify that the device supports VOIP calling and {@link
* android.net.sip.SipManager#isApiSupported isApiSupported()} to verify that the device supports * android.net.sip.SipManager#isApiSupported isApiSupported()} to verify that the device supports
* the SIP APIs.<br/><br/>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} * android.Manifest.permission#INTERNET} and {@link android.Manifest.permission#USE_SIP}
* permissions.</p> * permissions.</p>
*
* <div class="special reference">
* <h3>Developer Guides</h3>
* <p>For more information about using SIP, read the
* <a href="{@docRoot}guide/topics/network/sip.html">Session Initiation Protocol</a>
* developer guide.</p>
* </div>
*/ */
public class SipManager { public class SipManager {
/** /**

View File

@@ -37,6 +37,13 @@ import javax.sip.address.URI;
* <p>You can create a {@link SipProfile} using {@link * <p>You can create a {@link SipProfile} using {@link
* SipProfile.Builder}. You can also retrieve one from a {@link SipSession}, using {@link * SipProfile.Builder}. You can also retrieve one from a {@link SipSession}, using {@link
* SipSession#getLocalProfile} and {@link SipSession#getPeerProfile}.</p> * SipSession#getLocalProfile} and {@link SipSession#getPeerProfile}.</p>
*
* <div class="special reference">
* <h3>Developer Guides</h3>
* <p>For more information about using SIP, read the
* <a href="{@docRoot}guide/topics/network/sip.html">Session Initiation Protocol</a>
* developer guide.</p>
* </div>
*/ */
public class SipProfile implements Parcelable, Serializable, Cloneable { public class SipProfile implements Parcelable, Serializable, Cloneable {
private static final long serialVersionUID = 1L; private static final long serialVersionUID = 1L;

View File

@@ -3,6 +3,11 @@
<p>Provides access to Session Initiation Protocol (SIP) functionality, such as <p>Provides access to Session Initiation Protocol (SIP) functionality, such as
making and answering VOIP calls using SIP.</p> making and answering VOIP calls using SIP.</p>
<p>For more information, see the
<a href="{@docRoot}guide/topics/network/sip.html">Session Initiation Protocol</a>
developer guide.</p>
{@more}
<p>To get started, you need to get an instance of the {@link android.net.sip.SipManager} by <p>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()}.</p> calling {@link android.net.sip.SipManager#newInstance newInstance()}.</p>
@@ -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()} activity, you should call {@link android.net.sip.SipManager#isVoipSupported isVoipSupported()}
to verify that the device supports VOIP calling and {@link to verify that the device supports VOIP calling and {@link
android.net.sip.SipManager#isApiSupported isApiSupported()} to verify that the device supports the android.net.sip.SipManager#isApiSupported isApiSupported()} to verify that the device supports the
SIP APIs.<br/><br/> SIP APIs.
Your application must also request the {@link android.Manifest.permission#INTERNET} and {@link 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. android.Manifest.permission#USE_SIP} permissions in order to use the SIP APIs.
</p> </p>
</BODY> </BODY>
</HTML> </HTML>