diff options
author | Xavier Ducrohet <xav@android.com> | 2012-10-02 17:37:28 -0700 |
---|---|---|
committer | Xavier Ducrohet <xav@android.com> | 2012-10-02 17:37:28 -0700 |
commit | bdb9903224d688b264b6a9b4c7aa3fa8e0142996 (patch) | |
tree | 6f80d17a615c1798bda4b4925f1bc42e88d568f4 /layoutlib_api/src/com/android/ide/common/rendering/api | |
parent | d19ce5efa561089937102f19a373ac5324311a03 (diff) | |
download | sdk-bdb9903224d688b264b6a9b4c7aa3fa8e0142996.zip sdk-bdb9903224d688b264b6a9b4c7aa3fa8e0142996.tar.gz sdk-bdb9903224d688b264b6a9b4c7aa3fa8e0142996.tar.bz2 |
Fix javadoc here and there.
Change-Id: If02d0b97c294d9821a1c914547782a08b1d256fb
Diffstat (limited to 'layoutlib_api/src/com/android/ide/common/rendering/api')
9 files changed, 15 insertions, 42 deletions
diff --git a/layoutlib_api/src/com/android/ide/common/rendering/api/DeclareStyleableResourceValue.java b/layoutlib_api/src/com/android/ide/common/rendering/api/DeclareStyleableResourceValue.java index f14255f..a8f269f 100644 --- a/layoutlib_api/src/com/android/ide/common/rendering/api/DeclareStyleableResourceValue.java +++ b/layoutlib_api/src/com/android/ide/common/rendering/api/DeclareStyleableResourceValue.java @@ -27,7 +27,7 @@ import java.util.Map; * {@link #getValue()} will return null, instead use {@link #getAttributeValues(String)} to * get the enum/flag value associated with an attribute defined in the declare-styleable. * - * @Deprecated This class is broken as it does not handle the namespace for each attribute. + * @deprecated This class is broken as it does not handle the namespace for each attribute. * Thankfully, newer versions of layoutlib don't actually use it, so we just keep it as is for * backward compatibility on older layoutlibs. * diff --git a/layoutlib_api/src/com/android/ide/common/rendering/api/DrawableParams.java b/layoutlib_api/src/com/android/ide/common/rendering/api/DrawableParams.java index 766b3be..346d67d 100644 --- a/layoutlib_api/src/com/android/ide/common/rendering/api/DrawableParams.java +++ b/layoutlib_api/src/com/android/ide/common/rendering/api/DrawableParams.java @@ -37,16 +37,7 @@ public class DrawableParams extends RenderParams { * @param density the density factor for the screen. * @param xdpi the screen actual dpi in X * @param ydpi the screen actual dpi in Y - * @param themeName The name of the theme to use. - * @param isProjectTheme true if the theme is a project theme, false if it is a framework theme. - * @param projectResources the resources of the project. The map contains (String, map) pairs - * where the string is the type of the resource reference used in the layout file, and the - * map contains (String, {@link ResourceValue}) pairs where the key is the resource name, - * and the value is the resource value. - * @param frameworkResources the framework resources. The map contains (String, map) pairs - * where the string is the type of the resource reference used in the layout file, and the map - * contains (String, {@link ResourceValue}) pairs where the key is the resource name, and the - * value is the resource value. + * @param renderResources a {@link RenderResources} object providing access to the resources. * @param projectCallback The {@link IProjectCallback} object to get information from * the project. * @param minSdkVersion the minSdkVersion of the project diff --git a/layoutlib_api/src/com/android/ide/common/rendering/api/ILayoutPullParser.java b/layoutlib_api/src/com/android/ide/common/rendering/api/ILayoutPullParser.java index 574f9bb..9c0e97b 100644 --- a/layoutlib_api/src/com/android/ide/common/rendering/api/ILayoutPullParser.java +++ b/layoutlib_api/src/com/android/ide/common/rendering/api/ILayoutPullParser.java @@ -20,7 +20,7 @@ import org.xmlpull.v1.XmlPullParser; /** * Extended version of {@link XmlPullParser} to use with - * {@link Bridge#createScene(SceneParams)} + * {@link Bridge#createSession(SessionParams)} */ public interface ILayoutPullParser extends XmlPullParser { diff --git a/layoutlib_api/src/com/android/ide/common/rendering/api/IProjectCallback.java b/layoutlib_api/src/com/android/ide/common/rendering/api/IProjectCallback.java index 8ccdd75..a88b0d3 100644 --- a/layoutlib_api/src/com/android/ide/common/rendering/api/IProjectCallback.java +++ b/layoutlib_api/src/com/android/ide/common/rendering/api/IProjectCallback.java @@ -126,7 +126,7 @@ public interface IProjectCallback { * of the same type. This is only valid if the adapter view is an ExpandableListView. * If there is only one type of items, this is the same as <var>fullParentPosition</var>. * @param viewRef The {@link ResourceReference} for the view we're trying to fill. - * @param ViewAttribute the attribute being queried. + * @param viewAttribute the attribute being queried. * @param defaultValue the default value for this attribute. The object class matches the * class associated with the {@link ViewAttribute}. * @return the item value or null if there's no value. diff --git a/layoutlib_api/src/com/android/ide/common/rendering/api/RenderParams.java b/layoutlib_api/src/com/android/ide/common/rendering/api/RenderParams.java index 2cfe770..f89dcfe 100644 --- a/layoutlib_api/src/com/android/ide/common/rendering/api/RenderParams.java +++ b/layoutlib_api/src/com/android/ide/common/rendering/api/RenderParams.java @@ -60,16 +60,7 @@ public abstract class RenderParams { * @param density the density factor for the screen. * @param xdpi the screen actual dpi in X * @param ydpi the screen actual dpi in Y - * @param themeName The name of the theme to use. - * @param isProjectTheme true if the theme is a project theme, false if it is a framework theme. - * @param projectResources the resources of the project. The map contains (String, map) pairs - * where the string is the type of the resource reference used in the layout file, and the - * map contains (String, {@link ResourceValue}) pairs where the key is the resource name, - * and the value is the resource value. - * @param frameworkResources the framework resources. The map contains (String, map) pairs - * where the string is the type of the resource reference used in the layout file, and the map - * contains (String, {@link ResourceValue}) pairs where the key is the resource name, and the - * value is the resource value. + * @param renderResources a {@link RenderResources} object providing access to the resources. * @param projectCallback The {@link IProjectCallback} object to get information from * the project. * @param minSdkVersion the minSdkVersion of the project diff --git a/layoutlib_api/src/com/android/ide/common/rendering/api/RenderResources.java b/layoutlib_api/src/com/android/ide/common/rendering/api/RenderResources.java index f9e02d6..c362224 100644 --- a/layoutlib_api/src/com/android/ide/common/rendering/api/RenderResources.java +++ b/layoutlib_api/src/com/android/ide/common/rendering/api/RenderResources.java @@ -134,7 +134,7 @@ public class RenderResources { * @param attrName the name of the attribute to search for. * @return the {@link ResourceValue} object or <code>null</code> * - * @Deprecated Use {@link #findItemInStyle(StyleResourceValue, String, boolean)} since this + * @deprecated Use {@link #findItemInStyle(StyleResourceValue, String, boolean)} since this * method doesn't know the item namespace. */ @Deprecated diff --git a/layoutlib_api/src/com/android/ide/common/rendering/api/RenderSession.java b/layoutlib_api/src/com/android/ide/common/rendering/api/RenderSession.java index 188909e..96caa6a 100644 --- a/layoutlib_api/src/com/android/ide/common/rendering/api/RenderSession.java +++ b/layoutlib_api/src/com/android/ide/common/rendering/api/RenderSession.java @@ -27,7 +27,7 @@ import java.util.Map; /** * An object allowing interaction with an Android layout. * - * This is returned by {@link Bridge#createScene(RenderParams)}. + * This is returned by {@link Bridge#createSession(SessionParams)}. * and can then be used for subsequent actions on the layout. * * @since 5 @@ -94,7 +94,7 @@ public class RenderSession { /** * Re-renders the layout as-is. - * In case of success, this should be followed by calls to {@link #getRootView()} and + * In case of success, this should be followed by calls to {@link #getRootViews()} and * {@link #getImage()} to access the result of the rendering. * * This is equivalent to calling <code>render(SceneParams.DEFAULT_TIMEOUT)</code> @@ -107,7 +107,7 @@ public class RenderSession { /** * Re-renders the layout as-is, with a given timeout in case other renderings are being done. - * In case of success, this should be followed by calls to {@link #getRootView()} and + * In case of success, this should be followed by calls to {@link #getRootViews()} and * {@link #getImage()} to access the result of the rendering. * * The {@link Bridge} is only able to inflate or render one layout at a time. There diff --git a/layoutlib_api/src/com/android/ide/common/rendering/api/SessionParams.java b/layoutlib_api/src/com/android/ide/common/rendering/api/SessionParams.java index 1af450e..a620b05 100644 --- a/layoutlib_api/src/com/android/ide/common/rendering/api/SessionParams.java +++ b/layoutlib_api/src/com/android/ide/common/rendering/api/SessionParams.java @@ -67,16 +67,7 @@ public class SessionParams extends RenderParams { * @param density the density factor for the screen. * @param xdpi the screen actual dpi in X * @param ydpi the screen actual dpi in Y - * @param themeName The name of the theme to use. - * @param isProjectTheme true if the theme is a project theme, false if it is a framework theme. - * @param projectResources the resources of the project. The map contains (String, map) pairs - * where the string is the type of the resource reference used in the layout file, and the - * map contains (String, {@link ResourceValue}) pairs where the key is the resource name, - * and the value is the resource value. - * @param frameworkResources the framework resources. The map contains (String, map) pairs - * where the string is the type of the resource reference used in the layout file, and the map - * contains (String, {@link ResourceValue}) pairs where the key is the resource name, and the - * value is the resource value. + * @param renderResources a {@link RenderResources} object providing access to the resources. * @param projectCallback The {@link IProjectCallback} object to get information from * the project. * @param minSdkVersion the minSdkVersion of the project diff --git a/layoutlib_api/src/com/android/ide/common/rendering/api/ViewInfo.java b/layoutlib_api/src/com/android/ide/common/rendering/api/ViewInfo.java index 2671fc0..d859e95 100644 --- a/layoutlib_api/src/com/android/ide/common/rendering/api/ViewInfo.java +++ b/layoutlib_api/src/com/android/ide/common/rendering/api/ViewInfo.java @@ -88,7 +88,7 @@ public class ViewInfo { /** * Returns the cookie associated with the XML node. Can be null. * - * @see ILayoutPullParser#getViewKey() + * @see ILayoutPullParser#getViewCookie() */ public Object getCookie() { return mCookie; @@ -131,8 +131,8 @@ public class ViewInfo { /** * Returns the actual android.view.View (or child class) object. This can be used - * to query the object properties that are not in the XML and not in the map returned - * by {@link #getDefaultPropertyValues()}. + * to query the object properties that are not in the XML and not available through + * {@link RenderSession#getProperty(Object, String)}. */ public Object getViewObject() { return mViewObject; @@ -140,8 +140,8 @@ public class ViewInfo { /** * Returns the actual android.view.ViewGroup$LayoutParams (or child class) object. - * This can be used to query the object properties that are not in the XML and not in - * the map returned by {@link #getDefaultPropertyValues()}. + * This can be used to query the object properties that are not in the XML and not available + * through {@link RenderSession#getProperty(Object, String)}. */ public Object getLayoutParamsObject() { return mLayoutParamsObject; |