From 13033ea52714d48d754c6bc8fccb18514c645a47 Mon Sep 17 00:00:00 2001 From: Scott Main Date: Tue, 15 Feb 2011 13:18:30 -0800 Subject: [PATCH] docs: fix misc broken links Change-Id: Id7d0ee36398aca452ceb2c3d15982397f58a06c6 --- core/java/android/app/package.html | 5 ++- core/java/android/content/pm/package.html | 4 +- core/java/android/widget/TimePicker.java | 4 +- .../developing/testing/testing_eclipse.jd | 4 +- docs/html/guide/publishing/licensing.jd | 17 ++++---- docs/html/guide/topics/advanced/aidl.jd | 6 ++- docs/html/guide/topics/fundamentals.jd | 5 ++- .../guide/topics/fundamentals/activities.jd | 7 ++-- .../guide/topics/fundamentals/fragments.jd | 3 +- .../guide/topics/fundamentals/services.jd | 4 +- docs/html/guide/topics/providers/loaders.jd | 9 ++-- .../guide/topics/testing/testing_android.jd | 4 +- docs/html/guide/topics/ui/actionbar.jd | 14 +++++-- docs/html/guide/topics/ui/drag-drop.jd | 4 +- .../resources/articles/live-wallpapers.jd | 41 ++++++++++--------- docs/html/sdk/android-3.0.jd | 4 +- docs/html/sdk/preview/start.jd | 2 +- 17 files changed, 80 insertions(+), 57 deletions(-) diff --git a/core/java/android/app/package.html b/core/java/android/app/package.html index 5137600a59547..f37f1dcc8401d 100644 --- a/core/java/android/app/package.html +++ b/core/java/android/app/package.html @@ -32,8 +32,9 @@ backwards through the fragment states, without leaving the activity.

action bar.

For information about using some the classes in this package, see the following -documents: Application -Fundamentals (for activities, services, and fragments), Activities, Services, Fragments, Using the Action Bar, Creating Dialogs, and Notifying the User.

diff --git a/core/java/android/content/pm/package.html b/core/java/android/content/pm/package.html index b18adb2f77706..d55f0f7e2fd76 100644 --- a/core/java/android/content/pm/package.html +++ b/core/java/android/content/pm/package.html @@ -5,7 +5,7 @@ application package, including information about its activities, permissions, services, signatures, and providers.

Most of the information about an application package is defined by its manifest file. For more information, see the AndroidManifest.xml -File documentation.

+href="{@docRoot}guide/topics/manifest/manifest-intro.html">AndroidManifest.xml File +documentation.

\ No newline at end of file diff --git a/core/java/android/widget/TimePicker.java b/core/java/android/widget/TimePicker.java index 18d1825eac327..029d69020c78b 100644 --- a/core/java/android/widget/TimePicker.java +++ b/core/java/android/widget/TimePicker.java @@ -43,8 +43,8 @@ import java.util.Calendar; * or 'P' to pick. For a dialog using this view, see * {@link android.app.TimePickerDialog}. *

- * See the Time Picker tutorial. + * See the Time Picker + * tutorial. *

*/ @Widget diff --git a/docs/html/guide/developing/testing/testing_eclipse.jd b/docs/html/guide/developing/testing/testing_eclipse.jd index 2a5b7713a6c8e..b57306ea1c686 100644 --- a/docs/html/guide/developing/testing/testing_eclipse.jd +++ b/docs/html/guide/developing/testing/testing_eclipse.jd @@ -16,8 +16,8 @@ page.title=Testing from Eclipse with ADT basic processes for creating and running applications with ADT, as described in Managing Projects from Eclipse - and Building and Running from -Eclipse. + and Building and Running +from Eclipse. You may also want to read Testing Fundamentals, which provides an overview of the Android testing framework. diff --git a/docs/html/guide/publishing/licensing.jd b/docs/html/guide/publishing/licensing.jd index 55513843019ec..de74f89986809 100644 --- a/docs/html/guide/publishing/licensing.jd +++ b/docs/html/guide/publishing/licensing.jd @@ -518,7 +518,7 @@ Android Virtual Devices.

