Updated browsable sample descriptions.

Change-Id: I21e3dfacb4bc1acfbe3b17c5f8001ee758f9eec2
(cherry picked from commit 3943cdc962)
This commit is contained in:
quddusc
2013-10-30 18:09:08 -07:00
committed by Dirk Dougherty
parent a76387f7a4
commit 11d2eef36f
30 changed files with 158 additions and 210 deletions

View File

@@ -5,9 +5,9 @@ page.tags="ActivityInstrumentation"
sample.group=Testing sample.group=Testing
@jd:body @jd:body
<p> <p>This sample demonstrates how to use an
{@link android.test.InstrumentationTestCase} to test the internal state of an
This sample provides a basic example of using an InstrumentationTest to probe the {@link android.app.Activity}.</p>
internal state of an Activity. <p>To learn more about using Android's custom testing framework, see
<a href="{@docRoot}/training/activity-testing/index.html">Testing Your
</p> Android Activity</a>.</p>

View File

@@ -5,14 +5,10 @@ page.tags="AdvancedImmersiveMode"
sample.group=UI sample.group=UI
@jd:body @jd:body
<p> <p>Android 4.4 introduces a way for you to provide a more immersive screen
experience in your app, by letting users show or hide the status bar and
\"Immersive Mode\" is a new UI mode which improves \"hide full screen\" and navigation bar with a swipe.</p>
\"hide nav bar\" modes, by letting users swipe the bars in and out. This sample <p>This sample demonstrates how this features interacts with some of the other
lets the user experiment with immersive mode by enabling it and seeing how it interacts UI flags related to full-screen apps. The sample also shows how to implement a
with some of the other UI flags related to full-screen apps. "sticky" mode, which re-hides the bars a few seconds after the user swipes
\n\nThis sample also lets the user choose between normal immersive mode and "sticky" them back in.</p>
immersive mode, which removes the status bar and nav bar
a few seconds after the user has swiped them back in.
</p>

View File

@@ -1,15 +1,15 @@
page.tags="Basic" page.tags="Basic ActionBarCompat"
sample.group=UI sample.group=UI
@jd:body @jd:body
<p> <p>This sample demonstrates how to create a basic action bar that displays
action items. The sample shows how to inflate items from a menu resource, and
This sample shows you how to use ActionBarCompat to create a basic Activity which how to add items programatically. To reduce clutter, rarely used actions are
displays action items. It covers inflating items from a menu resource, as well as adding displayed in an action bar overflow.</p>
an item in code. Items that are not shown as action items on the Action Bar are <p>The activity in this sample extends from
displayed in the action bar overflow. {@link android.support.v7.app.ActionBarActivity}, which provides the
functionality necessary to display a compatible action bar on devices
</p> running Android 2.1 and higher.</p>

View File

@@ -5,8 +5,8 @@ page.tags="BasicAccessibility"
sample.group=UI sample.group=UI
@jd:body @jd:body
<p> <p>This sample demonstrates how to create applications that are accessible for
users with visual or physical disabilities.</p>
This sample demonstrates how to create an accessible application, using a mix of different widgets demonstrating different ways of adding accessibility markup to a UI. <p>To learn how to make the most of the accessibility features built into
the Android framework, see
</p> <a href="{@docRoot}training/accessibility/index.html">Implementing Accessibility</a>.</p>

View File

@@ -5,13 +5,11 @@ page.tags="BasicAndroidKeyStore"
sample.group=Security sample.group=Security
@jd:body @jd:body
<p> <p>This sample demonstrates how to use a {java.security.KeyStore} to
safely create and store encryption keys that only your application can access.
Welcome to the <b>Basic Android Key Store</b> sample!\n\n You can also sign data using those keys.</p>
This sample demonstrates how to use the Android Key Store to safely create and store <p>To see this in action, run the sample application and click:</p>
encryption keys that only your application can access. You can also sign data <ul>
using those keys.\n\n <li><strong>Create</strong> to create a new KeyPair.</li>
To create a new KeyPair, click \"Create\".\n\n <li><strong>Sign</strong> to sign some data using a KeyPair.</li>
To sign some data using a KeyPair, click \"Sign\".\n\n <li><strong>Verify</strong> to verify the data using the signature provided.</li>
To verify the data using the signature provided, click \"Verify\".\n\n
</p>

View File

@@ -5,10 +5,9 @@ page.tags="BasicContactables"
sample.group=Content sample.group=Content
@jd:body @jd:body
<p> <p>This sample demonstrates how to use the
{@link android.provider.ContactsContract.Data} table to search for contacts.</p>
This sample demonstrates how to use the Contactables table to search for contacts. <p>The sample sends consolidated query strings to the
\n\nQuery strings sent to the Contactables table will match both contact names and phone numbers, {@link android.provider.ContactsContract.Data} table to match both contact
reducing the number of queries your application needs to use when searching the contacts database! names and phone numbers. This approach helps to reduce the number of
queries needed when searching the contacts database.</p>
</p>

