ASDoc changes.
Project: http://git-wip-us.apache.org/repos/asf/flex-asjs/repo Commit: http://git-wip-us.apache.org/repos/asf/flex-asjs/commit/e494d4bd Tree: http://git-wip-us.apache.org/repos/asf/flex-asjs/tree/e494d4bd Diff: http://git-wip-us.apache.org/repos/asf/flex-asjs/diff/e494d4bd Branch: refs/heads/master Commit: e494d4bda7a6953fc112cfece2edccac5ae075cb Parents: bf6d772 Author: Peter Ent <[email protected]> Authored: Mon Oct 5 12:01:05 2015 -0400 Committer: Peter Ent <[email protected]> Committed: Mon Oct 5 12:01:05 2015 -0400 ---------------------------------------------------------------------- .../src/org/apache/flex/binding/ChainBinding.as | 4 +--- .../flex/binding/ApplicationDataBinding.as | 6 ++++- .../apache/flex/binding/ContainerDataBinding.as | 4 +++- .../as/src/org/apache/flex/core/Application.as | 6 +++-- .../as/src/org/apache/flex/core/IViewport.as | 25 ++++++++++++++++++++ .../as/src/org/apache/flex/html/Container.as | 16 +++++++++---- .../HTML/as/src/org/apache/flex/html/Panel.as | 7 ++++-- 7 files changed, 54 insertions(+), 14 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/e494d4bd/frameworks/projects/Binding/as/src/org/apache/flex/binding/ChainBinding.as ---------------------------------------------------------------------- diff --git a/frameworks/projects/Binding/as/src/org/apache/flex/binding/ChainBinding.as b/frameworks/projects/Binding/as/src/org/apache/flex/binding/ChainBinding.as index 207246a..076a231 100644 --- a/frameworks/projects/Binding/as/src/org/apache/flex/binding/ChainBinding.as +++ b/frameworks/projects/Binding/as/src/org/apache/flex/binding/ChainBinding.as @@ -27,9 +27,7 @@ package org.apache.flex.binding import org.apache.flex.events.ValueChangeEvent; /** - * The SimpleBinding class is lightweight data-binding class that - * is optimized for simple assignments of one object's property to - * another object's property. + * The ChainBinding class is used to track changes of nested properties. * * @langversion 3.0 * @playerversion Flash 10.2 http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/e494d4bd/frameworks/projects/Binding/asjs/src/org/apache/flex/binding/ApplicationDataBinding.as ---------------------------------------------------------------------- diff --git a/frameworks/projects/Binding/asjs/src/org/apache/flex/binding/ApplicationDataBinding.as b/frameworks/projects/Binding/asjs/src/org/apache/flex/binding/ApplicationDataBinding.as index 4038645..8d794b9 100644 --- a/frameworks/projects/Binding/asjs/src/org/apache/flex/binding/ApplicationDataBinding.as +++ b/frameworks/projects/Binding/asjs/src/org/apache/flex/binding/ApplicationDataBinding.as @@ -31,7 +31,11 @@ package org.apache.flex.binding /** * The ApplicationDataBinding class implements databinding for - * Application instances. Different classes can have + * Application instances. When you want to use databinding within + * the MXML file that has Application as its root tag, include + * the ApplicationDataBinding tag as well. + * + * Different classes can have * different databinding implementation that optimize for * the different lifecycles. For example, an item renderer * databinding implementation can wait to execute databindings http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/e494d4bd/frameworks/projects/Binding/asjs/src/org/apache/flex/binding/ContainerDataBinding.as ---------------------------------------------------------------------- diff --git a/frameworks/projects/Binding/asjs/src/org/apache/flex/binding/ContainerDataBinding.as b/frameworks/projects/Binding/asjs/src/org/apache/flex/binding/ContainerDataBinding.as index d138d60..42c5178 100644 --- a/frameworks/projects/Binding/asjs/src/org/apache/flex/binding/ContainerDataBinding.as +++ b/frameworks/projects/Binding/asjs/src/org/apache/flex/binding/ContainerDataBinding.as @@ -32,7 +32,9 @@ package org.apache.flex.binding /** * The ContainerDataBinding class implements databinding for - * Container instances. Different classes can have + * Container instances. Place a ContainerDataBinding tag into + * the MXML file that has Container as its root tag. + * Different classes can have * different databinding implementation that optimize for * the different lifecycles. For example, an item renderer * databinding implementation can wait to execute databindings http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/e494d4bd/frameworks/projects/Core/as/src/org/apache/flex/core/Application.as ---------------------------------------------------------------------- diff --git a/frameworks/projects/Core/as/src/org/apache/flex/core/Application.as b/frameworks/projects/Core/as/src/org/apache/flex/core/Application.as index fbcf83b..f3c6205 100644 --- a/frameworks/projects/Core/as/src/org/apache/flex/core/Application.as +++ b/frameworks/projects/Core/as/src/org/apache/flex/core/Application.as @@ -66,7 +66,8 @@ package org.apache.flex.core /** * Dispatched at startup after the initial view has been - * put on the display list. + * put on the display list. This event is sent before + * applicationComplete is dispatched. * * @langversion 3.0 * @playerversion Flash 10.2 @@ -90,10 +91,11 @@ package org.apache.flex.core * The Application class is the main class and entry point for a FlexJS * application. This Application class is different than the * Flex SDK's mx:Application or spark:Application in that it does not contain - * user interface elements. Those UI elements go in the views. This + * user interface elements. Those UI elements go in the views (ViewBase). This * Application class expects there to be a main model, a controller, and * an initial view. * + * @see ViewBase * @langversion 3.0 * @playerversion Flash 10.2 * @playerversion AIR 2.6 http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/e494d4bd/frameworks/projects/Core/as/src/org/apache/flex/core/IViewport.as ---------------------------------------------------------------------- diff --git a/frameworks/projects/Core/as/src/org/apache/flex/core/IViewport.as b/frameworks/projects/Core/as/src/org/apache/flex/core/IViewport.as index b66b74d..d84addc 100644 --- a/frameworks/projects/Core/as/src/org/apache/flex/core/IViewport.as +++ b/frameworks/projects/Core/as/src/org/apache/flex/core/IViewport.as @@ -23,11 +23,21 @@ package org.apache.flex.core /** * A Viewport is the area of a Container set aside for displaying * content and any scrolling controls. + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 */ public interface IViewport extends IBead { /** * Get the actual parent of the container's content. + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 */ function get contentView():IUIBase; @@ -35,6 +45,11 @@ package org.apache.flex.core * Sets the upper left position of the viewport * @param x The left position. * @param y The top position. + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 */ function setPosition(x:Number, y:Number):void; @@ -42,6 +57,11 @@ package org.apache.flex.core * Size the content area based on any visible scrolling controls and * the given width and height. If width and/or height is NaN * then that dimension is being sized to content. + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 */ function layoutViewportBeforeContentLayout(width:Number, height:Number):void; @@ -51,6 +71,11 @@ package org.apache.flex.core * content area size appropriately, and display any scrolling controls * before returning the resulting size of the viewport (which means the * area used up by both content area and scrolling controls). + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 */ function layoutViewportAfterContentLayout():Size; http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/e494d4bd/frameworks/projects/HTML/as/src/org/apache/flex/html/Container.as ---------------------------------------------------------------------- diff --git a/frameworks/projects/HTML/as/src/org/apache/flex/html/Container.as b/frameworks/projects/HTML/as/src/org/apache/flex/html/Container.as index fb9b867..ce6957c 100644 --- a/frameworks/projects/HTML/as/src/org/apache/flex/html/Container.as +++ b/frameworks/projects/HTML/as/src/org/apache/flex/html/Container.as @@ -30,12 +30,16 @@ package org.apache.flex.html [DefaultProperty("mxmlContent")] /** - * The Container class implements a basic container of + * The Container class implements a basic container for * other controls and containers. The position and size - * of the children are determined by a layout or by - * absolute positioning and sizing. This Container does - * not have a built-in scrollbar or clipping of content - * exceeds its boundaries. + * of the children are determined by a layout while the size of + * a Container can either be determined by its children or by + * specifying an exact size in pixels or as a percentage of the + * parent element. + * + * This Container does not have a built-in scroll bar or clipping of + * its content should the content exceed the Container's boundaries. To + * have scroll bars and clipping, add the ScrollingView bead. * * While the container is relatively lightweight, it should * generally not be used as the base class for other controls, @@ -53,6 +57,8 @@ package org.apache.flex.html * control and not a Container because the Alert does not * support an arbitrary set of children. * + * @see org.apache.flex.html.beads.layout + * @see org.apache.flex.html.supportClasses.ScrollingViewport * @langversion 3.0 * @playerversion Flash 10.2 * @playerversion AIR 2.6 http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/e494d4bd/frameworks/projects/HTML/as/src/org/apache/flex/html/Panel.as ---------------------------------------------------------------------- diff --git a/frameworks/projects/HTML/as/src/org/apache/flex/html/Panel.as b/frameworks/projects/HTML/as/src/org/apache/flex/html/Panel.as index a1fc87e..6219d9d 100644 --- a/frameworks/projects/HTML/as/src/org/apache/flex/html/Panel.as +++ b/frameworks/projects/HTML/as/src/org/apache/flex/html/Panel.as @@ -25,8 +25,8 @@ package org.apache.flex.html /** * The Panel class is a Container component capable of parenting other * components. The Panel has a TitleBar. If you want to a Panel with - * a ControlBar, use org.apache.flex.hmlt.PanelWithControlBar which - * will instantiate, by default, an org.apache.flex.html.ControlBar. + * a ControlBar, use PanelWithControlBar which + * will instantiate, by default, an ControlBar. * The Panel uses the following bead types: * * org.apache.flex.core.IBeadModel: the data model for the Panel that includes the title and whether @@ -35,6 +35,9 @@ package org.apache.flex.html * org.apache.flex.core.IBorderBead: if present, draws a border around the Panel. * org.apache.flex.core.IBackgroundBead: if present, provides a colored background for the Panel. * + * @see PanelWithControlBar + * @see ControlBar + * @see TitleBar * @langversion 3.0 * @playerversion Flash 10.2 * @playerversion AIR 2.6