If you are not familiar with AVDs or how to use them, see Creating and Managing Virtual Devices.

+href="{@docRoot}guide/developing/devices/index.html">Managing Virtual Devices.

Updating your project configuration

@@ -629,7 +629,7 @@ share its code and resources across multiple applications.

If you aren't familiar with library projects or how to use them, see -Creating and Managing Projects. +Managing Projects.

@@ -666,8 +666,9 @@ predefined as a library project in its default.properties file, so no further configuration is needed.

For more information about how to create an application project or work with -library projects in Eclipse, see -Creating and Managing Projects in Eclipse

. +library projects in Eclipse, see Managing Projects from +Eclipse with ADT

.

Copying the LVL sources to your application

@@ -698,8 +699,8 @@ haven't done that already, do it now before continuing.

Select the "Android" properties group and click Add, then choose the LVL library project (com_android_vending_licensing) and click OK. For more information, see - -Creating and Managing Projects in Eclipse

. + +Managing Projects from Eclipse with ADT

.
@@ -727,8 +728,8 @@ properties, including the reference to the library project:

For more information about working with library projects, -see -Creating and Managing Projects on the Command Line

. +see +Managing Projects from the Command Line

.

Integrating the LVL with Your Application

diff --git a/docs/html/guide/topics/advanced/aidl.jd b/docs/html/guide/topics/advanced/aidl.jd index fef46eca464fa..419048a083d06 100644 --- a/docs/html/guide/topics/advanced/aidl.jd +++ b/docs/html/guide/topics/advanced/aidl.jd @@ -14,9 +14,11 @@ do that marshalling is tedious to write, so Android handles it for you with AIDL

Note: Using AIDL is necessary only if you allow clients from different applications to access your service for IPC and want to handle multithreading in your service. If you do not need to perform IPC across -different applications, you should create your interface implementing a +different applications, you should create your interface implementing a Binder or, if you want to perform IPC, but do not need to handle multithreading, then you -should implement your interface using a Messenger.

+should implement your interface using a Messenger.

