Changeset 11380

Timestamp:

11/04/07 10:07:03 (10 months ago)

Author:

alex

Message:

documentation updates. Refs #4820

Files:

• dojo/trunk/AdapterRegistry.js (modified) (4 diffs)

dojo/trunk/AdapterRegistry.js

@@ -2 +2 @@
 
 dojo.AdapterRegistry = function(/*Boolean?*/ returnWrappers){
-        // summary:
+        //      summary:
         //              A registry to make contextual calling/searching easier.
-        // description:
+        //      description:
         //              Objects of this class keep list of arrays in the form [name, check,
         //              wrap, directReturn] that are used to determine what the contextual
         //              result of a set of checked arguments is. All check/wrap functions
         //              in this registry should be of the same arity.
+        //      example:
+        //      |       // create a new registry
+        //      |       var reg = new dojo.AdapterRegistry();
+        //      |       reg.register("handleString",
+        //      |               dojo.isString,
+        //      |               function(str){
+        //      |                       // do something with the string here
+        //      |               }
+        //      |       );
+        //      |       reg.register("handleArr",
+        //      |               dojo.isArray,
+        //      |               function(arr){
+        //      |                       // do something with the array here
+        //      |               }
+        //      |       );
+        //      |
+        //      |       // now we can pass reg.match() *either* an array or a string and
+        //      |       // the value we pass will get handled by the right function
+        //      |       reg.match("someValue"); // will call the first function
+        //      |       reg.match(["someValue"]); // will call the second
+
         this.pairs = [];
         this.returnWrappers = returnWrappers || false; // Boolean
@@ -15 +36 @@
 dojo.extend(dojo.AdapterRegistry, {
         register: function(/*String*/ name, /*Function*/ check, /*Function*/ wrap, /*Boolean?*/ directReturn, /*Boolean?*/ override){
-                // summary: 
+                //      summary: 
                 //              register a check function to determine if the wrap function or
                 //              object gets selected
-                // name:
+                //      name:
                 //              a way to identify this matcher.
-                // check:
+                //      check:
                 //              a function that arguments are passed to from the adapter's
                 //              match() function.  The check function should return true if the
                 //              given arguments are appropriate for the wrap function.
-                // directReturn:
+                //      directReturn:
                 //              If directReturn is true, the value passed in for wrap will be
                 //              returned instead of being called. Alternately, the
@@ -31 +52 @@
                 //              the registry to act as a "search" function instead of a
                 //              function interception library.
-                // override:
+                //      override:
                 //              If override is given and true, the check function will be given
                 //              highest priority. Otherwise, it will be the lowest priority
@@ -39 +60 @@
 
         match: function(/* ... */){
-    // summary:
+                // summary:
                 //              Find an adapter for the given arguments. If no suitable adapter
                 //              is found, throws an exception. match() accepts any number of