diff options
author | Xavier Ducrohet <xav@android.com> | 2010-12-15 13:32:51 -0800 |
---|---|---|
committer | Xavier Ducrohet <xav@android.com> | 2010-12-15 13:32:51 -0800 |
commit | 77f08335a1a355726347ad23213c1082072d0923 (patch) | |
tree | f898e2049647c64acbf9b463b95defb7cacae02b /layoutlib_api | |
parent | c4244e96692109505cdca59a88f5a7c3f1ee8184 (diff) | |
download | sdk-77f08335a1a355726347ad23213c1082072d0923.zip sdk-77f08335a1a355726347ad23213c1082072d0923.tar.gz sdk-77f08335a1a355726347ad23213c1082072d0923.tar.bz2 |
Fix javadoc for layout lib api.
Change-Id: I42b835ef2dc34af069567555ce9a4e4ecfcd6639
Diffstat (limited to 'layoutlib_api')
7 files changed, 19 insertions, 24 deletions
diff --git a/layoutlib_api/src/com/android/layoutlib/api/Capability.java b/layoutlib_api/src/com/android/layoutlib/api/Capability.java index 586642f..87ceca1 100644 --- a/layoutlib_api/src/com/android/layoutlib/api/Capability.java +++ b/layoutlib_api/src/com/android/layoutlib/api/Capability.java @@ -16,8 +16,6 @@ package com.android.layoutlib.api; -import com.android.layoutlib.api.LayoutScene.IAnimationListener; - /** * Enum describing the layout bridge capabilities. * @@ -36,7 +34,7 @@ public enum Capability { EMBEDDED_LAYOUT, /** Ability to call<br> * {@link LayoutScene#insertChild(Object, IXmlPullParser, int, com.android.layoutlib.api.LayoutScene.IAnimationListener)}<br> - * {@link LayoutScene#moveChild(Object, Object, int, com.android.layoutlib.api.LayoutScene.IAnimationListener)}<br> + * {@link LayoutScene#moveChild(Object, Object, int, java.util.Map, com.android.layoutlib.api.LayoutScene.IAnimationListener)}<br> * {@link LayoutScene#removeChild(Object, com.android.layoutlib.api.LayoutScene.IAnimationListener)}<br> * {@link LayoutScene#setProperty(Object, String, String)} * */ @@ -44,6 +42,6 @@ public enum Capability { /** Ability to call<br> * {@link LayoutScene#animate(Object, String, boolean, com.android.layoutlib.api.LayoutScene.IAnimationListener)} * <p>If the bridge also supports {@link #VIEW_MANIPULATION} then those methods can use - * an {@link IAnimationListener}, otherwise they won't. */ + * an {@link com.android.layoutlib.api.LayoutScene.IAnimationListener}, otherwise they won't. */ ANIMATE; } diff --git a/layoutlib_api/src/com/android/layoutlib/api/ILayoutBridge.java b/layoutlib_api/src/com/android/layoutlib/api/ILayoutBridge.java index 70d099d..f5d3660 100644 --- a/layoutlib_api/src/com/android/layoutlib/api/ILayoutBridge.java +++ b/layoutlib_api/src/com/android/layoutlib/api/ILayoutBridge.java @@ -44,7 +44,7 @@ import java.util.Map; * <li>new render method: {@link #computeLayout(IXmlPullParser, Object, int, int, String, boolean, Map, Map, IProjectCallback, ILayoutLog)}</li> * <li>deprecated {@link #computeLayout(IXmlPullParser, Object, int, int, String, Map, Map, IProjectCallback, ILayoutLog)}</li> * </ul> - * @Deprecated Extend {@link LayoutBridge} instead. + * @deprecated Extend {@link LayoutBridge} instead. */ @Deprecated public interface ILayoutBridge { @@ -76,7 +76,7 @@ public interface ILayoutBridge { /** * Starts a layout session by inflating and rendering it. The method returns a - * {@link ILayoutScene} on which further actions can be taken. + * {@link ILayoutResult} on which further actions can be taken. * * @param layoutDescription the {@link IXmlPullParser} letting the LayoutLib Bridge visit the * layout file. @@ -102,7 +102,7 @@ public interface ILayoutBridge { * the project. * @param logger the object responsible for displaying warning/errors to the user. * @return a new {@link ILayoutResult} object that contains the result of the layout. - * @deprecated use {@link #startLayout(IXmlPullParser, Object, int, int, boolean, int, float, float, String, boolean, Map, Map, IProjectCallback, ILayoutLog)} + * @deprecated use {@link LayoutBridge#createScene(SceneParams)} * @since 4 */ @Deprecated @@ -139,7 +139,7 @@ public interface ILayoutBridge { * the project. * @param logger the object responsible for displaying warning/errors to the user. * @return a new {@link ILayoutResult} object that contains the result of the layout. - * @deprecated use {@link #startLayout(IXmlPullParser, Object, int, int, boolean, int, float, float, String, boolean, Map, Map, IProjectCallback, ILayoutLog)} + * @deprecated use {@link LayoutBridge#createScene(SceneParams)} * @since 3 */ @Deprecated @@ -172,7 +172,7 @@ public interface ILayoutBridge { * the project. * @param logger the object responsible for displaying warning/errors to the user. * @return a new {@link ILayoutResult} object that contains the result of the layout. - * @deprecated use {@link #startLayout(IXmlPullParser, Object, int, int, boolean, int, float, float, String, boolean, Map, Map, IProjectCallback, ILayoutLog)} + * @deprecated use {@link LayoutBridge#createScene(SceneParams)} * @since 2 */ @Deprecated @@ -204,7 +204,7 @@ public interface ILayoutBridge { * the project. * @param logger the object responsible for displaying warning/errors to the user. * @return a new {@link ILayoutResult} object that contains the result of the layout. - * @deprecated use {@link #startLayout(IXmlPullParser, Object, int, int, boolean, int, float, float, String, boolean, Map, Map, IProjectCallback, ILayoutLog)} + * @deprecated use {@link LayoutBridge#createScene(SceneParams)} * @since 1 */ @Deprecated diff --git a/layoutlib_api/src/com/android/layoutlib/api/ILayoutResult.java b/layoutlib_api/src/com/android/layoutlib/api/ILayoutResult.java index ada71a7..a4d6da0 100644 --- a/layoutlib_api/src/com/android/layoutlib/api/ILayoutResult.java +++ b/layoutlib_api/src/com/android/layoutlib/api/ILayoutResult.java @@ -19,11 +19,10 @@ package com.android.layoutlib.api; import java.awt.image.BufferedImage; /** - * The result of a layout computation through - * {@link ILayoutLibBridge#computeLayout(IXmlPullParser, int, int, String, java.util.Map, java.util.Map, java.util.Map, IFontLoader, ILayoutLibLog, ICustomViewLoader)} + * The result of a layout computation through {@link ILayoutBridge}. * * @since 1 - * @deprecated use {@link ILayoutScene} as returned by {@link ILayoutBridge#startLayout(IXmlPullParser, Object, int, int, boolean, int, float, float, String, boolean, java.util.Map, java.util.Map, IProjectCallback, ILayoutLog)} + * @deprecated use {@link LayoutScene} as returned by {@link LayoutBridge#createScene(SceneParams)} */ public interface ILayoutResult { /** @@ -33,7 +32,7 @@ public interface ILayoutResult { /** * Error return code, in which case an error message is guaranteed to be defined. - * @See {@link #getErrorMessage()} + * @see #getErrorMessage() */ final static int ERROR = 1; diff --git a/layoutlib_api/src/com/android/layoutlib/api/IXmlPullParser.java b/layoutlib_api/src/com/android/layoutlib/api/IXmlPullParser.java index 6d0f2b6..c3c738f 100644 --- a/layoutlib_api/src/com/android/layoutlib/api/IXmlPullParser.java +++ b/layoutlib_api/src/com/android/layoutlib/api/IXmlPullParser.java @@ -18,11 +18,9 @@ package com.android.layoutlib.api; import org.xmlpull.v1.XmlPullParser; -import java.util.Map; - /** * Extended version of {@link XmlPullParser} to use with - * {@link ILayoutLibBridge#startLayout(IXmlPullParser, Object, int, int, boolean, int, float, float, String, boolean, Map, Map, IProjectCallback, ILayoutLog)} + * {@link LayoutBridge#createScene(SceneParams)} */ public interface IXmlPullParser extends XmlPullParser { diff --git a/layoutlib_api/src/com/android/layoutlib/api/LayoutBridge.java b/layoutlib_api/src/com/android/layoutlib/api/LayoutBridge.java index 7c66bc4..a3bd921 100644 --- a/layoutlib_api/src/com/android/layoutlib/api/LayoutBridge.java +++ b/layoutlib_api/src/com/android/layoutlib/api/LayoutBridge.java @@ -66,7 +66,7 @@ public abstract class LayoutBridge { * Starts a layout session by inflating and rendering it. The method returns a * {@link LayoutScene} on which further actions can be taken. * - * @return a new {@link ILayoutScene} object that contains the result of the scene creation and + * @return a new {@link LayoutScene} object that contains the result of the scene creation and * first rendering. */ public LayoutScene createScene(SceneParams params) { diff --git a/layoutlib_api/src/com/android/layoutlib/api/LayoutScene.java b/layoutlib_api/src/com/android/layoutlib/api/LayoutScene.java index 0883b45..8bfa7ed 100644 --- a/layoutlib_api/src/com/android/layoutlib/api/LayoutScene.java +++ b/layoutlib_api/src/com/android/layoutlib/api/LayoutScene.java @@ -166,7 +166,7 @@ public class LayoutScene { * If the listener is null, then the rendering is done synchronously. * <p/> * The child stays in the view hierarchy after the rendering is done. To remove it call - * {@link #removeChild(Object, int)}. + * {@link #removeChild(Object, IAnimationListener)} * <p/> * The returned {@link SceneResult} object will contain the android.view.View object for * the newly inflated child. It is accessible through {@link SceneResult#getData()}. @@ -199,7 +199,7 @@ public class LayoutScene { * If the listener is null, then the rendering is done synchronously. * <p/> * The child stays in the view hierarchy after the rendering is done. To remove it call - * {@link #removeChild(Object, int)}. + * {@link #removeChild(Object, IAnimationListener)} * <p/> * The returned {@link SceneResult} object will contain the android.view.ViewGroup.LayoutParams * object created from the <var>layoutParams</var> map if it was non <code>null</code>. diff --git a/layoutlib_api/src/com/android/layoutlib/api/SceneResult.java b/layoutlib_api/src/com/android/layoutlib/api/SceneResult.java index 1417f3d..2954671 100644 --- a/layoutlib_api/src/com/android/layoutlib/api/SceneResult.java +++ b/layoutlib_api/src/com/android/layoutlib/api/SceneResult.java @@ -20,10 +20,10 @@ package com.android.layoutlib.api; * Scene result class. This is an immutable class. * <p/> * This cannot be allocated directly, instead use - * {@link SceneStatus#getResult()}, - * {@link SceneStatus#getResult(String, Throwable)}, - * {@link SceneStatus#getResult(String)} - * {@link SceneStatus#getResult(Object)} + * {@link SceneStatus#createResult()}, + * {@link SceneStatus#createResult(String, Throwable)}, + * {@link SceneStatus#createResult(String)} + * {@link SceneStatus#createResult(Object)} */ public class SceneResult { |