Documentation and README updates

unoduetre · Dec 10, 2010 · d43ef14 · d43ef14
1 parent 7229579
commit d43ef14
Show file tree

Hide file tree

Showing 5 changed files with 48 additions and 4 deletions.
diff --git 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
@@ -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
@@ -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
@@ -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
@@ -1,4 +1,7 @@
 Uploader Utility - Release Notes
 
+3.3.0
+    Minor changes in documentation
+
 3.2.0
 	Initial release