diff options
| author | 2009-09-14 11:17:49 -0700 | |
|---|---|---|
| committer | 2009-09-14 11:17:49 -0700 | |
| commit | 7a79628cd9b5149a7b38b90bf6cef9ea67cfbc21 (patch) | |
| tree | 55e5a2a501a46f3fee9da2471ecb1963b4b229d0 | |
| parent | 466dbbfd4595d714127a4bc92dd9235807b88be6 (diff) | |
Fix some LayoutBridge javadoc.
Change-Id: I255d1d58d3537403ac9a8a5c7adece30ae989ce0
| -rw-r--r-- | tools/layoutlib/api/src/com/android/layoutlib/api/ILayoutBridge.java | 10 | ||||
| -rw-r--r-- | tools/layoutlib/api/src/com/android/layoutlib/api/ILayoutResult.java | 20 |
2 files changed, 17 insertions, 13 deletions
diff --git a/tools/layoutlib/api/src/com/android/layoutlib/api/ILayoutBridge.java b/tools/layoutlib/api/src/com/android/layoutlib/api/ILayoutBridge.java index c562650f2a3d..4dbcfdc4a6ac 100644 --- a/tools/layoutlib/api/src/com/android/layoutlib/api/ILayoutBridge.java +++ b/tools/layoutlib/api/src/com/android/layoutlib/api/ILayoutBridge.java @@ -88,7 +88,7 @@ public interface ILayoutBridge { * @param projectCallback The {@link IProjectCallback} object to get information from * the project. * @param logger the object responsible for displaying warning/errors to the user. - * @return an {@link ILayoutResult} object that contains the result of the layout. + * @return a new {@link ILayoutResult} object that contains the result of the layout. * @since 4 */ ILayoutResult computeLayout(IXmlPullParser layoutDescription, @@ -123,7 +123,7 @@ public interface ILayoutBridge { * @param projectCallback The {@link IProjectCallback} object to get information from * the project. * @param logger the object responsible for displaying warning/errors to the user. - * @return an {@link ILayoutResult} object that contains the result of the layout. + * @return a new {@link ILayoutResult} object that contains the result of the layout. * @since 3 */ @Deprecated @@ -155,7 +155,7 @@ public interface ILayoutBridge { * @param projectCallback The {@link IProjectCallback} object to get information from * the project. * @param logger the object responsible for displaying warning/errors to the user. - * @return an {@link ILayoutResult} object that contains the result of the layout. + * @return a new {@link ILayoutResult} object that contains the result of the layout. * @deprecated Use {@link #computeLayout(IXmlPullParser, Object, int, int, int, float, float, String, boolean, Map, Map, IProjectCallback, ILayoutLog)} * @since 2 */ @@ -187,7 +187,7 @@ public interface ILayoutBridge { * @param projectCallback The {@link IProjectCallback} object to get information from * the project. * @param logger the object responsible for displaying warning/errors to the user. - * @return an {@link ILayoutResult} object that contains the result of the layout. + * @return a new {@link ILayoutResult} object that contains the result of the layout. * @deprecated Use {@link #computeLayout(IXmlPullParser, Object, int, int, int, float, float, String, boolean, Map, Map, IProjectCallback, ILayoutLog)} * @since 1 */ @@ -205,7 +205,7 @@ public interface ILayoutBridge { * until this method is called. * <p/>The cache is not configuration dependent and should only be cleared when a * resource changes (at this time only bitmaps and 9 patches go into the cache). - * @param objectKey the key for the project. + * @param projectKey the key for the project. * @since 1 */ void clearCaches(Object projectKey); diff --git a/tools/layoutlib/api/src/com/android/layoutlib/api/ILayoutResult.java b/tools/layoutlib/api/src/com/android/layoutlib/api/ILayoutResult.java index 5a06349ba9f2..2d8a210123fb 100644 --- a/tools/layoutlib/api/src/com/android/layoutlib/api/ILayoutResult.java +++ b/tools/layoutlib/api/src/com/android/layoutlib/api/ILayoutResult.java @@ -23,13 +23,17 @@ import java.awt.image.BufferedImage; * {@link ILayoutLibBridge#computeLayout(IXmlPullParser, int, int, String, java.util.Map, java.util.Map, java.util.Map, IFontLoader, ILayoutLibLog, ICustomViewLoader)} */ public interface ILayoutResult { - /** Sucess return code */ + /** + * Success return code + */ final static int SUCCESS = 0; - /** Error return code. - * <p/>See {@link #getErrorMessage()} - */ + + /** + * Error return code, in which case an error message is guaranteed to be defined. + * @See {@link #getErrorMessage()} + */ final static int ERROR = 1; - + /** * Returns the result code. * @see #SUCCESS @@ -62,18 +66,18 @@ public interface ILayoutResult { * Returns the list of children views. */ ILayoutViewInfo[] getChildren(); - + /** * Returns the key associated with the node. * @see IXmlPullParser#getViewKey() */ Object getViewKey(); - + /** * Returns the name of the view. */ String getName(); - + /** * Returns the left of the view bounds. */ |