diff options
| author | Joe Fernandez <joefernandez@google.com> | 2011-12-22 15:59:34 -0800 |
|---|---|---|
| committer | Android Git Automerger <android-git-automerger@android.com> | 2011-12-22 15:59:34 -0800 |
| commit | 2b072677538de979961b5bf527109fdab1713731 (patch) | |
| tree | abe7c7d86618d0efa1ace6e3b56e20161e458ed2 /core/java/android/hardware | |
| parent | 2bd0d74a5885f72435da228a00495bae72c07f6f (diff) | |
| parent | 201469f54522436be79d4d6665721049bfc74320 (diff) | |
| download | frameworks_base-2b072677538de979961b5bf527109fdab1713731.zip frameworks_base-2b072677538de979961b5bf527109fdab1713731.tar.gz frameworks_base-2b072677538de979961b5bf527109fdab1713731.tar.bz2 | |
am 201469f5: am bb7f590a: Merge "docs: Add developer guide cross-references, Project ACRE, round 4" into ics-mr1
* commit '201469f54522436be79d4d6665721049bfc74320':
docs: Add developer guide cross-references, Project ACRE, round 4
Diffstat (limited to 'core/java/android/hardware')
| -rw-r--r-- | core/java/android/hardware/usb/UsbAccessory.java | 6 | ||||
| -rw-r--r-- | core/java/android/hardware/usb/UsbDevice.java | 6 | ||||
| -rw-r--r-- | core/java/android/hardware/usb/UsbInterface.java | 6 | ||||
| -rw-r--r-- | core/java/android/hardware/usb/UsbManager.java | 9 | ||||
| -rw-r--r-- | core/java/android/hardware/usb/package.html | 15 |
5 files changed, 36 insertions, 6 deletions
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. + * + * <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 { 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. + * + * <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 { 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. + * + * <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 { 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);} + * + * <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 { 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 @@ <HTML> <BODY> -<p>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 +<p>Provides support to communicate with USB hardware peripherals that are connected 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 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.</p> +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.</p> + </BODY> </HTML>
\ No newline at end of file |