leanback: some javadoc fixes

Bug 24804296
Bug 24806837
Bug 24807801
Bug 24806081
Bug 24804939

Change-Id: Ie611c6c663335628ba98c2571bfda494e80f47b3
diff --git a/v17/leanback/src/android/support/v17/leanback/app/GuidedStepFragment.java b/v17/leanback/src/android/support/v17/leanback/app/GuidedStepFragment.java
index d26a91c..daab9ac 100644
--- a/v17/leanback/src/android/support/v17/leanback/app/GuidedStepFragment.java
+++ b/v17/leanback/src/android/support/v17/leanback/app/GuidedStepFragment.java
@@ -152,7 +152,7 @@
     public static final String EXTRA_UI_STYLE = "uiStyle";
 
     /**
-     * Default argument value for argument {@link #EXTRA_UI_STYLE}.  This the default value assigned
+     * Default value for argument {@link #EXTRA_UI_STYLE}.  The default value is assigned
      * in GuidedStepFragment constructor.  This is the case that we use GuidedStepFragment to
      * replace another existing GuidedStepFragment when moving forward to next step. Default
      * behavior of this style is:
@@ -165,12 +165,12 @@
     public static final int UI_STYLE_DEFAULT = 0;
 
     /**
-     * Argument value for argument {@link #EXTRA_UI_STYLE}.  This is the case that we show
+     * One possible value of argument {@link #EXTRA_UI_STYLE}.  This is the case that we show
      * GuidedStepFragment on top of other content.  The default behavior of this style:
      * <ul>
      * <li>Enter transition slides in from two sides, exit transition is inherited from
-     * {@link #UI_STYLE_DEFAULT}.  Note: Changing exit transition by uiStyle is not working because
-     * fragment transition asks for exit transition before uiStyle is restored in Fragment
+     * {@link #UI_STYLE_DEFAULT}.  Note: Changing exit transition by UI style is not working because
+     * fragment transition asks for exit transition before UI style is restored in Fragment
      * .onCreate().</li>
      * <li> {@link #onProvideBackgroundFragment()} will create {@link GuidedStepBackgroundFragment}
      * to covering underneath content. The activity must provide a container to host background
@@ -180,12 +180,12 @@
     public static final int UI_STYLE_ENTRANCE = 1;
 
     /**
-     * Argument value for argument {@link #EXTRA_UI_STYLE}.  This is the case that we show first
+     * One possible value of argument {@link #EXTRA_UI_STYLE}.  This is the case that we show first
      * GuidedStepFragment in a separate activity.  The default behavior of this style:
      * <ul>
      * <li> Enter transition is assigned null (will rely on activity transition), exit transition is
-     * same as {@link #UI_STYLE_DEFAULT}.  Note: Changing exit transition by ui style is not working
-     * because fragment transition asks for exit transition before uiStyle is restored in
+     * same as {@link #UI_STYLE_DEFAULT}.  Note: Changing exit transition by UI style is not working
+     * because fragment transition asks for exit transition before UI style is restored in
      * Fragment.onCreate().</li>
      * <li> No background, see {@link #onProvideBackgroundFragment()}.
      * </ul>
@@ -497,7 +497,7 @@
     }
 
     /**
-     * Default implementation of background for covering content bellow GuidedStepFragment.
+     * Default implementation of background for covering content below GuidedStepFragment.
      * It uses current theme attribute guidedStepBackground which by default is read from
      * android:windowBackground.
      */