View File

@@ -5,9 +5,8 @@ page.tags="BasicGestureDetect"
sample.group=Input sample.group=Input
@jd:body @jd:body
<p> <p>This sample demonstrates how to use the {@link android.view.GestureDetector}
API to detect simple dragging and tapping gestures.</p>
Welcome to Basic Gesture Detect! <p>To learn more about detecting basic touch gestures such as scrolling,
In order to try this sample out, try dragging or tapping this text to see what happens! flinging, and double-tapping, see
<a href="{@docRoot}training/gestures/detector.html">Detecting Common Gestures</a>.</p>
</p>

View File

@@ -5,10 +5,8 @@ page.tags="BasicImmersiveMode"
sample.group=UI sample.group=UI
@jd:body @jd:body
<p> <p>Android 4.4 introduces a way for you to provide a more immersive screen
experience in your app, by letting users show or hide the status bar and
\"Immersive Mode\" is a new UI mode which improves \"hide full screen\" and navigation bar with a swipe.</p>
\"hide nav bar\" modes, by letting users swipe the bars in and out. This sample <p>This sample demonstrates how to enable and disable this feature
demonstrates how to enable and disable immersive mode programmatically. programmatically.</p>
</p>

View File

@@ -5,9 +5,5 @@ page.tags="BasicMediaDecoder"
sample.group=Media sample.group=Media
@jd:body @jd:body
<p> <p>This sample demonstrates how to decode a video using
the {@link android.media.MediaCodec} API and render in an activity.</p>
This activity uses a TextureView to render the frames of a video decoded using the
MediaCodec API.
</p>

View File

@@ -5,13 +5,14 @@ page.tags="BasicMediaRouter"
sample.group=Media sample.group=Media
@jd:body @jd:body
<p> <p>This sample demonstrates how to use the {@link android.media.MediaRouter}
API to display content on a secondary display.</p>
This sample demonstrates the use of the MediaRouter API to display <p>To see this in action, run the sample and use the
content on a secondary display.\n\nUse the "Media Route Action Item" in the ActionBar <strong>Media Route Action Item</strong> in the action bar to select an
to select an output device. If your device supports Miracast wireless displays, output device. If your device supports Miracast wireless displays, you may
you may need to enable "Wireless Display" functionality in the system settings. need to enable <strong>Wireless Display</strong> functionality in the
Secondary screen simulation can also be enabled from the "Developer Options".\n\n system settings.</p>
Once connected, use the "Change Color" button to change the background color of the secondary screen. <p>You can also enable secondary screen simulation from the
<em>Developer options</em> in the system Settings. Once
</p> connected, use the <strong>Change Color</strong> button to change the
background color of the secondary screen.</p>

View File

@@ -5,11 +5,8 @@ page.tags="BasicMultitouch"
sample.group=Input sample.group=Input
@jd:body @jd:body
<p> <p>This samples demonstrates how to use the {@link android.view.MotionEvent}
API to keep track of individual touches across multiple touch events.</p>
This samples demonstrates the use of MotionEvent properties to keep track of individual touches <p>To see this in action, run the sample and touch the screen with multiple
across multiple touch events. fingers to show that the pointer id (also represented by a colour) does not
\n\nTouch the screen with multiple fingers to show that the pointer id change as new touch events are received.</p>
(also represented by a colour) does not change as new touch events are received.</string>
</p>

View File

@@ -5,11 +5,6 @@ page.tags="BasicNetworking"
sample.group=Connectivity sample.group=Connectivity
@jd:body @jd:body
<p> <p>This sample demonstrates how to use the
{@link android.net.ConnectivityManager} to determine if the device has an
This sample demonstrates how to use the ConnectivityManager to determine if you have active network connection, and if so, retrieve the connection type.</p>
a network connection, and if so, what type of connection it is.
\n\nA "NetworkInfo" object is retrieved from the ConnectivityManager, which contains information
on the active connection, and then the connection type is printed to an on-screen console.
</p>

View File

@@ -5,10 +5,6 @@ page.tags="BasicNotifications"
sample.group=UI sample.group=UI
@jd:body @jd:body
<p> <p>This sample demonstrates how to display events in the system's notification
bar. The {@link android.support.v4.app.NotificationCompat} API is used for
This sample demonstrates how to display events in the system\'s notification bar. The compatibility with devices running Android 2.2 or higher.</p>
NotificationCompat API is used for compatibility with older devices, running Android
2.2 (Froyo) or newer.
</p>

View File

