flex-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From aha...@apache.org
Subject git commit: [flex-asjs] [refs/heads/develop] - more asdoc. Next up, net and utils folders
Date Mon, 03 Feb 2014 08:06:29 GMT
Updated Branches:
  refs/heads/develop 89c12f705 -> 709d4d313


more asdoc.  Next up, net and utils folders


Project: http://git-wip-us.apache.org/repos/asf/flex-asjs/repo
Commit: http://git-wip-us.apache.org/repos/asf/flex-asjs/commit/709d4d31
Tree: http://git-wip-us.apache.org/repos/asf/flex-asjs/tree/709d4d31
Diff: http://git-wip-us.apache.org/repos/asf/flex-asjs/diff/709d4d31

Branch: refs/heads/develop
Commit: 709d4d3134bdf340185f79f55390cd601a2b066b
Parents: 89c12f7
Author: Alex Harui <aharui@apache.org>
Authored: Mon Feb 3 00:05:51 2014 -0800
Committer: Alex Harui <aharui@apache.org>
Committed: Mon Feb 3 00:05:51 2014 -0800

----------------------------------------------------------------------
 .../src/org/apache/flex/data/ICollection.as     | 18 +++++
 .../org/apache/flex/data/IStringCollection.as   | 18 +++++
 .../src/org/apache/flex/events/CustomEvent.as   | 22 ++++--
 .../src/org/apache/flex/events/Event.as         | 17 +++++
 .../org/apache/flex/events/EventDispatcher.as   | 13 ++++
 .../org/apache/flex/events/IEventDispatcher.as  |  5 ++
 .../org/apache/flex/events/ValueChangeEvent.as  | 76 ++++++++++++++++++++
 7 files changed, 165 insertions(+), 4 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/709d4d31/frameworks/as/projects/FlexJSUI/src/org/apache/flex/data/ICollection.as