Before you begin designing your AIDL interface, be aware that calls on to an AIDL interface are direct function calls. You can not generally make assumptions about the thread in which the call diff --git a/docs/html/guide/topics/fundamentals.jd b/docs/html/guide/topics/fundamentals.jd index 3fdbd95154afe..661f5cba384cf 100644 --- a/docs/html/guide/topics/fundamentals.jd +++ b/docs/html/guide/topics/fundamentals.jd @@ -422,7 +422,7 @@ because the Android system makes the appropriate adjustments to your UI layout a resources. However, you should create specialized layouts for certain screen sizes and provide specialized images for certain densities, using alternative layout resources, and by declaring in your manifest exactly which screen sizes your application supports with the {@code +href="{@docRoot}guide/topics/manifest/supports-screens-element.html">{@code <supports-screens>} element.

For more information, see the Supporting Multiple Screens @@ -453,7 +453,8 @@ platform version specifies an API Level (for example, Android 1.0 is API Level 1 and Android 2.3 is API Level 9). If you use any APIs that were added to the platform after version 1.0, you should declare the minimum API Level in which those APIs were introduced using the -{@code <uses-sdk>} element. +{@code <uses-sdk>} +element.

It's important that you declare all such requirements for your application, because, when you diff --git a/docs/html/guide/topics/fundamentals/activities.jd b/docs/html/guide/topics/fundamentals/activities.jd index 9079ef601a121..5cc1b45e38bb1 100644 --- a/docs/html/guide/topics/fundamentals/activities.jd +++ b/docs/html/guide/topics/fundamentals/activities.jd @@ -40,7 +40,7 @@ page.title=Activities

See also

  1. Hello World Tutorial
    2. -
  2. Tasks and Back +
  3. Tasks and Back Stack
@@ -594,13 +594,14 @@ from the time {@link android.app.Activity#onPause onPause()} returns to the time definition in table 1 might still be killed by the system—but that would happen only in extreme circumstances when there is no other recourse. When an activity might be killed is discussed more in the Processes and +href="{@docRoot}guide/topics/fundamentals/processes-and-threads.html">Processes and Threading document.

Saving activity state

-

The introduction to Managing the Activity Lifecycle briefly mentions that +

The introduction to Managing the Activity Lifecycle briefly mentions +that when an activity is paused or stopped, the state of the activity is retained. This is true because the {@link android.app.Activity} object is still held in memory when it is paused or stopped—all information about its members and current state is still alive. Thus, any changes diff --git a/docs/html/guide/topics/fundamentals/fragments.jd b/docs/html/guide/topics/fundamentals/fragments.jd index 7ca990e575150..f78096072fc69 100644 --- a/docs/html/guide/topics/fundamentals/fragments.jd +++ b/docs/html/guide/topics/fundamentals/fragments.jd @@ -743,7 +743,8 @@ from the list. It also demonstrates how to provide different configurations of t based on the screen configuration.

Note: The complete source code for this activity is available in -{@code +{@code FragmentLayout.java}.

The main activity applies a layout in the usual way, during {@link diff --git a/docs/html/guide/topics/fundamentals/services.jd b/docs/html/guide/topics/fundamentals/services.jd index d0c924a663b0c..a9dd315c967eb 100644 --- a/docs/html/guide/topics/fundamentals/services.jd +++ b/docs/html/guide/topics/fundamentals/services.jd @@ -121,7 +121,7 @@ a thread in {@link android.app.Activity#onCreate onCreate()}, start running it i android.app.Activity#onStart onStart()}, then stop it in {@link android.app.Activity#onStop onStop()}. Also consider using {@link android.os.AsyncTask} or {@link android.os.HandlerThread}, instead of the traditional {@link java.lang.Thread} class. See the Processes and +href="{@docRoot}guide/topics/fundamentals/processes-and-threads.html#Threads">Processes and Threading document for more information about threads.

Remember that if you do use a service, it still runs in your application's main thread by default, so you should still create a new thread within the service if it performs intensive or @@ -183,7 +183,7 @@ by the system. If the system kills your service, it restarts it as soon as resou available again (though this also depends on the value you return from {@link android.app.Service#onStartCommand onStartCommand()}, as discussed later). For more information about when the system might destroy a service, see the Processes and Threading +href="{@docRoot}guide/topics/fundamentals/processes-and-threads.html">Processes and Threading document.

In the following sections, you'll see how you can create each type of service and how to use diff --git a/docs/html/guide/topics/providers/loaders.jd b/docs/html/guide/topics/providers/loaders.jd index c54656c01f823..ab9706b4bfb9e 100644 --- a/docs/html/guide/topics/providers/loaders.jd +++ b/docs/html/guide/topics/providers/loaders.jd @@ -29,8 +29,11 @@ page.title=Using Loaders

Related samples

    -
  1. FragmentCursorLoader
    2. -
  2. LoaderThrottle
    3. +
  3. FragmentListCursorLoader
    4. +
  4. +LoaderThrottle
@@ -480,7 +483,7 @@ public static class CursorLoaderListFragment extends ListFragment

There are a few different samples in ApiDemos that illustrate how to use loaders:

diff --git a/docs/html/guide/topics/ui/actionbar.jd b/docs/html/guide/topics/ui/actionbar.jd index b8d1928f9bf96..065f95a281582 100644 --- a/docs/html/guide/topics/ui/actionbar.jd +++ b/docs/html/guide/topics/ui/actionbar.jd @@ -38,7 +38,15 @@ application
  • {@link android.app.ActionBar}
  • {@link android.view.Menu}
    • - + +

    Related samples

    +
      +
    1. API + Demos
      2. +
    2. Honeycomb Gallery
      3. +
    +

    See also

    1. Creating Menus
      2. @@ -363,7 +371,7 @@ the icon and/or title text. However, if there's not enough room in the Action Ba in the overflow menu as a normal menu item and you must respond to it from the {@link android.app.Activity#onOptionsItemSelected onOptionsItemSelected()} callback method. (For a guide to providing search functionality, see the Search documentation.)

      +href="{@docRoot}guide/topics/search/index.html">Search documentation.)

      When the activity first starts, the system populates the Action Bar and overflow menu by calling {@link android.app.Activity#onCreateOptionsMenu onCreateOptionsMenu()}. @@ -397,7 +405,7 @@ href="{@docRoot}guide/topics/search/index.html">Search developer guide.

      Figure 6. Screenshot of tabs in the Action Bar, from the Honeycomb Gallery sample +href="{@docRoot}resources/samples/HoneycombGallery/index.html">Honeycomb Gallery sample application.

      diff --git a/docs/html/guide/topics/ui/drag-drop.jd b/docs/html/guide/topics/ui/drag-drop.jd index 46ccdf85bb95a..c33c5078a9e5a 100644 --- a/docs/html/guide/topics/ui/drag-drop.jd +++ b/docs/html/guide/topics/ui/drag-drop.jd @@ -289,14 +289,14 @@ DraggableDot.java in table 1. + are listed in table 1.

      The {@link android.view.DragEvent} object also contains the data that your application provided to the system in the call to {@link android.view.View#startDrag(ClipData,View.DragShadowBuilder,Object,int) startDrag()}. Some of the data is valid only for certain action types. The data that is valid for each action - type is summarized in table 2. It is also described in detail with + type is summarized in table 2. It is also described in detail with the event for which it is valid in the section Designing a Drag and Drop Operation.

      diff --git a/docs/html/resources/articles/live-wallpapers.jd b/docs/html/resources/articles/live-wallpapers.jd index ea67fed2c6187..75105507bf526 100644 --- a/docs/html/resources/articles/live-wallpapers.jd +++ b/docs/html/resources/articles/live-wallpapers.jd @@ -27,35 +27,36 @@ to display the appropriate sky.

      Creating your own live wallpaper is easy, especially if you have had -previous experience with SurfaceView or Canvas. +previous experience with {@link android.view.SurfaceView} or {@link +android.graphics.Canvas}. To learn how to create a live wallpaper, you should check out the CubeLiveWallpaper sample code.

      -

      In terms of implementation, a live wallpaper is very similar to a regular -Android service. The -only difference is the addition of a new method, {@code -onCreateEngine()}, whose goal is to create a -WallpaperService.Engine. The engine is responsible for +

      In terms of implementation, a live wallpaper is very similar to a {@link android.app.Service}. +The only difference is the addition of a new method, {@link +android.service.wallpaper.WallpaperService#onCreateEngine()}, whose goal is to create a {@link +android.service.wallpaper.WallpaperService.Engine}. The engine is responsible for handling the lifecycle and drawing of a wallpaper. The system provides a surface -on which you can draw, just like you would with a SurfaceView. +on which you can draw, just like you would with a {@link android.view.SurfaceView}. Drawing a wallpaper can be very expensive so you should optimize your code as much as possible to avoid using too much CPU, not only for battery life but also to avoid slowing down the rest of the system. That is also why the -most important part of the lifecycle of a wallpaper is when it becomes invisible. +most important part of the lifecycle of a wallpaper is when it becomes visible, as indicated +by a call to {@link android.service.wallpaper.WallpaperService.Engine#onVisibilityChanged +onVisibilityChanged()}. When invisible, such as when the user launches an application that covers the home screen, a wallpaper must stop all activity.

      The engine can also implement several methods to interact with the user or the home application. For instance, if you want your wallpaper to scroll -along when the user swipes from one home screen to another, you can use onOffsetsChanged(). -To react to touch events, simply implement onTouchEvent(MotionEvent). +along when the user swipes from one home screen to another, you can use +{@link android.service.wallpaper.WallpaperService.Engine#onOffsetsChanged +onOffsetsChanged()}. +To react to touch events, simply implement {@link +android.service.wallpaper.WallpaperService.Engine#onTouchEvent onTouchEvent()}. Finally, applications can send arbitrary commands to the live wallpaper. -Currently, only the standard home application sends commands to the onCommand() +Currently, only the standard home application sends commands to the +{@link android.service.wallpaper.WallpaperService.Engine#onCommand onCommand()} method of the live wallpaper: