Updated Branches: refs/heads/develop 90f745132 -> e9f593f37
add asdoc to mx shim classes Project: http://git-wip-us.apache.org/repos/asf/flex-asjs/repo Commit: http://git-wip-us.apache.org/repos/asf/flex-asjs/commit/c0f66e22 Tree: http://git-wip-us.apache.org/repos/asf/flex-asjs/tree/c0f66e22 Diff: http://git-wip-us.apache.org/repos/asf/flex-asjs/diff/c0f66e22 Branch: refs/heads/develop Commit: c0f66e221ad3fe55a7079df54dd4a5d1e5f81ec0 Parents: 90f7451 Author: Alex Harui <aha...@apache.org> Authored: Thu Feb 6 09:11:57 2014 -0800 Committer: Alex Harui <aha...@apache.org> Committed: Thu Feb 6 11:03:55 2014 -0800 ---------------------------------------------------------------------- .../FlexJSUI/src/mx/core/ClassFactory.as | 43 ++++++++++++++++++++ .../projects/FlexJSUI/src/mx/core/IFactory.as | 21 ++++++++++ .../projects/FlexJSUI/src/mx/states/AddItems.as | 21 ++++++++++ .../FlexJSUI/src/mx/states/SetProperty.as | 21 ++++++++++ .../as/projects/FlexJSUI/src/mx/states/State.as | 38 +++++++++++++++++ 5 files changed, 144 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/c0f66e22/frameworks/as/projects/FlexJSUI/src/mx/core/ClassFactory.as ---------------------------------------------------------------------- diff --git a/frameworks/as/projects/FlexJSUI/src/mx/core/ClassFactory.as b/frameworks/as/projects/FlexJSUI/src/mx/core/ClassFactory.as index 7287a7a..a29773d 100644 --- a/frameworks/as/projects/FlexJSUI/src/mx/core/ClassFactory.as +++ b/frameworks/as/projects/FlexJSUI/src/mx/core/ClassFactory.as @@ -20,16 +20,59 @@ package mx.core { import mx.core.IFactory; + /** + * The ClassFactory class is the basic implementation + * of an IFactory that will generate multiple + * instances of item renderers or custom classes. + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ public class ClassFactory implements IFactory { + /** + * The class to instantiate. + * + * @langversion 3.0 + * @playerversion Flash 9 + * @playerversion AIR 1.1 + * @productversion Flex 3 + */ public var generator:Class; + + /** + * Initial properties assigned to each instance. + * + * @langversion 3.0 + * @playerversion Flash 9 + * @playerversion AIR 1.1 + * @productversion Flex 3 + */ public var properties:Object; + /** + * Constructor. + * + * @langversion 3.0 + * @playerversion Flash 9 + * @playerversion AIR 1.1 + * @productversion Flex 3 + */ public function ClassFactory(generator:Class=null) { this.generator = generator; } + /** + * @copy mx.core.IFactory#newInstance + * + * @langversion 3.0 + * @playerversion Flash 9 + * @playerversion AIR 1.1 + * @productversion Flex 3 + */ public function newInstance():* { var obj:* = new generator(); http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/c0f66e22/frameworks/as/projects/FlexJSUI/src/mx/core/IFactory.as ---------------------------------------------------------------------- diff --git a/frameworks/as/projects/FlexJSUI/src/mx/core/IFactory.as b/frameworks/as/projects/FlexJSUI/src/mx/core/IFactory.as index 492a530..aaac8e3 100644 --- a/frameworks/as/projects/FlexJSUI/src/mx/core/IFactory.as +++ b/frameworks/as/projects/FlexJSUI/src/mx/core/IFactory.as @@ -18,8 +18,29 @@ //////////////////////////////////////////////////////////////////////////////// package mx.core { + /** + * The IFactory interface is the basic interface used as the + * type for properties that specify a factory for item renderers + * and other scenarios where multiple copies of a custom + * class are generated. + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ public interface IFactory { + /** + * This method is called to generate a new instance of + * an item renderer or other custom class. + * + * @return A new instance of an item renderer or other custom class. + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ function newInstance():*; } } \ No newline at end of file http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/c0f66e22/frameworks/as/projects/FlexJSUI/src/mx/states/AddItems.as ---------------------------------------------------------------------- diff --git a/frameworks/as/projects/FlexJSUI/src/mx/states/AddItems.as b/frameworks/as/projects/FlexJSUI/src/mx/states/AddItems.as index a2821a4..393f65d 100644 --- a/frameworks/as/projects/FlexJSUI/src/mx/states/AddItems.as +++ b/frameworks/as/projects/FlexJSUI/src/mx/states/AddItems.as @@ -24,8 +24,29 @@ package mx.states { import org.apache.flex.core.IDocument; + [ExcludeClass] + + /** + * The AddItems class is one of the classes in the + * view states subsystem. Note that the FlexJS + * versions are simply data structures interpreted + * by a central States implementation. + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ public class AddItems implements IDocument { + /** + * Constructor. + * + * @langversion 3.0 + * @playerversion Flash 9 + * @playerversion AIR 1.1 + * @productversion Flex 3 + */ public function AddItems() { super(); http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/c0f66e22/frameworks/as/projects/FlexJSUI/src/mx/states/SetProperty.as ---------------------------------------------------------------------- diff --git a/frameworks/as/projects/FlexJSUI/src/mx/states/SetProperty.as b/frameworks/as/projects/FlexJSUI/src/mx/states/SetProperty.as index 78e0a73..595f84a 100644 --- a/frameworks/as/projects/FlexJSUI/src/mx/states/SetProperty.as +++ b/frameworks/as/projects/FlexJSUI/src/mx/states/SetProperty.as @@ -21,8 +21,29 @@ package mx.states { import org.apache.flex.core.IDocument; + [ExcludeClass] + + /** + * The SetProperty class is one of the classes in the + * view states subsystem. Note that the FlexJS + * versions are simply data structures interpreted + * by a central States implementation. + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ public class SetProperty implements IDocument { + /** + * Constructor. + * + * @langversion 3.0 + * @playerversion Flash 9 + * @playerversion AIR 1.1 + * @productversion Flex 3 + */ public function SetProperty() { super(); http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/c0f66e22/frameworks/as/projects/FlexJSUI/src/mx/states/State.as ---------------------------------------------------------------------- diff --git a/frameworks/as/projects/FlexJSUI/src/mx/states/State.as b/frameworks/as/projects/FlexJSUI/src/mx/states/State.as index 3a38d54..b603f83 100644 --- a/frameworks/as/projects/FlexJSUI/src/mx/states/State.as +++ b/frameworks/as/projects/FlexJSUI/src/mx/states/State.as @@ -20,15 +20,53 @@ // shim the mx classes for states package mx.states { + /** + * The State class is one of the classes in the + * view states subsystem. It is used to declare a + * view state in an MXML document. This is one of the + * few classes in FlexJS that use the same name as + * a Flex SDK class because some of the IDEs and + * compilers are hard-coded to assume this name. + * + * @langversion 3.0 + * @playerversion Flash 10.2 + * @playerversion AIR 2.6 + * @productversion FlexJS 0.0 + */ public class State { + /** + * Constructor. + * + * @param properties This parameter is not used in FlexJS and exists to make legacy compilers happy. + * @langversion 3.0 + * @playerversion Flash 9 + * @playerversion AIR 1.1 + * @productversion Flex 3 + */ public function State(properties:Object = null) { super(); } + /** + * The name of the state. + * + * @langversion 3.0 + * @playerversion Flash 9 + * @playerversion AIR 1.1 + * @productversion Flex 3 + */ public var name:String; + /** + * The array of overrides. This is normally set by the compiler. + * + * @langversion 3.0 + * @playerversion Flash 9 + * @playerversion AIR 1.1 + * @productversion Flex 3 + */ public var overrides:Array; } } \ No newline at end of file
