diff options
| author | Joe Fernandez <joefernandez@google.com> | 2011-10-04 14:03:12 -0700 |
|---|---|---|
| committer | Android (Google) Code Review <android-gerrit@google.com> | 2011-10-04 14:03:12 -0700 |
| commit | cac15eb21cab68e5b76fe06f9aff273978c92054 (patch) | |
| tree | e6ac85035f35a197a5d5c6b800f2ee2b99f75d7e /core/java | |
| parent | 30433b83cc1473721800a22effc84ce0cb1118f2 (diff) | |
| parent | b54e7a3d9f60ac605f404f9eb3c5e92ca51bbd23 (diff) | |
| download | frameworks_base-cac15eb21cab68e5b76fe06f9aff273978c92054.zip frameworks_base-cac15eb21cab68e5b76fe06f9aff273978c92054.tar.gz frameworks_base-cac15eb21cab68e5b76fe06f9aff273978c92054.tar.bz2 | |
Merge "docs: add developer guide cross-references, Project ACRE"
Diffstat (limited to 'core/java')
| -rw-r--r-- | core/java/android/app/ActionBar.java | 9 | ||||
| -rw-r--r-- | core/java/android/app/Activity.java | 29 | ||||
| -rw-r--r-- | core/java/android/app/Fragment.java | 9 | ||||
| -rw-r--r-- | core/java/android/app/FragmentManager.java | 6 | ||||
| -rw-r--r-- | core/java/android/app/FragmentTransaction.java | 6 | ||||
| -rw-r--r-- | core/java/android/app/IntentService.java | 6 | ||||
| -rw-r--r-- | core/java/android/app/LoaderManager.java | 6 | ||||
| -rw-r--r-- | core/java/android/app/Service.java | 12 | ||||
| -rw-r--r-- | core/java/android/content/BroadcastReceiver.java | 9 | ||||
| -rw-r--r-- | core/java/android/content/Intent.java | 22 | ||||
| -rw-r--r-- | core/java/android/content/IntentFilter.java | 8 | ||||
| -rw-r--r-- | core/java/android/content/Loader.java | 8 | ||||
| -rw-r--r-- | core/java/android/os/AsyncTask.java | 7 | ||||
| -rw-r--r-- | core/java/android/view/View.java | 18 |
14 files changed, 107 insertions, 48 deletions
diff --git a/core/java/android/app/ActionBar.java b/core/java/android/app/ActionBar.java index 51c6f3a..24d3a6b 100644 --- a/core/java/android/app/ActionBar.java +++ b/core/java/android/app/ActionBar.java @@ -43,15 +43,18 @@ import android.widget.SpinnerAdapter; * modify various characteristics of the action bar or remove it completely.</p> * <p>From your activity, you can retrieve an instance of {@link ActionBar} by calling {@link * android.app.Activity#getActionBar getActionBar()}.</p> - * <p>For information about how to use the action bar, including how to add action items, navigation - * modes and more, read the <a href="{@docRoot}guide/topics/ui/actionbar.html">Action - * Bar</a> developer guide.</p> * <p>In some cases, the action bar may be overlayed by another bar that enables contextual actions, * using an {@link android.view.ActionMode}. For example, when the user selects one or more items in * your activity, you can enable an action mode that offers actions specific to the selected * items, with a UI that temporarily replaces the action bar. Although the UI may occupy the * same space, the {@link android.view.ActionMode} APIs are distinct and independent from those for * {@link ActionBar}. + * <div class="special reference"> + * <h3>Developer Guides</h3> + * <p>For information about how to use the action bar, including how to add action items, navigation + * modes and more, read the <a href="{@docRoot}guide/topics/ui/actionbar.html">Action + * Bar</a> developer guide.</p> + * </div> */ public abstract class ActionBar { /** diff --git a/core/java/android/app/Activity.java b/core/java/android/app/Activity.java index 4a144a2..8e8d37d 100644 --- a/core/java/android/app/Activity.java +++ b/core/java/android/app/Activity.java @@ -111,18 +111,6 @@ import java.util.HashMap; * {@link android.R.styleable#AndroidManifestActivity <activity>} * declaration in their package's <code>AndroidManifest.xml</code>.</p> * - * <p>The Activity class is an important part of an application's overall lifecycle, - * and the way activities are launched and put together is a fundamental - * part of the platform's application model. For a detailed perspective on the structure of an - * Android application and how activities behave, please read the - * <a href="{@docRoot}guide/topics/fundamentals.html">Application Fundamentals</a> and - * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back Stack</a> - * documents.</p> - * - * <p>You can also find a detailed discussion about how to create activities in the - * <a href="{@docRoot}guide/topics/fundamentals/activities.html">Activities</a> - * document.</p> - * * <p>Topics covered here: * <ol> * <li><a href="#Fragments">Fragments</a> @@ -133,7 +121,22 @@ import java.util.HashMap; * <li><a href="#Permissions">Permissions</a> * <li><a href="#ProcessLifecycle">Process Lifecycle</a> * </ol> - * + * + * <div class="special reference"> + * <h3>Developer Guides</h3> + * <p>The Activity class is an important part of an application's overall lifecycle, + * and the way activities are launched and put together is a fundamental + * part of the platform's application model. For a detailed perspective on the structure of an + * Android application and how activities behave, please read the + * <a href="{@docRoot}guide/topics/fundamentals.html">Application Fundamentals</a> and + * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back Stack</a> + * developer guides.</p> + * + * <p>You can also find a detailed discussion about how to create activities in the + * <a href="{@docRoot}guide/topics/fundamentals/activities.html">Activities</a> + * developer guide.</p> + * </div> + * * <a name="Fragments"></a> * <h3>Fragments</h3> * diff --git a/core/java/android/app/Fragment.java b/core/java/android/app/Fragment.java index 3a08e6d..d423d98 100644 --- a/core/java/android/app/Fragment.java +++ b/core/java/android/app/Fragment.java @@ -162,9 +162,6 @@ final class FragmentState implements Parcelable { * constructor to instantiate it. If the empty constructor is not available, * a runtime exception will occur in some cases during state restore. * - * <p>For more documentation, also see the <a - * href="{@docRoot}guide/topics/fundamentals/fragments.html">Fragments</a> developer guide.</p> - * * <p>Topics covered here: * <ol> * <li><a href="#OlderPlatforms">Older Platforms</a> @@ -173,6 +170,12 @@ final class FragmentState implements Parcelable { * <li><a href="#BackStack">Back Stack</a> * </ol> * + * <div class="special reference"> + * <h3>Developer Guides</h3> + * <p>For more information about using fragments, read the + * <a href="{@docRoot}guide/topics/fundamentals/fragments.html">Fragments</a> developer guide.</p> + * </div> + * * <a name="OlderPlatforms"></a> * <h3>Older Platforms</h3> * diff --git a/core/java/android/app/FragmentManager.java b/core/java/android/app/FragmentManager.java index 7a6759f..3da4f29 100644 --- a/core/java/android/app/FragmentManager.java +++ b/core/java/android/app/FragmentManager.java @@ -45,6 +45,12 @@ import java.util.Arrays; /** * Interface for interacting with {@link Fragment} objects inside of an * {@link Activity} + * + * <div class="special reference"> + * <h3>Developer Guides</h3> + * <p>For more information about using fragments, read the + * <a href="{@docRoot}guide/topics/fundamentals/fragments.html">Fragments</a> developer guide.</p> + * </div> */ public abstract class FragmentManager { /** diff --git a/core/java/android/app/FragmentTransaction.java b/core/java/android/app/FragmentTransaction.java index c1f3cd6..6e99899 100644 --- a/core/java/android/app/FragmentTransaction.java +++ b/core/java/android/app/FragmentTransaction.java @@ -2,6 +2,12 @@ package android.app; /** * API for performing a set of Fragment operations. + * + * <div class="special reference"> + * <h3>Developer Guides</h3> + * <p>For more information about using fragments, read the + * <a href="{@docRoot}guide/topics/fundamentals/fragments.html">Fragments</a> developer guide.</p> + * </div> */ public abstract class FragmentTransaction { /** diff --git a/core/java/android/app/IntentService.java b/core/java/android/app/IntentService.java index 57a2695..96767ae 100644 --- a/core/java/android/app/IntentService.java +++ b/core/java/android/app/IntentService.java @@ -41,6 +41,12 @@ import android.os.Message; * long as necessary (and will not block the application's main loop), but * only one request will be processed at a time. * + * <div class="special reference"> + * <h3>Developer Guides</h3> + * <p>For a detailed discussion about how to create services, read the + * <a href="{@docRoot}guide/topics/fundamentals/services.html">Services</a> developer guide.</p> + * </div> + * * @see android.os.AsyncTask */ public abstract class IntentService extends Service { diff --git a/core/java/android/app/LoaderManager.java b/core/java/android/app/LoaderManager.java index 46a008d..89e9ddd 100644 --- a/core/java/android/app/LoaderManager.java +++ b/core/java/android/app/LoaderManager.java @@ -47,6 +47,12 @@ import java.lang.reflect.Modifier; * * {@sample development/samples/ApiDemos/src/com/example/android/apis/app/LoaderCursor.java * fragment_cursor} + * + * <div class="special reference"> + * <h3>Developer Guides</h3> + * <p>For more information about using loaders, read the + * <a href="{@docRoot}guide/topics/fundamentals/loaders.html">Loaders</a> developer guide.</p> + * </div> */ public abstract class LoaderManager { /** diff --git a/core/java/android/app/Service.java b/core/java/android/app/Service.java index ebde6e0..35bd8c0 100644 --- a/core/java/android/app/Service.java +++ b/core/java/android/app/Service.java @@ -50,10 +50,6 @@ import java.io.PrintWriter; * Threads</a>. The {@link IntentService} class is available * as a standard implementation of Service that has its own thread where it * schedules its work to be done.</p> - * - * <p>You can find a detailed discussion about how to create services in the - * <a href="{@docRoot}guide/topics/fundamentals/services.html">Services</a> - * document.</p> * * <p>Topics covered here: * <ol> @@ -64,7 +60,13 @@ import java.io.PrintWriter; * <li><a href="#LocalServiceSample">Local Service Sample</a> * <li><a href="#RemoteMessengerServiceSample">Remote Messenger Service Sample</a> * </ol> - * + * + * <div class="special reference"> + * <h3>Developer Guides</h3> + * <p>For a detailed discussion about how to create services, read the + * <a href="{@docRoot}guide/topics/fundamentals/services.html">Services</a> developer guide.</p> + * </div> + * * <a name="WhatIsAService"></a> * <h3>What is a Service?</h3> * diff --git a/core/java/android/content/BroadcastReceiver.java b/core/java/android/content/BroadcastReceiver.java index 3cbaf92..d71a8d6 100644 --- a/core/java/android/content/BroadcastReceiver.java +++ b/core/java/android/content/BroadcastReceiver.java @@ -90,7 +90,14 @@ import android.util.Slog; * <li><a href="#Permissions">Permissions</a> * <li><a href="#ProcessLifecycle">Process Lifecycle</a> * </ol> - * + * + * <div class="special reference"> + * <h3>Developer Guides</h3> + * <p>For information about how to use this class to receive and resolve intents, read the + * <a href="{@docRoot}guide/topics/intents/intents-filters.html">Intents and Intent Filters</a> + * developer guide.</p> + * </div> + * * <a name="ReceiverLifecycle"></a> * <h3>Receiver Lifecycle</h3> * diff --git a/core/java/android/content/Intent.java b/core/java/android/content/Intent.java index 08fe0aa..2be5153 100644 --- a/core/java/android/content/Intent.java +++ b/core/java/android/content/Intent.java @@ -55,13 +55,21 @@ import java.util.Set; * {@link android.content.Context#bindService} to communicate with a * background {@link android.app.Service}. * - * <p>An Intent provides a facility for performing late runtime binding between - * the code in different applications. Its most significant use is in the - * launching of activities, where it can be thought of as the glue between - * activities. It is - * basically a passive data structure holding an abstract description of an - * action to be performed. The primary pieces of information in an intent - * are:</p> + * <p>An Intent provides a facility for performing late runtime binding between the code in + * different applications. Its most significant use is in the launching of activities, where it + * can be thought of as the glue between activities. It is basically a passive data structure + * holding an abstract description of an action to be performed.</p> + * + * <div class="special reference"> + * <h3>Developer Guides</h3> + * <p>For information about how to create and resolve intents, read the + * <a href="{@docRoot}guide/topics/intents/intents-filters.html">Intents and Intent Filters</a> + * developer guide.</p> + * </div> + * + * <a name="IntentStructure"></a> + * <h3>Intent Structure</h3> + * <p>The primary pieces of information in an intent are:</p> * * <ul> * <li> <p><b>action</b> -- The general action to be performed, such as diff --git a/core/java/android/content/IntentFilter.java b/core/java/android/content/IntentFilter.java index f9b3fd5..3b0d846 100644 --- a/core/java/android/content/IntentFilter.java +++ b/core/java/android/content/IntentFilter.java @@ -71,6 +71,14 @@ import java.util.Set; * To specify a path, you also must specify both one or more authorities and * one or more schemes it is associated with. * + * <div class="special reference"> + * <h3>Developer Guides</h3> + * <p>For information about how to create and resolve intents, read the + * <a href="{@docRoot}guide/topics/intents/intents-filters.html">Intents and Intent Filters</a> + * developer guide.</p> + * </div> + * + * <h3>Filter Rules</h3> * <p>A match is based on the following rules. Note that * for an IntentFilter to match an Intent, three conditions must hold: * the <strong>action</strong> and <strong>category</strong> must match, and diff --git a/core/java/android/content/Loader.java b/core/java/android/content/Loader.java index 368c33e..b962800 100644 --- a/core/java/android/content/Loader.java +++ b/core/java/android/content/Loader.java @@ -40,8 +40,12 @@ import java.io.PrintWriter; * * <p>Most implementations should not derive directly from this class, but * instead inherit from {@link AsyncTaskLoader}.</p> - * <p>For more information, see the <a - * href="{@docRoot}guide/topics/fundamentals/loaders.html">Loaders</a> developer guide.</p> + * + * <div class="special reference"> + * <h3>Developer Guides</h3> + * <p>For more information about using loaders, read the + * <a href="{@docRoot}guide/topics/fundamentals/loaders.html">Loaders</a> developer guide.</p> + * </div> * * @param <D> The result returned when the load is complete */ diff --git a/core/java/android/os/AsyncTask.java b/core/java/android/os/AsyncTask.java index 64bba54..9dea4c4 100644 --- a/core/java/android/os/AsyncTask.java +++ b/core/java/android/os/AsyncTask.java @@ -42,6 +42,13 @@ import java.util.concurrent.atomic.AtomicInteger; * and 4 steps, called <code>onPreExecute</code>, <code>doInBackground</code>, * <code>onProgressUpdate</code> and <code>onPostExecute</code>.</p> * + * <div class="special reference"> + * <h3>Developer Guides</h3> + * <p>For more information about using tasks and threads, read the + * <a href="{@docRoot}guide/topics/fundamentals/processes-and-threads.html">Processes and + * Threads</a> developer guide.</p> + * </div> + * * <h2>Usage</h2> * <p>AsyncTask must be subclassed to be used. The subclass will override at least * one method ({@link #doInBackground}), and most often will override a diff --git a/core/java/android/view/View.java b/core/java/android/view/View.java index 9628afb..8e5aefd 100644 --- a/core/java/android/view/View.java +++ b/core/java/android/view/View.java @@ -94,20 +94,10 @@ import java.util.concurrent.CopyOnWriteArrayList; * their layout properties. * </p> * - * <div class="special"> - * <p>For an introduction to using this class to develop your - * application's user interface, read the Developer Guide documentation on - * <strong><a href="{@docRoot}guide/topics/ui/index.html">User Interface</a></strong>. Special topics - * include: - * <br/><a href="{@docRoot}guide/topics/ui/declaring-layout.html">Declaring Layout</a> - * <br/><a href="{@docRoot}guide/topics/ui/menus.html">Creating Menus</a> - * <br/><a href="{@docRoot}guide/topics/ui/layout-objects.html">Common Layout Objects</a> - * <br/><a href="{@docRoot}guide/topics/ui/binding.html">Binding to Data with AdapterView</a> - * <br/><a href="{@docRoot}guide/topics/ui/ui-events.html">Handling UI Events</a> - * <br/><a href="{@docRoot}guide/topics/ui/themes.html">Applying Styles and Themes</a> - * <br/><a href="{@docRoot}guide/topics/ui/custom-components.html">Building Custom Components</a> - * <br/><a href="{@docRoot}guide/topics/ui/how-android-draws.html">How Android Draws Views</a>. - * </p> + * <div class="special reference"> + * <h3>Developer Guides</h3> + * <p>For information about using this class to develop your application's user interface, + * read the <a href="{@docRoot}guide/topics/ui/index.html">User Interface</a> developer guide. * </div> * * <a name="Using"></a> |
