Repository: flex-asjs
Updated Branches:
  refs/heads/develop 54f07e2f2 -> a43fac345


Update documentation in File related classes - Network module


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

Branch: refs/heads/develop
Commit: a43fac3457c992ceefcfdae7a6400d0ba883143c
Parents: 54f07e2
Author: piotrz <pio...@apache.org>
Authored: Sun Jul 16 13:33:45 2017 +0200
Committer: piotrz <pio...@apache.org>
Committed: Sun Jul 16 13:33:45 2017 +0200

----------------------------------------------------------------------
 .../main/flex/org/apache/flex/file/FileProxy.as |   2 +-
 .../flex/file/beads/FileBrowserWithFilter.as    |   7 +-
 .../org/apache/flex/file/beads/FileModel.as     |  17 ++-
 .../org/apache/flex/file/beads/FileUploader.as  |   1 -
 .../flex/org/apache/flex/net/BinaryUploader.as  |   7 +-
 .../flex/net/beads/CORSCredentialsBead.as       | 133 +++++++++++--------
 6 files changed, 101 insertions(+), 66 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/a43fac34/frameworks/projects/Network/src/main/flex/org/apache/flex/file/FileProxy.as
----------------------------------------------------------------------
diff --git 
a/frameworks/projects/Network/src/main/flex/org/apache/flex/file/FileProxy.as 
b/frameworks/projects/Network/src/main/flex/org/apache/flex/file/FileProxy.as
index f71ce67..552e28a 100644
--- 
a/frameworks/projects/Network/src/main/flex/org/apache/flex/file/FileProxy.as
+++ 
b/frameworks/projects/Network/src/main/flex/org/apache/flex/file/FileProxy.as
@@ -64,7 +64,7 @@ package org.apache.flex.file
                }
 
                /**
-                *  @copy org.apache.flex.core.IAlertModel#lastModified
+                *  @copy org.apache.flex.file.IFileModel#lastModified
                 */
                public function get lastModified():uint
                {

http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/a43fac34/frameworks/projects/Network/src/main/flex/org/apache/flex/file/beads/FileBrowserWithFilter.as
----------------------------------------------------------------------
diff --git 
a/frameworks/projects/Network/src/main/flex/org/apache/flex/file/beads/FileBrowserWithFilter.as
 
b/frameworks/projects/Network/src/main/flex/org/apache/flex/file/beads/FileBrowserWithFilter.as
index f66ea32..5f725c9 100644
--- 
a/frameworks/projects/Network/src/main/flex/org/apache/flex/file/beads/FileBrowserWithFilter.as
+++ 
b/frameworks/projects/Network/src/main/flex/org/apache/flex/file/beads/FileBrowserWithFilter.as
@@ -37,11 +37,14 @@ package org.apache.flex.file.beads
                public var filter:String = "";
                
                /**
-                * 
                 *  @copy org.apache.flex.file.beads.FileBrowser#browse()
                 *  @flexjsignorecoercion HTMLInputElement
+                *
+                *  @langversion 3.0
+         *  @playerversion Flash 10.2
+         *  @playerversion AIR 2.6
+         *  @productversion FlexJS 0.9
                 */
-
                override public function browse():void
                {
                        COMPILE::JS

http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/a43fac34/frameworks/projects/Network/src/main/flex/org/apache/flex/file/beads/FileModel.as
----------------------------------------------------------------------
diff --git 
a/frameworks/projects/Network/src/main/flex/org/apache/flex/file/beads/FileModel.as
 
b/frameworks/projects/Network/src/main/flex/org/apache/flex/file/beads/FileModel.as
index 9d65c75..310ac8e 100644
--- 
a/frameworks/projects/Network/src/main/flex/org/apache/flex/file/beads/FileModel.as
+++ 
b/frameworks/projects/Network/src/main/flex/org/apache/flex/file/beads/FileModel.as
@@ -101,7 +101,7 @@ package org.apache.flex.file.beads
                }
                
                /**
-                *  @copy org.apache.flex.core.IAlertModel#lastModified
+                *  @copy org.apache.flex.file.IFileModel#lastModified
                 */
                public function get lastModified():uint
                {
@@ -133,14 +133,25 @@ package org.apache.flex.file.beads
                }
                
                /**
-                * @private
+                *
+                *  @langversion 3.0
+                *  @playerversion Flash 10.2
+                *  @playerversion AIR 2.6
+                *  @productversion FlexJS 0.9
                 */
                COMPILE::JS
                public function get file():File
                {
                        return _data as File;
                }
-               
+
+        /**
+         *
+         *  @langversion 3.0
+         *  @playerversion Flash 10.2
+         *  @playerversion AIR 2.6
+         *  @productversion FlexJS 0.9
+         */
                public function get blob():BinaryData
                {
                        return _blob;

http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/a43fac34/frameworks/projects/Network/src/main/flex/org/apache/flex/file/beads/FileUploader.as
----------------------------------------------------------------------
diff --git 
a/frameworks/projects/Network/src/main/flex/org/apache/flex/file/beads/FileUploader.as
 
b/frameworks/projects/Network/src/main/flex/org/apache/flex/file/beads/FileUploader.as
index 194a1d6..bb9b44a 100644
--- 
a/frameworks/projects/Network/src/main/flex/org/apache/flex/file/beads/FileUploader.as
+++ 
b/frameworks/projects/Network/src/main/flex/org/apache/flex/file/beads/FileUploader.as
@@ -61,7 +61,6 @@ package org.apache.flex.file.beads
        public class FileUploader implements IBead
        {
                private var _strand:IStrand;
-
                
                /**
                 *  Upload a file to the specified url.

http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/a43fac34/frameworks/projects/Network/src/main/flex/org/apache/flex/net/BinaryUploader.as
----------------------------------------------------------------------
diff --git 
a/frameworks/projects/Network/src/main/flex/org/apache/flex/net/BinaryUploader.as
 
b/frameworks/projects/Network/src/main/flex/org/apache/flex/net/BinaryUploader.as
index b5f660c..3adad2a 100644
--- 
a/frameworks/projects/Network/src/main/flex/org/apache/flex/net/BinaryUploader.as
+++ 
b/frameworks/projects/Network/src/main/flex/org/apache/flex/net/BinaryUploader.as
@@ -99,7 +99,12 @@ package org.apache.flex.net
        public class BinaryUploader extends HTTPServiceBase implements IStrand, 
IBead
        {
                /**
-                * @flexjsignorecoercion org.apache.flex.core.WrappedHTMLElement
+                *  @flexjsignorecoercion 
org.apache.flex.core.WrappedHTMLElement
+         *
+         *  @langversion 3.0
+         *  @playerversion Flash 10.2
+         *  @playerversion AIR 2.6
+         *  @productversion FlexJS 0.0
                 */
                public function BinaryUploader()
                {

http://git-wip-us.apache.org/repos/asf/flex-asjs/blob/a43fac34/frameworks/projects/Network/src/main/flex/org/apache/flex/net/beads/CORSCredentialsBead.as
----------------------------------------------------------------------
diff --git 
a/frameworks/projects/Network/src/main/flex/org/apache/flex/net/beads/CORSCredentialsBead.as
 
b/frameworks/projects/Network/src/main/flex/org/apache/flex/net/beads/CORSCredentialsBead.as
index 08d5a3a..dd71f9a 100644
--- 
a/frameworks/projects/Network/src/main/flex/org/apache/flex/net/beads/CORSCredentialsBead.as
+++ 
b/frameworks/projects/Network/src/main/flex/org/apache/flex/net/beads/CORSCredentialsBead.as
@@ -23,74 +23,91 @@ import org.apache.flex.core.IStrand;
 import org.apache.flex.events.Event;
 import org.apache.flex.events.IEventDispatcher;
 
-COMPILE::SWF
-public class CORSCredentialsBead {
-    public function CORSCredentialsBead(withCredentials:Boolean = false) {
-        trace("Only needed for JavaScript HTTP Server calls");
+    COMPILE::SWF
+    public class CORSCredentialsBead {
+        public function CORSCredentialsBead(withCredentials:Boolean = false) {
+            trace("Only needed for JavaScript HTTP Server calls");
+        }
     }
-}
-
-/**
- *  Bead to allow passing on user authentication information in a 
XMLHttpRequest request.
- *
- *  If you don't use this bead any cross domain calls that require user 
authentication
- *  (via say basic authentication or cookies) will fail.
- *
- *  @productversion FlexJS 0.8
- */
-COMPILE::JS
-public class CORSCredentialsBead implements IBead {
-
-    public function CORSCredentialsBead(withCredentials:Boolean = false) {
-        this.withCredentials = withCredentials;
-    }
-
-    private var _strand:IStrand;
 
     /**
-     *  Listen for a pre and post send event to modify if user credentials are 
passed.
+     *  Bead to allow passing on user authentication information in a 
XMLHttpRequest request.
+     *
+     *  If you don't use this bead any cross domain calls that require user 
authentication
+     *  (via say basic authentication or cookies) will fail.
      *
-     *  @productversion FlexJS 0.8
+     *  @langversion 3.0
+     *  @playerversion Flash 10.2
+     *  @playerversion AIR 2.6
+     *  @productversion FlexJS 0.9
      */
-    public function set strand(value:IStrand):void {
-        _strand = value;
+    COMPILE::JS
+    public class CORSCredentialsBead implements IBead {
 
-        IEventDispatcher(_strand).addEventListener("preSend", preSendHandler);
-        IEventDispatcher(_strand).addEventListener("postSend", 
postSendHandler);
-    }
+        public function CORSCredentialsBead(withCredentials:Boolean = false) {
+            this.withCredentials = withCredentials;
+        }
 
-    /**
-     *  Modify the HTTP request to pass credentials.
-     *
-     *  @productversion FlexJS 0.8
-     */
-    protected function preSendHandler(event:Event):void {
-        (event.target.element as XMLHttpRequest).withCredentials = 
withCredentials;
-    }
+        private var _strand:IStrand;
 
-    /**
-     *  Clean up event listeners.
-     *
-     *  @productversion FlexJS 0.8
-     */
-    protected function postSendHandler(event:Event):void {
-        IEventDispatcher(_strand).removeEventListener("preSend", 
preSendHandler);
-        IEventDispatcher(_strand).removeEventListener("postSend", 
preSendHandler);
-    }
+        /**
+         *  Listen for a pre and post send event to modify if user credentials 
are passed.
+         *
+         *  @copy org.apache.flex.core.IBead#strand
+         *
+         *  @langversion 3.0
+         *  @playerversion Flash 10.2
+         *  @playerversion AIR 2.6
+         *  @productversion FlexJS 0.8
+         */
+        public function set strand(value:IStrand):void {
+            _strand = value;
 
-    private var _withCredentials:Boolean = false;
+            IEventDispatcher(_strand).addEventListener("preSend", 
preSendHandler);
+            IEventDispatcher(_strand).addEventListener("postSend", 
postSendHandler);
+        }
 
-    /**
-     *  Pass the user credentials or not.
-     *
-     *  @productversion FlexJS 0.8
-     */
-    public function get withCredentials():Boolean {
-        return _withCredentials;
-    }
+        /**
+         *  Modify the HTTP request to pass credentials.
+         *
+         *  @langversion 3.0
+         *  @playerversion Flash 10.2
+         *  @playerversion AIR 2.6
+         *  @productversion FlexJS 0.8
+         */
+        protected function preSendHandler(event:Event):void {
+            (event.target.element as XMLHttpRequest).withCredentials = 
withCredentials;
+        }
+
+        /**
+         *  Clean up event listeners.
+         *
+         *  @langversion 3.0
+         *  @playerversion Flash 10.2
+         *  @playerversion AIR 2.6
+         *  @productversion FlexJS 0.8
+         */
+        protected function postSendHandler(event:Event):void {
+            IEventDispatcher(_strand).removeEventListener("preSend", 
preSendHandler);
+            IEventDispatcher(_strand).removeEventListener("postSend", 
preSendHandler);
+        }
+
+        private var _withCredentials:Boolean = false;
 
-    public function set withCredentials(value:Boolean):void {
-        _withCredentials = value;
+        /**
+         *  Pass the user credentials or not.
+         *
+         *  @langversion 3.0
+         *  @playerversion Flash 10.2
+         *  @playerversion AIR 2.6
+         *  @productversion FlexJS 0.8
+         */
+        public function get withCredentials():Boolean {
+            return _withCredentials;
+        }
+
+        public function set withCredentials(value:Boolean):void {
+            _withCredentials = value;
+        }
     }
 }
-}

Reply via email to