diff options
author | Joe Fernandez <joefernandez@google.com> | 2011-10-13 16:47:36 -0700 |
---|---|---|
committer | Joe Fernandez <joefernandez@google.com> | 2011-10-14 10:18:33 -0700 |
commit | 558459fe85f56f29a6ed6a4d0adb4a0bd6665884 (patch) | |
tree | 880ab53d3c5df42bc2ddad9882014009e5d9d0d6 /core/java | |
parent | f838b7c2b8c4f0f1c48f315f49fea340b2b10d83 (diff) | |
download | frameworks_base-558459fe85f56f29a6ed6a4d0adb4a0bd6665884.zip frameworks_base-558459fe85f56f29a6ed6a4d0adb4a0bd6665884.tar.gz frameworks_base-558459fe85f56f29a6ed6a4d0adb4a0bd6665884.tar.bz2 |
docs: add developer guide cross-references, Project ACRE, Round 2
Change-Id: I39a534ae3a2a34b4dabc333a09961012ef911d3e
Diffstat (limited to 'core/java')
-rw-r--r-- | core/java/android/app/AlertDialog.java | 6 | ||||
-rw-r--r-- | core/java/android/app/Dialog.java | 11 | ||||
-rw-r--r-- | core/java/android/app/Notification.java | 9 | ||||
-rw-r--r-- | core/java/android/app/NotificationManager.java | 7 | ||||
-rw-r--r-- | core/java/android/content/ContentProvider.java | 9 | ||||
-rw-r--r-- | core/java/android/content/ContentResolver.java | 6 | ||||
-rw-r--r-- | core/java/android/view/ContextMenu.java | 6 | ||||
-rw-r--r-- | core/java/android/view/DragEvent.java | 6 | ||||
-rw-r--r-- | core/java/android/view/Menu.java | 6 | ||||
-rw-r--r-- | core/java/android/view/MenuItem.java | 6 | ||||
-rw-r--r-- | core/java/android/view/SubMenu.java | 6 | ||||
-rw-r--r-- | core/java/android/view/View.java | 18 | ||||
-rw-r--r-- | core/java/android/view/ViewGroup.java | 14 | ||||
-rw-r--r-- | core/java/android/widget/Toast.java | 7 |
14 files changed, 104 insertions, 13 deletions
diff --git a/core/java/android/app/AlertDialog.java b/core/java/android/app/AlertDialog.java index c09e87f..e37b3fa 100644 --- a/core/java/android/app/AlertDialog.java +++ b/core/java/android/app/AlertDialog.java @@ -54,6 +54,12 @@ import android.widget.ListView; * without text editors, so that it will be placed on top of the current * input method UI. You can modify this behavior by forcing the flag to your * desired mode after calling {@link #onCreate}. + * + * <div class="special reference"> + * <h3>Developer Guides</h3> + * <p>For more information about creating dialogs, read the + * <a href="{@docRoot}guide/topics/ui/dialogs.html">Dialogs</a> developer guide.</p> + * </div> */ public class AlertDialog extends Dialog implements DialogInterface { private AlertController mAlert; diff --git a/core/java/android/app/Dialog.java b/core/java/android/app/Dialog.java index 82186dd..7a69419 100644 --- a/core/java/android/app/Dialog.java +++ b/core/java/android/app/Dialog.java @@ -66,9 +66,14 @@ import java.lang.ref.WeakReference; * your Dialog takes input focus, as it the default) with the following code: * * <pre> - * getWindow().setFlags(WindowManager.LayoutParams.FLAG_ALT_FOCUSABLE_IM, - * WindowManager.LayoutParams.FLAG_ALT_FOCUSABLE_IM); - * </pre> + * getWindow().setFlags(WindowManager.LayoutParams.FLAG_ALT_FOCUSABLE_IM, + * WindowManager.LayoutParams.FLAG_ALT_FOCUSABLE_IM);</pre> + * + * <div class="special reference"> + * <h3>Developer Guides</h3> + * <p>For more information about creating dialogs, read the + * <a href="{@docRoot}guide/topics/ui/dialogs.html">Dialogs</a> developer guide.</p> + * </div> */ public class Dialog implements DialogInterface, Window.Callback, KeyEvent.Callback, OnCreateContextMenuListener { diff --git a/core/java/android/app/Notification.java b/core/java/android/app/Notification.java index 9490b96..f5add25 100644 --- a/core/java/android/app/Notification.java +++ b/core/java/android/app/Notification.java @@ -38,9 +38,12 @@ import java.text.NumberFormat; * <p>The {@link Notification.Builder Notification.Builder} has been added to make it * easier to construct Notifications.</p> * - * <p>For a guide to creating notifications, see the - * <a href="{@docRoot}guide/topics/ui/notifiers/notifications.html">Creating Status - * Bar Notifications</a> document in the Dev Guide.</p> + * <div class="special reference"> + * <h3>Developer Guides</h3> + * <p>For a guide to creating notifications, read the + * <a href="{@docRoot}guide/topics/ui/notifiers/notifications.html">Status Bar Notifications</a> + * developer guide.</p> + * </div> */ public class Notification implements Parcelable { diff --git a/core/java/android/app/NotificationManager.java b/core/java/android/app/NotificationManager.java index 4913e78..bf83f5e 100644 --- a/core/java/android/app/NotificationManager.java +++ b/core/java/android/app/NotificationManager.java @@ -55,6 +55,13 @@ import android.util.Log; * You do not instantiate this class directly; instead, retrieve it through * {@link android.content.Context#getSystemService}. * + * <div class="special reference"> + * <h3>Developer Guides</h3> + * <p>For a guide to creating notifications, read the + * <a href="{@docRoot}guide/topics/ui/notifiers/notifications.html">Status Bar Notifications</a> + * developer guide.</p> + * </div> + * * @see android.app.Notification * @see android.content.Context#getSystemService */ diff --git a/core/java/android/content/ContentProvider.java b/core/java/android/content/ContentProvider.java index e452f1f..092a0c8 100644 --- a/core/java/android/content/ContentProvider.java +++ b/core/java/android/content/ContentProvider.java @@ -45,9 +45,6 @@ import java.util.ArrayList; * multiple applications you can use a database directly via * {@link android.database.sqlite.SQLiteDatabase}. * - * <p>For more information, read <a href="{@docRoot}guide/topics/providers/content-providers.html">Content - * Providers</a>.</p> - * * <p>When a request is made via * a {@link ContentResolver} the system inspects the authority of the given URI and passes the * request to the content provider registered with the authority. The content provider can interpret @@ -73,6 +70,12 @@ import java.util.ArrayList; * <p>Requests to {@link ContentResolver} are automatically forwarded to the appropriate * ContentProvider instance, so subclasses don't have to worry about the details of * cross-process calls.</p> + * + * <div class="special reference"> + * <h3>Developer Guides</h3> + * <p>For more information about using content providers, read the + * <a href="{@docRoot}guide/topics/providers/content-providers.html">Content Providers</a> + * developer guide.</p> */ public abstract class ContentProvider implements ComponentCallbacks2 { private static final String TAG = "ContentProvider"; diff --git a/core/java/android/content/ContentResolver.java b/core/java/android/content/ContentResolver.java index 0d25926..e923349 100644 --- a/core/java/android/content/ContentResolver.java +++ b/core/java/android/content/ContentResolver.java @@ -54,6 +54,12 @@ import java.util.Random; /** * This class provides applications access to the content model. + * + * <div class="special reference"> + * <h3>Developer Guides</h3> + * <p>For more information about using a ContentResolver with content providers, read the + * <a href="{@docRoot}guide/topics/providers/content-providers.html">Content Providers</a> + * developer guide.</p> */ public abstract class ContentResolver { /** diff --git a/core/java/android/view/ContextMenu.java b/core/java/android/view/ContextMenu.java index dd1d7db..decabcb 100644 --- a/core/java/android/view/ContextMenu.java +++ b/core/java/android/view/ContextMenu.java @@ -29,6 +29,12 @@ import android.widget.AdapterView; * To show a context menu on long click, most clients will want to call * {@link Activity#registerForContextMenu} and override * {@link Activity#onCreateContextMenu}. + * + * <div class="special reference"> + * <h3>Developer Guides</h3> + * <p>For information about creating menus, read the + * <a href="{@docRoot}guide/topics/ui/menus.html">Menus</a> developer guide.</p> + * </div> */ public interface ContextMenu extends Menu { /** diff --git a/core/java/android/view/DragEvent.java b/core/java/android/view/DragEvent.java index 8f491ef..f559e21 100644 --- a/core/java/android/view/DragEvent.java +++ b/core/java/android/view/DragEvent.java @@ -114,6 +114,12 @@ import android.os.Parcelable; * {@link android.view.DragEvent#writeToParcel(Parcel,int)}, and * {@link android.view.DragEvent#toString()} methods always return valid data. * </p> + * + * <div class="special reference"> + * <h3>Developer Guides</h3> + * <p>For a guide to implementing drag and drop features, read the + * <a href="{@docRoot}guide/topics/ui/drag-drop.html">Drag and Drop</a> developer guide.</p> + * </div> */ public class DragEvent implements Parcelable { private static final boolean TRACK_RECYCLED_LOCATION = false; diff --git a/core/java/android/view/Menu.java b/core/java/android/view/Menu.java index 97825e6..7157bc5 100644 --- a/core/java/android/view/Menu.java +++ b/core/java/android/view/Menu.java @@ -41,6 +41,12 @@ import android.content.Intent; * item check marks are discouraged. * <li><b>Sub menus</b>: Do not support item icons, or nested sub menus. * </ol> + * + * <div class="special reference"> + * <h3>Developer Guides</h3> + * <p>For more information about creating menus, read the + * <a href="{@docRoot}guide/topics/ui/menus.html">Menus</a> developer guide.</p> + * </div> */ public interface Menu { diff --git a/core/java/android/view/MenuItem.java b/core/java/android/view/MenuItem.java index ccd8353..2dfbcb5 100644 --- a/core/java/android/view/MenuItem.java +++ b/core/java/android/view/MenuItem.java @@ -29,6 +29,12 @@ import android.view.View.OnCreateContextMenuListener; * methods. * <p> * For a feature set of specific menu types, see {@link Menu}. + * + * <div class="special reference"> + * <h3>Developer Guides</h3> + * <p>For information about creating menus, read the + * <a href="{@docRoot}guide/topics/ui/menus.html">Menus</a> developer guide.</p> + * </div> */ public interface MenuItem { /* diff --git a/core/java/android/view/SubMenu.java b/core/java/android/view/SubMenu.java index e981486..196a183 100644 --- a/core/java/android/view/SubMenu.java +++ b/core/java/android/view/SubMenu.java @@ -22,6 +22,12 @@ import android.graphics.drawable.Drawable; * Subclass of {@link Menu} for sub menus. * <p> * Sub menus do not support item icons, or nested sub menus. + * + * <div class="special reference"> + * <h3>Developer Guides</h3> + * <p>For information about creating menus, read the + * <a href="{@docRoot}guide/topics/ui/menus.html">Menus</a> developer guide.</p> + * </div> */ public interface SubMenu extends Menu { diff --git a/core/java/android/view/View.java b/core/java/android/view/View.java index 86be28a..074326b 100644 --- a/core/java/android/view/View.java +++ b/core/java/android/view/View.java @@ -418,7 +418,7 @@ import java.util.concurrent.CopyOnWriteArrayList; * <h3>Drawing</h3> * <p> * Drawing is handled by walking the tree and rendering each view that - * intersects the the invalid region. Because the tree is traversed in-order, + * intersects the invalid region. Because the tree is traversed in-order, * this means that parents will draw before (i.e., behind) their children, with * siblings drawn in the order they appear in the tree. * If you set a background drawable for a View, then the View will draw it for you @@ -8344,7 +8344,7 @@ public class View implements Drawable.Callback, Drawable.Callback2, KeyEvent.Cal !((ViewGroup) mParent).isViewTransitioning(this)); } /** - * Mark the the area defined by dirty as needing to be drawn. If the view is + * Mark the area defined by dirty as needing to be drawn. If the view is * visible, {@link #onDraw(android.graphics.Canvas)} will be called at some point * in the future. This must be called from a UI thread. To call from a non-UI * thread, call {@link #postInvalidate()}. @@ -8389,7 +8389,7 @@ public class View implements Drawable.Callback, Drawable.Callback2, KeyEvent.Cal } /** - * Mark the the area defined by the rect (l,t,r,b) as needing to be drawn. + * Mark the area defined by the rect (l,t,r,b) as needing to be drawn. * The coordinates of the dirty rect are relative to the view. * If the view is visible, {@link #onDraw(android.graphics.Canvas)} * will be called at some point in the future. This must be called from @@ -13075,6 +13075,12 @@ public class View implements Drawable.Callback, Drawable.Callback2, KeyEvent.Cal * {@link android.graphics.Canvas} object, then it calls {@link #onDrawShadow(Canvas) onDrawShadow()} * so that your application can draw the shadow image in the Canvas. * </p> + * + * <div class="special reference"> + * <h3>Developer Guides</h3> + * <p>For a guide to implementing drag and drop features, read the + * <a href="{@docRoot}guide/topics/ui/drag-drop.html">Drag and Drop</a> developer guide.</p> + * </div> */ public static class DragShadowBuilder { private final WeakReference<View> mView; @@ -14066,6 +14072,12 @@ public class View implements Drawable.Callback, Drawable.Callback2, KeyEvent.Cal * to this view. The callback will be invoked before the hosting view's own * onDrag(event) method. If the listener wants to fall back to the hosting view's * onDrag(event) behavior, it should return 'false' from this callback. + * + * <div class="special reference"> + * <h3>Developer Guides</h3> + * <p>For a guide to implementing drag and drop features, read the + * <a href="{@docRoot}guide/topics/ui/drag-drop.html">Drag and Drop</a> developer guide.</p> + * </div> */ public interface OnDragListener { /** diff --git a/core/java/android/view/ViewGroup.java b/core/java/android/view/ViewGroup.java index 9266ae2..62b20b3 100644 --- a/core/java/android/view/ViewGroup.java +++ b/core/java/android/view/ViewGroup.java @@ -60,6 +60,12 @@ import java.util.HashSet; * Also see {@link LayoutParams} for layout attributes. * </p> * + * <div class="special reference"> + * <h3>Developer Guides</h3> + * <p>For more information about creating user interface layouts, read the + * <a href="{@docRoot}guide/topics/ui/declaring-layout.html">XML Layouts</a> developer + * guide.</p></div> + * * @attr ref android.R.styleable#ViewGroup_clipChildren * @attr ref android.R.styleable#ViewGroup_clipToPadding * @attr ref android.R.styleable#ViewGroup_layoutAnimation @@ -5158,7 +5164,13 @@ public abstract class ViewGroup extends View implements ViewParent, ViewManager * </ul> * There are subclasses of LayoutParams for different subclasses of * ViewGroup. For example, AbsoluteLayout has its own subclass of - * LayoutParams which adds an X and Y value. + * LayoutParams which adds an X and Y value.</p> + * + * <div class="special reference"> + * <h3>Developer Guides</h3> + * <p>For more information about creating user interface layouts, read the + * <a href="{@docRoot}guide/topics/ui/declaring-layout.html">XML Layouts</a> developer + * guide.</p></div> * * @attr ref android.R.styleable#ViewGroup_Layout_layout_height * @attr ref android.R.styleable#ViewGroup_Layout_layout_width diff --git a/core/java/android/widget/Toast.java b/core/java/android/widget/Toast.java index bb23173..88d7e05 100644 --- a/core/java/android/widget/Toast.java +++ b/core/java/android/widget/Toast.java @@ -48,6 +48,13 @@ import android.view.accessibility.AccessibilityManager; * <p> * The easiest way to use this class is to call one of the static methods that constructs * everything you need and returns a new Toast object. + * + * <div class="special reference"> + * <h3>Developer Guides</h3> + * <p>For information about creating Toast notifications, read the + * <a href="{@docRoot}guide/topics/ui/notifiers/toasts.html">Toast Notifications</a> developer + * guide.</p> + * </div> */ public class Toast { static final String TAG = "Toast"; |