@@ -5,13 +5,10 @@ page.tags="BasicSyncAdapter"
sample.group=Connectivity sample.group=Connectivity
@jd:body @jd:body
<p> <p>This sample demonstrates how to implement a sync adapter to fetch background
data for an app that doesn't require a user-visible account type or two-way
This sample demonstrates using SyncAdapter to fetch background data for an app that synchronization.</p>
doesn\'t require a user-visible account type or 2-way synchronization. <p>The sample periodically downloads the feed from the <a href="http://android-developers.blogspot.com/">Android Developers Blog</a> and caches the data in a content provider. At runtime, the cached feed data is
displayed inside a {@link android.widget.ListView}.</p>
\n\nThis sample periodically downloads the feed from the Android Developer Blog and <p>To learn more about creating and using sync adapters, see
caches the data in a content provider. At runtime, the cached feed data is displayed <a href="{@docRoot}training/sync-adapters/index.html">Transferring Data Using Sync Adapters</a>.</p>
inside a ListView.
</p>

View File

@@ -5,9 +5,8 @@ page.tags="BluetoothLeGatt"
sample.group=Connectivity sample.group=Connectivity
@jd:body @jd:body
<p> <p>This sample demonstrates how to use the Bluetooth Low Energy Generic
Attribute Profile (GATT) to transmit arbitrary data between devices. For more
This sample demonstrates how to use the Bluetooth LE Generic Attribute Profile (GATT) information about using Android's suppport for Bluetooth Low Energy, see
to transmit arbitrary data between devices. <a href="{@docRoot}guide/topics/connectivity/bluetooth-le.html">Bluetooth Low
Energy</a>.</p>
</p>

View File

@@ -5,9 +5,5 @@ page.tags="BorderlessButtons"
sample.group=UI sample.group=UI
@jd:body @jd:body
<p> <p>This sample demonstrates how to apply borderless buttons, bottom button bars
(OK and Cancel), and dividers to establish visual structure.</p>
This sample demonstrates the use of borderless buttons, bottom button bars
(OK and Cancel) and dividers to establish visual structure.
</p>

View File

@@ -5,9 +5,5 @@ page.tags="CustomChoiceList"
sample.group=UI sample.group=UI
@jd:body @jd:body
<p> <p>This sample demonstrates how to implement a custom single-choice or
multi-choice {@link android.widget.ListView} user interface.</p>
This sample demonstrates how to create custom checkable layouts, for use with ListView\'s choiceMode
attribute.
</p>

View File

@@ -5,8 +5,5 @@ page.tags="CustomNotifications"
sample.group=UI sample.group=UI
@jd:body @jd:body
<p> <p>This sample demonstrates how to implement expanded notifications that
display custom views.</p>
This sample demonstrates notifications with custom content views.
</p>

View File

@@ -5,14 +5,8 @@ page.tags="DoneBar"
sample.group=UI sample.group=UI
@jd:body @jd:body
<p> <p>This sample demonstrates a user interface design pattern for simple data
entry from an {@link android.app.ActionBar}. The sample implements a custom
This sample demonstrates two alternative presentations of the <strong>Done/Cancel</strong> bar to provide users with an easy way to directly
action bar that are well-suited for simple data entry scenarios. save or cancel their changes. This design pattern is suitable for scenarios
where no additional view details or actions are needed in the action bar.</p>
In this presentation, a done bar replaces the action
bar entirely, providing two direct actions to persist or dismiss changes. This is
suitable for cases where no additional view details or actions are needed in the
action bar.
</p>

View File

@@ -5,9 +5,6 @@ page.tags="HorizontalPaging"
sample.group=UI sample.group=UI
@jd:body @jd:body
<p> <p>This sample demonstrates how to implement horizontal paging between
fragments in an application that has an {@link android.app.ActionBar}, using a
This sample demonstrates how to implement horizontal paging between fragments in {@link android.support.v4.view.ViewPager} widget.</p>
applications that use ActionBar, using a ViewPager widget.
</p>

View File

@@ -5,10 +5,8 @@ page.tags="ImmersiveMode"
sample.group=UI sample.group=UI
@jd:body @jd:body
<p> <p>Android 4.4 introduces a way for you to provide a more immersive screen
experience in your app, by letting users show or hide the status bar and
One of the features introduced in KitKat is "immersive mode". Immersive mode gives the navigation bar with a swipe.</p>
user the ability to show/hide the status bar and navigation bar with a swipe. To try, <p>This sample demonstrates how to enable toggling of this feature in a
click the "Toggle immersive mode" button, then try swiping the bar in and out! {@link android.support.v4.app.Fragment}.</p>
</p>

View File

