jquery core: commenting the new access function.
authorAriel Flesler <aflesler@gmail.com>
Fri, 11 Sep 2009 17:47:40 +0000 (17:47 +0000)
committerAriel Flesler <aflesler@gmail.com>
Fri, 11 Sep 2009 17:47:40 +0000 (17:47 +0000)
src/core.js

index b1dde53..aeae874 100644 (file)
@@ -553,9 +553,12 @@ function evalScript( i, elem ) {
        }
 }
 
+// Mutifunctional method to get and set values to a collection
+// The value/s can be optionally by executed if its a function
 function access( elems, key, value, exec, fn ) {
        var l = elems.length;
        
+       // Setting many attributes
        if ( typeof key === "object" ) {
                        for (var k in key) {
                                access(elems, k, key[k], exec, fn);
@@ -563,7 +566,9 @@ function access( elems, key, value, exec, fn ) {
                return elems;
        }
        
+       // Setting one attribute
        if (value !== undefined) {
+               // Optionally, function values get executed if exec is true
                exec = exec && jQuery.isFunction(value);
                
                for (var i = 0; i < l; i++) {
@@ -574,6 +579,7 @@ function access( elems, key, value, exec, fn ) {
                return elems;
        }
        
+       // Getting an attribute
        return l ? fn(elems[0], key) : null;
 }