From d43ef1450aa5765e6756c0b8dfc5a80acc9919a1 Mon Sep 17 00:00:00 2001 From: Allen Rabinovich Date: Fri, 10 Dec 2010 14:35:11 -0800 Subject: [PATCH] Documentation and README updates --- build/swfdetect/swfdetect-debug.js | 21 +++++++++++++++++++-- build/swfdetect/swfdetect.js | 21 +++++++++++++++++++-- src/swf/README | 4 ++++ src/swfdetect/README | 3 +++ src/uploader/README | 3 +++ 5 files changed, 48 insertions(+), 4 deletions(-) diff --git a/build/swfdetect/swfdetect-debug.js b/build/swfdetect/swfdetect-debug.js index dfdd6211c56..d2c3f53cb2f 100644 --- a/build/swfdetect/swfdetect-debug.js +++ b/build/swfdetect/swfdetect-debug.js @@ -63,11 +63,28 @@ else if(uA.ie) { } -Y.SWFDetect = { +Y.SWFDetect = { + + /** + * Returns the version of either the Flash Player plugin (in Mozilla/WebKit/Opera browsers), + * or the Flash Player ActiveX control (in IE), as a String of the form "MM.mm.rr", where + * MM is the major version, mm is the minor version, and rr is the revision. + * @method getFlashVersion + */ + getFlashVersion : function () { return (String(uA.flashMajor) + "." + String(uA.flashMinor) + "." + String(uA.flashRev)); }, - + + /** + * Checks whether the version of the Flash player installed on the user's machine is greater + * than or equal to the one specified. If it is, this method returns true; it is false otherwise. + * @method isFlashVersionAtLeast + * @return {Boolean} Whether the Flash player version is greater than or equal to the one specified. + * @param flashMajor {int} The Major version of the Flash player to compare against. + * @param flashMinor {int} The Minor version of the Flash player to compare against. + * @param flashRev {int} The Revision version of the Flash player to compare against. + */ isFlashVersionAtLeast : function (flashMajor, flashMinor, flashRev) { var uaMajor = makeInt(uA.flashMajor), uaMinor = makeInt(uA.flashMinor), diff --git a/build/swfdetect/swfdetect.js b/build/swfdetect/swfdetect.js index 8f4f413d93d..fd9dfd50e37 100644 --- a/build/swfdetect/swfdetect.js +++ b/build/swfdetect/swfdetect.js @@ -62,11 +62,28 @@ else if(uA.ie) { } -Y.SWFDetect = { +Y.SWFDetect = { + + /** + * Returns the version of either the Flash Player plugin (in Mozilla/WebKit/Opera browsers), + * or the Flash Player ActiveX control (in IE), as a String of the form "MM.mm.rr", where + * MM is the major version, mm is the minor version, and rr is the revision. + * @method getFlashVersion + */ + getFlashVersion : function () { return (String(uA.flashMajor) + "." + String(uA.flashMinor) + "." + String(uA.flashRev)); }, - + + /** + * Checks whether the version of the Flash player installed on the user's machine is greater + * than or equal to the one specified. If it is, this method returns true; it is false otherwise. + * @method isFlashVersionAtLeast + * @return {Boolean} Whether the Flash player version is greater than or equal to the one specified. + * @param flashMajor {int} The Major version of the Flash player to compare against. + * @param flashMinor {int} The Minor version of the Flash player to compare against. + * @param flashRev {int} The Revision version of the Flash player to compare against. + */ isFlashVersionAtLeast : function (flashMajor, flashMinor, flashRev) { var uaMajor = makeInt(uA.flashMajor), uaMinor = makeInt(uA.flashMinor), diff --git a/src/swf/README b/src/swf/README index cdc227837a7..c45f7037a8d 100644 --- a/src/swf/README +++ b/src/swf/README @@ -1,5 +1,9 @@ SWF Utility - Release Notes +3.3.0 + Fixed an undefined variable bug + Fixes to documentation + 3.2.0 Added allowedDomain flashvar to pass the security settings to YUIBridge. diff --git a/src/swfdetect/README b/src/swfdetect/README index dd5c905e83c..7afc6fb00ea 100644 --- a/src/swfdetect/README +++ b/src/swfdetect/README @@ -1,5 +1,8 @@ SWFDetect Utility - Release Notes +3.3.0 + Added API documentation + 3.2.0 Contribution by Ryan Cannon: #2529113 fixed logic in isFlashVersionAtLeast() to account for omitted minor and revision versions of the Flash player. diff --git a/src/uploader/README b/src/uploader/README index 67fc3eba497..86900f81897 100644 --- a/src/uploader/README +++ b/src/uploader/README @@ -1,4 +1,7 @@ Uploader Utility - Release Notes +3.3.0 + Minor changes in documentation + 3.2.0 Initial release \ No newline at end of file