----------------------------------------------------------------------
diff --git a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/data/ICollection.as b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/data/ICollection.as
index b1d706f..7bab12b 100644
--- a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/data/ICollection.as
+++ b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/data/ICollection.as
@@ -18,8 +18,26 @@
 ////////////////////////////////////////////////////////////////////////////////
 package org.apache.flex.data
 {
+    /**
+     *  The ICollection interface is the basic interface for an iterable collection
+     *  of data items.  Other extension may offer the ability to modify the collection
+     *  and dispatch change events.
+     *  
+     *  @langversion 3.0
+     *  @playerversion Flash 10.2
+     *  @playerversion AIR 2.6
+     *  @productversion FlexJS 0.0
+     */
 	public interface ICollection
 	{
+        /**
+         *  Get the item at a particular index.
+         *  
+         *  @langversion 3.0
+         *  @playerversion Flash 10.2
+         *  @playerversion AIR 2.6
+         *  @productversion FlexJS 0.0
+         */
 		function getItemAt(index:int):Object
 	}
 }
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/709d4d31/frameworks/as/projects/FlexJSUI/src/org/apache/flex/data/IStringCollection.as
----------------------------------------------------------------------
diff --git a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/data/IStringCollection.as
b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/data/IStringCollection.as
index b978a58..af60b68 100644
--- a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/data/IStringCollection.as
+++ b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/data/IStringCollection.as
@@ -18,8 +18,26 @@
 ////////////////////////////////////////////////////////////////////////////////
 package org.apache.flex.data
 {
+    /**
+     *  The IStringCollection interface is the basic interface for an iterable collection
+     *  of strings.  Other extension may offer the ability to modify the collection
+     *  and dispatch change events.
+     *  
+     *  @langversion 3.0
+     *  @playerversion Flash 10.2
+     *  @playerversion AIR 2.6
+     *  @productversion FlexJS 0.0
+     */
 	public interface IStringCollection
 	{
+        /**
+         *  Get the string at a particular index.
+         *  
+         *  @langversion 3.0
+         *  @playerversion Flash 10.2
+         *  @playerversion AIR 2.6
+         *  @productversion FlexJS 0.0
+         */
 		function getItemAt(index:int):String
 	}
 }
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/709d4d31/frameworks/as/projects/FlexJSUI/src/org/apache/flex/events/CustomEvent.as
----------------------------------------------------------------------
diff --git a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/events/CustomEvent.as b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/events/CustomEvent.as
index 0776e22..3165ea2 100644
--- a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/events/CustomEvent.as
+++ b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/events/CustomEvent.as
@@ -21,13 +21,27 @@ package org.apache.flex.events
 	/**
 	 *  MXML auto-imports flash.events.Event which then requires
 	 *  full qualification to use org.apache.flex.events.Event.
-	 *  Use CustomEvent to skip all that extra typing.  Eventually
-	 *  we should add a flag to strip out the default auto-imports.
-	 *  Like org.apache.flex.events.Event events on the JS side
-	 *  are DOMEvents and not really instances of this class
+	 *  Use CustomEvent to skip all that extra typing.
+     *  
+     *  @langversion 3.0
+     *  @playerversion Flash 10.2
+     *  @playerversion AIR 2.6
+     *  @productversion FlexJS 0.0
 	 */
 	public class CustomEvent extends Event
 	{
+        /**
+         *  Constructor.
+         *  
+         *  @param String type The name of the event.
+         *  @param Boolean bubbles Whether the event bubbles.
+         *  @param Boolean cancelable Whether the event can be canceled.
+         * 
+         *  @langversion 3.0
+         *  @playerversion Flash 10.2
+         *  @playerversion AIR 2.6
+         *  @productversion FlexJS 0.0
+         */
 		public function CustomEvent(type:String, bubbles:Boolean=false, cancelable:Boolean=false)
 		{
 			super(type, bubbles, cancelable);

http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/709d4d31/frameworks/as/projects/FlexJSUI/src/org/apache/flex/events/Event.as
----------------------------------------------------------------------
diff --git a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/events/Event.as b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/events/Event.as
index 91fd83a..f8c8157 100644
--- a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/events/Event.as
+++ b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/events/Event.as
@@ -27,9 +27,26 @@ package org.apache.flex.events
 	 *  that is dispatched.  In most cases we are dispatching
 	 *  DOMEvents instead, so as long as you don't actually
 	 *  check the typeof(event) it will work
+     *  
+     *  @langversion 3.0
+     *  @playerversion Flash 10.2
+     *  @playerversion AIR 2.6
+     *  @productversion FlexJS 0.0
 	 */
 	public class Event extends flash.events.Event
 	{
+        /**
+         *  Constructor.
+         *  
+         *  @param String type The name of the event.
+         *  @param Boolean bubbles Whether the event bubbles.
+         *  @param Boolean cancelable Whether the event can be canceled.
+         *  
+         *  @langversion 3.0
+         *  @playerversion Flash 10.2
+         *  @playerversion AIR 2.6
+         *  @productversion FlexJS 0.0
+         */
 		public function Event(type:String, bubbles:Boolean=false, cancelable:Boolean=false)
 		{
 			super(type, bubbles, cancelable);

http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/709d4d31/frameworks/as/projects/FlexJSUI/src/org/apache/flex/events/EventDispatcher.as
----------------------------------------------------------------------
diff --git a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/events/EventDispatcher.as
b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/events/EventDispatcher.as
index 64c6f87..357689d 100644
--- a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/events/EventDispatcher.as
+++ b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/events/EventDispatcher.as
@@ -23,9 +23,22 @@ package org.apache.flex.events
 	/**
 	 *  This class simply wraps flash.events.EventDispatcher so that
 	 *  no flash packages are needed on the JS side.
+     *  
+     *  @langversion 3.0
+     *  @playerversion Flash 10.2
+     *  @playerversion AIR 2.6
+     *  @productversion FlexJS 0.0
 	 */
 	public class EventDispatcher extends flash.events.EventDispatcher implements IEventDispatcher
 	{
+        /**
+         *  Constructor.
+         *  
+         *  @langversion 3.0
+         *  @playerversion Flash 10.2
+         *  @playerversion AIR 2.6
+         *  @productversion FlexJS 0.0
+         */
 		public function EventDispatcher()
 		{
 			super();

http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/709d4d31/frameworks/as/projects/FlexJSUI/src/org/apache/flex/events/IEventDispatcher.as
----------------------------------------------------------------------
diff --git a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/events/IEventDispatcher.as
b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/events/IEventDispatcher.as
index b838d23..a051942 100644
--- a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/events/IEventDispatcher.as
+++ b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/events/IEventDispatcher.as
@@ -23,6 +23,11 @@ package org.apache.flex.events
 	/**
 	 *  This class simply wraps flash.events.EventDispatcher so that
 	 *  no flash packages are needed on the JS side.
+     *  
+     *  @langversion 3.0
+     *  @playerversion Flash 10.2
+     *  @playerversion AIR 2.6
+     *  @productversion FlexJS 0.0
 	 */
 	public interface IEventDispatcher extends flash.events.IEventDispatcher
 	{

http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/709d4d31/frameworks/as/projects/FlexJSUI/src/org/apache/flex/events/ValueChangeEvent.as
----------------------------------------------------------------------
diff --git a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/events/ValueChangeEvent.as
b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/events/ValueChangeEvent.as
index 4a759f7..7bd2caf 100644
--- a/frameworks/as/projects/FlexJSUI/src/org/apache/flex/events/ValueChangeEvent.as
+++ b/frameworks/as/projects/FlexJSUI/src/org/apache/flex/events/ValueChangeEvent.as
@@ -18,8 +18,27 @@
 ////////////////////////////////////////////////////////////////////////////////
 package org.apache.flex.events
 {
+    
+    /**
+     *  The ValueChangeEvent class replaces the PropertyChangeEvent as
+     *  the default event for property changes used in the databinding
+     *  subsystem.
+     *  
+     *  @langversion 3.0
+     *  @playerversion Flash 10.2
+     *  @playerversion AIR 2.6
+     *  @productversion FlexJS 0.0
+     */
 	public class ValueChangeEvent extends Event
 	{
+        /**
+         *  Constructor.
+         *  
+         *  @langversion 3.0
+         *  @playerversion Flash 10.2
+         *  @playerversion AIR 2.6
+         *  @productversion FlexJS 0.0
+         */
 		public function ValueChangeEvent(type:String, bubbles:Boolean=false, cancelable:Boolean=false,

 										 oldValue:Object = null, newValue:Object = null)
 		{
@@ -28,13 +47,70 @@ package org.apache.flex.events
 			this.newValue = newValue;
 		}
 		
+        /**
+         *  The value of the property before it was changed.
+         *  
+         *  @langversion 3.0
+         *  @playerversion Flash 10.2
+         *  @playerversion AIR 2.6
+         *  @productversion FlexJS 0.0
+         */
 		public var oldValue:Object;
+
+        /**
+         *  The value of the property after it was changed.
+         *  
+         *  @langversion 3.0
+         *  @playerversion Flash 10.2
+         *  @playerversion AIR 2.6
+         *  @productversion FlexJS 0.0
+         */
 		public var newValue:Object;
+
+        /**
+         *  The name of the property.
+         *  
+         *  @langversion 3.0
+         *  @playerversion Flash 10.2
+         *  @playerversion AIR 2.6
+         *  @productversion FlexJS 0.0
+         */
         public var propertyName:String;
+
+        /**
+         *  The object that owns the property.
+         *  
+         *  @langversion 3.0
+         *  @playerversion Flash 10.2
+         *  @playerversion AIR 2.6
+         *  @productversion FlexJS 0.0
+         */
         public var source:Object;
 		
+        /**
+         *  The default event type.
+         *  
+         *  @langversion 3.0
+         *  @playerversion Flash 10.2
+         *  @playerversion AIR 2.6
+         *  @productversion FlexJS 0.0
+         */
 		public static const VALUE_CHANGE:String = "valueChange";
         
+        /**
+         *  A convenience method to create an instance of the ValueChangeEvent.
+         * 
+         *  @param Object source The source of the object.
+         *  @param String name The name of the event.
+         *  @param Object oldValue The value before it was changed.
+         *  @param Object newValue The value after it was changed.
+         *  @return An instance of the ValueChangeEvent.
+         *  
+         *  @langversion 3.0
+         *  @playerversion Flash 10.2
+         *  @playerversion AIR 2.6
+         *  @productversion FlexJS 0.0
+         */
         public static function createUpdateEvent(source:Object, name:String, oldValue:Object,
newValue:Object):ValueChangeEvent
         {
             var event:ValueChangeEvent = new ValueChangeEvent(VALUE_CHANGE, false, false,
oldValue, newValue);


Mime
View raw message