@@ -5,9 +5,10 @@ page.tags="ListPopupMenu"
sample.group=UI sample.group=UI
@jd:body @jd:body
<p> <p>This sample demonstrates how to use a backward compatible
{@link android.support.v7.widget.PopupMenu PopupMenu} to create a list, where
This sample shows you how to use {@link android.support.v7.widget.PopupMenu PopupMenu} each list item contains a dropdown menu.</p>
from ActionBarCompat to create a list, with each item having a dropdown menu. <p>The activity in this sample extends from
{@link android.support.v7.app.ActionBarActivity}, which provides the
</p> functionality necessary to display a compatible action bar on devices
running Android 2.1 and higher.</p>

View File

@@ -0,0 +1,7 @@
page.tags="MediaRecorder"
sample.group=Media
@jd:body
<p>This sample demonstrates how to use the {@link android.media.MediaRecorder}
API to record video from a camera or camcorder, and display a preview of the
recording.</p>

View File

@@ -5,9 +5,6 @@ page.tags="NetworkConnect"
sample.group=Connectivity sample.group=Connectivity
@jd:body @jd:body
<p> <p>This sample demonstrates how to connect to the network and fetch raw HTML.
The sample uses {@link android.os.AsyncTask} to perform the fetch on a
This sample demonstrates how to connect to the network and fetch raw HTML using background thread.</p>
HttpURLConnection. AsyncTask is used to perform the fetch on a background thread.
</p>

View File

@@ -5,9 +5,10 @@ page.tags="ShareActionProvider"
sample.group=UI sample.group=UI
@jd:body @jd:body
<p> <p>This sample demonstrates how to use a
context-sensitive {@link android.support.v7.widget.ShareActionProvider} that is
This sample shows you how a provide a context-sensitive ShareActionProvider with backward compatible.</p>
ActionBarCompat, backwards compatible to API v7. <p>The activity in this sample extends from
{@link android.support.v7.app.ActionBarActivity}, which provides the
</p> functionality necessary to display a compatible action bar on devices
running Android 2.1 and higher.</p>

View File

@@ -5,11 +5,8 @@ page.tags="StorageClient"
sample.group=Content sample.group=Content
@jd:body @jd:body
<p> <p>This sample demonstrates how to use the
{@link android.content.Intent#ACTION_OPEN_DOCUMENT} intent to let users
Using the OPEN_DOCUMENT intent, a client app can access a list of Document Providers choose a file via the system's file browser. This intent allows a client
on the device, and choose a file from any of them. application to access a list of document providers on the device, and choose
\n\nTo demonstrate this, click the button below to open up the Storage Access Framework a file from any of them.</p>
interface, and choose an image on your device. It will be displayed in this app.
</p>

View File

@@ -1,13 +1,13 @@
page.tags="Styled" page.tags="Styled ActionBarCompat"
sample.group=UI sample.group=UI
@jd:body @jd:body
<p> <p>This sample demonstrates how to use a backward compatible
{@link android.support.v7.app.ActionBar} with a customized theme.</p>
This sample shows you how to use ActionBarCompat with a customized theme. It utilizes a <p>The activity in this sample extends from
split action bar when running on a device with a narrow display, and show three tabs. {@link android.support.v7.app.ActionBarActivity}, which provides the
functionality necessary to display a compatible action bar on devices
</p> running Android 2.1 and higher.</p>

View File

@@ -5,9 +5,12 @@ page.tags="TextLinkify"
sample.group=Views sample.group=Views
@jd:body @jd:body
<p> <p>This sample demonstrates how to add clickable links to a
{@link android.widget.TextView}, by using these techniques:
This sample illustrates how links can be added to a TextView. This can be done either <ul>
automatically by setting the "autoLink" property or explicitly. <li>Setting the {@link android.widget.TextView#attr_android:autoLink} property
to automatically convert the text to a link.</li>
<li>Parsing a String as HTML</li>
<li>Manually by constructing a {@link android.text.SpannableString}.</li>
</ul>
</p> </p>

View File

@@ -5,10 +5,7 @@ page.tags="TextSwitcher"
sample.group=UI sample.group=UI
@jd:body @jd:body
<p> <p>This sample demonstrates how to use the {@link android.widget.TextSwitcher}
view with animations. A {@link android.widget.TextSwitcher} is a type of
This sample illustrates the use of a TextSwitcher to display text. {@link android.widget.ViewSwitcher} that animates text transitions on screen
\n\nClick the button below to set new text in the TextSwitcher and observe the when {@link android.widget.TextSwitcher#setText(CharSequence)} is called.</p>
in and out fade animations.
</p>

View File

@@ -1,13 +1,9 @@
page.tags="repeatingAlarm" page.tags="RepeatingAlarm"
sample.group=Background sample.group=Background
@jd:body @jd:body
<p> <p>This sample demonstrates how to implement a repeating alarm using an
{@link android.app.AlarmManager}.</p>
Introductory text that explains what the sample is intended to demonstrate. Edit
in template-params.xml.
</p>