@@ -556,7 +556,7 @@
      * for {@link #UI_STYLE_DEFAULT}.  Background fragment will be inserted in {@link
      * #getContainerIdForBackground()}.
      *
-     * @return fragment that will be inserted bellow GuidedStepFragment.
+     * @return fragment that will be inserted below GuidedStepFragment.
      */
     protected Fragment onProvideBackgroundFragment() {
         if (getUiStyle() == UI_STYLE_ENTRANCE) {
diff --git a/v17/leanback/src/android/support/v17/leanback/app/GuidedStepSupportFragment.java b/v17/leanback/src/android/support/v17/leanback/app/GuidedStepSupportFragment.java
index 4f63a96..577133d 100644
--- a/v17/leanback/src/android/support/v17/leanback/app/GuidedStepSupportFragment.java
+++ b/v17/leanback/src/android/support/v17/leanback/app/GuidedStepSupportFragment.java
@@ -154,7 +154,7 @@
     public static final String EXTRA_UI_STYLE = "uiStyle";
 
     /**
-     * Default argument value for argument {@link #EXTRA_UI_STYLE}.  This the default value assigned
+     * Default value for argument {@link #EXTRA_UI_STYLE}.  The default value is assigned
      * in GuidedStepSupportFragment constructor.  This is the case that we use GuidedStepSupportFragment to
      * replace another existing GuidedStepSupportFragment when moving forward to next step. Default
      * behavior of this style is:
@@ -167,12 +167,12 @@
     public static final int UI_STYLE_DEFAULT = 0;
 
     /**
-     * Argument value for argument {@link #EXTRA_UI_STYLE}.  This is the case that we show
+     * One possible value of argument {@link #EXTRA_UI_STYLE}.  This is the case that we show
      * GuidedStepSupportFragment on top of other content.  The default behavior of this style:
      * <ul>
      * <li>Enter transition slides in from two sides, exit transition is inherited from
-     * {@link #UI_STYLE_DEFAULT}.  Note: Changing exit transition by uiStyle is not working because
-     * fragment transition asks for exit transition before uiStyle is restored in Fragment
+     * {@link #UI_STYLE_DEFAULT}.  Note: Changing exit transition by UI style is not working because
+     * fragment transition asks for exit transition before UI style is restored in Fragment
      * .onCreate().</li>
      * <li> {@link #onProvideBackgroundSupportFragment()} will create {@link GuidedStepBackgroundSupportFragment}
      * to covering underneath content. The activity must provide a container to host background
@@ -182,12 +182,12 @@
     public static final int UI_STYLE_ENTRANCE = 1;
 
     /**
-     * Argument value for argument {@link #EXTRA_UI_STYLE}.  This is the case that we show first
+     * One possible value of argument {@link #EXTRA_UI_STYLE}.  This is the case that we show first
      * GuidedStepSupportFragment in a separate activity.  The default behavior of this style:
      * <ul>
      * <li> Enter transition is assigned null (will rely on activity transition), exit transition is
-     * same as {@link #UI_STYLE_DEFAULT}.  Note: Changing exit transition by ui style is not working
-     * because fragment transition asks for exit transition before uiStyle is restored in
+     * same as {@link #UI_STYLE_DEFAULT}.  Note: Changing exit transition by UI style is not working
+     * because fragment transition asks for exit transition before UI style is restored in
      * Fragment.onCreate().</li>
      * <li> No background, see {@link #onProvideBackgroundSupportFragment()}.
      * </ul>
@@ -499,7 +499,7 @@
     }
 
     /**
-     * Default implementation of background for covering content bellow GuidedStepSupportFragment.
+     * Default implementation of background for covering content below GuidedStepSupportFragment.
      * It uses current theme attribute guidedStepBackground which by default is read from
      * android:windowBackground.
      */
@@ -558,7 +558,7 @@
      * for {@link #UI_STYLE_DEFAULT}.  Background fragment will be inserted in {@link
      * #getContainerIdForBackground()}.
      *
-     * @return fragment that will be inserted bellow GuidedStepSupportFragment.
+     * @return fragment that will be inserted below GuidedStepSupportFragment.
      */
     protected Fragment onProvideBackgroundSupportFragment() {
         if (getUiStyle() == UI_STYLE_ENTRANCE) {
diff --git a/v17/leanback/src/android/support/v17/leanback/app/PlaybackControlGlue.java b/v17/leanback/src/android/support/v17/leanback/app/PlaybackControlGlue.java
index 8c56925..e3af403 100644
--- a/v17/leanback/src/android/support/v17/leanback/app/PlaybackControlGlue.java
+++ b/v17/leanback/src/android/support/v17/leanback/app/PlaybackControlGlue.java
@@ -74,7 +74,7 @@
  */
 public abstract class PlaybackControlGlue implements OnActionClickedListener, View.OnKeyListener {
     /**
-     * The adapter key for the first custom control on the right side
+     * The adapter key for the first custom control on the left side
      * of the predefined primary controls.
      */
     public static final int ACTION_CUSTOM_LEFT_FIRST = 0x1;
diff --git a/v17/leanback/src/android/support/v17/leanback/app/PlaybackControlSupportGlue.java b/v17/leanback/src/android/support/v17/leanback/app/PlaybackControlSupportGlue.java
index 76f312d..5857e65 100644
--- a/v17/leanback/src/android/support/v17/leanback/app/PlaybackControlSupportGlue.java
+++ b/v17/leanback/src/android/support/v17/leanback/app/PlaybackControlSupportGlue.java
@@ -76,7 +76,7 @@
  */
 public abstract class PlaybackControlSupportGlue implements OnActionClickedListener, View.OnKeyListener {
     /**
-     * The adapter key for the first custom control on the right side
+     * The adapter key for the first custom control on the left side
      * of the predefined primary controls.
      */
     public static final int ACTION_CUSTOM_LEFT_FIRST = 0x1;
diff --git a/v17/leanback/src/android/support/v17/leanback/widget/ListRowPresenter.java b/v17/leanback/src/android/support/v17/leanback/widget/ListRowPresenter.java
index 646487e..737492b 100644
--- a/v17/leanback/src/android/support/v17/leanback/widget/ListRowPresenter.java
+++ b/v17/leanback/src/android/support/v17/leanback/widget/ListRowPresenter.java
@@ -613,8 +613,10 @@
     }
 
     /**
-     * Returns true if keeps foreground of child of this row, false ListRowPresenter might change
-     * child's foreground for applying overlay on the child.
+     * Returns true if keeps foreground of child of this row, false otherwise.  When
+     * ListRowPresenter applies overlay color on the child,  it may change child's foreground
+     * Drawable.  If application uses child's foreground for other purposes such as ripple effect,
+     * it needs tell ListRowPresenter to keep the child's foreground.  The default value is true.
      *
      * @return true if keeps foreground of child of this row, false otherwise.
      */
diff --git a/v17/leanback/src/android/support/v17/leanback/widget/ShadowOverlayHelper.java b/v17/leanback/src/android/support/v17/leanback/widget/ShadowOverlayHelper.java
index 4843b58..5f942c6 100644
--- a/v17/leanback/src/android/support/v17/leanback/widget/ShadowOverlayHelper.java
+++ b/v17/leanback/src/android/support/v17/leanback/widget/ShadowOverlayHelper.java
@@ -403,7 +403,7 @@
     }
 
     /**
-     * Set shadow focus level (0 to 1). 0 for unfocused, 1f for fully focused.
+     * Set shadow focus level (0 to 1). 0 for unfocused, 1 for fully focused.
      * This is for view other than ShadowOverlayContainer.
      * See also {@link ShadowOverlayContainer#setShadowFocusLevel(float)}.
      */
@@ -412,7 +412,7 @@
     }
 
     /**
-     * Set shadow focus level (0 to 1). 0 for unfocused, 1f for fully focused.
+     * Set shadow focus level (0 to 1). 0 for unfocused, 1 for fully focused.
      */
     public void setShadowFocusLevel(View view, float level) {
         if (needsWrapper()) {