Changeset 11339

Show
Ignore:
Timestamp:
11/02/07 07:57:19 (10 months ago)
Author:
pottedmeat
Message:

Refs #4820. Cleaning up documentation

Location:
dojo/trunk
Files:
4 modified

Legend:

Unmodified
Added
Removed
  • dojo/trunk/AdapterRegistry.js

    r8418 r11339  
    1010        //              in this registry should be of the same arity. 
    1111        this.pairs = []; 
    12         this.returnWrappers = returnWrappers || false; 
     12        this.returnWrappers = returnWrappers || false; // Boolean 
    1313} 
    1414 
    1515dojo.extend(dojo.AdapterRegistry, { 
    16         register: function(name, check, /*Function*/ wrap, directReturn, override){ 
     16        register: function(/*String*/ name, /*Function*/ check, /*Function*/ wrap, /*Boolean?*/ directReturn, /*Boolean?*/ override){ 
    1717                // summary:  
    1818                //              register a check function to determine if the wrap function or 
    1919                //              object gets selected 
    20                 // name: String 
     20                // name: 
    2121                //              a way to identify this matcher. 
    22                 // check: Function 
     22                // check: 
    2323                //              a function that arguments are passed to from the adapter's 
    2424                //              match() function.  The check function should return true if the 
    2525                //              given arguments are appropriate for the wrap function. 
    26                 // directReturn: Boolean? 
     26                // directReturn: 
    2727                //              If directReturn is true, the value passed in for wrap will be 
    2828                //              returned instead of being called. Alternately, the 
     
    3131                //              the registry to act as a "search" function instead of a 
    3232                //              function interception library. 
    33                 // override: Boolean? 
     33                // override: 
    3434                //              If override is given and true, the check function will be given 
    3535                //              highest priority. Otherwise, it will be the lowest priority 
  • dojo/trunk/DeferredList.js

    r11268 r11339  
    11dojo.provide("dojo.DeferredList"); 
    22dojo.declare("dojo.DeferredList", dojo.Deferred, { 
    3         // Summary: 
    4         //      DeferredList takes an array of existing deferreds and returns a new deferred of its own 
    5         //      this new deferred will typically have its callback fired when all of the deferreds in 
    6         //      the given list have fired their own deferreds.  The parameters `fireOnOneCallback` and 
    7         //      fireOnOneErrback, will fire before all the deferreds as appropriate 
    8         // 
    9         //      list: Array 
    10         //              The list of deferreds to be synchronizied with this DeferredList 
    11         //      fireOnOneCallback: Boolean 
    12         //              Will cause the DeferredLists callback to be fired as soon as any 
    13         //              of the deferreds in its list have been fired instead of waiting until 
    14         //              the entire list has finished 
    15         //      fireonOneErrback: Boolean 
    16         //              Will cause the errback to fire upon any of the deferreds errback 
    17         //      canceller: Function 
    18         //              A deferred canceller function, see dojo.Deferred 
    19  
    20         constructor: function(list, /*bool?*/ fireOnOneCallback, /*bool?*/ fireOnOneErrback, /*bool?*/ consumeErrors, /*Function?*/ canceller){ 
     3        constructor: function(/*Array*/ list, /*Boolean?*/ fireOnOneCallback, /*Boolean?*/ fireOnOneErrback, /*Boolean?*/ consumeErrors, /*Function?*/ canceller){ 
     4                // summary: 
     5                //              Provides event handling for a group of Deferred objects. 
     6                // description: 
     7                //              DeferredList takes an array of existing deferreds and returns a new deferred of its own 
     8                //              this new deferred will typically have its callback fired when all of the deferreds in 
     9                //              the given list have fired their own deferreds.  The parameters `fireOnOneCallback` and 
     10                //              fireOnOneErrback, will fire before all the deferreds as appropriate 
     11                // 
     12                //      list: 
     13                //              The list of deferreds to be synchronizied with this DeferredList 
     14                //      fireOnOneCallback: 
     15                //              Will cause the DeferredLists callback to be fired as soon as any 
     16                //              of the deferreds in its list have been fired instead of waiting until 
     17                //              the entire list has finished 
     18                //      fireonOneErrback: 
     19                //              Will cause the errback to fire upon any of the deferreds errback 
     20                //      canceller: 
     21                //              A deferred canceller function, see dojo.Deferred 
    2122                this.list = list; 
    2223                this.resultList = new Array(this.list.length); 
  • dojo/trunk/NodeList-fx.js

    r11155 r11339  
    1818                //              wipe in all elements of this NodeList. Returns an instance of dojo._Animation 
    1919                //      example: 
    20                 //              // fade in all tables with class "blah" 
    21                 //              dojo.query("table.blah").wipeIn().play(); 
     20                //              Fade in all tables with class "blah": 
     21                //              |       dojo.query("table.blah").wipeIn().play(); 
    2222                return this._anim(dojo.fx, "wipeIn", args); // dojo._Animation 
    2323        }, 
     
    2727                //              wipe out all elements of this NodeList. Returns an instance of dojo._Animation 
    2828                //      example: 
    29                 //              // wipe out all tables with class "blah" 
    30                 //              dojo.query("table.blah").wipeOut().play(); 
     29                //              Wipe out all tables with class "blah": 
     30                //              |       dojo.query("table.blah").wipeOut().play(); 
    3131                return this._anim(dojo.fx, "wipeOut", args); // dojo._Animation 
    3232        }, 
     
    3737                //              Returns an instance of dojo._Animation 
    3838                //      example: 
    39                 //              // move all tables with class "blah" to 300/300 
    40                 //              dojo.query("table.blah").slideTo({ 
    41                 //                      left: 40, 
    42                 //                      top: 50 
    43                 //              }).play(); 
     39                //              |       Move all tables with class "blah" to 300/300: 
     40                //              |       dojo.query("table.blah").slideTo({ 
     41                //              |               left: 40, 
     42                //              |               top: 50 
     43                //              |       }).play(); 
    4444                return this._anim(dojo.fx, "slideTo", args); // dojo._Animation 
    4545        }, 
     
    5050                //              fade in all elements of this NodeList. Returns an instance of dojo._Animation 
    5151                //      example: 
    52                 //              // fade in all tables with class "blah" 
    53                 //              dojo.query("table.blah").fadeIn().play(); 
     52                //              Fade in all tables with class "blah": 
     53                //              |       dojo.query("table.blah").fadeIn().play(); 
    5454                return this._anim(dojo, "fadeIn", args); // dojo._Animation 
    5555        }, 
     
    5959                //              fade out all elements of this NodeList. Returns an instance of dojo._Animation 
    6060                //      example: 
    61                 //              // fade out all elements with class "zork" 
    62                 //              dojo.query(".zork").fadeOut().play(); 
    63                 // 
    64                 //              // fade them on a delay and do something at the end 
    65                 //              var fo = dojo.query(".zork").fadeOut(); 
    66                 //              dojo.connect(fo, "onEnd", function(){ /*...*/ }); 
    67                 //              fo.play(); 
     61                //              Fade out all elements with class "zork": 
     62                //              |       dojo.query(".zork").fadeOut().play(); 
     63                //      example: 
     64                //              Fade them on a delay and do something at the end: 
     65                //              |       var fo = dojo.query(".zork").fadeOut(); 
     66                //              |       dojo.connect(fo, "onEnd", function(){ /*...*/ }); 
     67                //              |       fo.play(); 
    6868                return this._anim(dojo, "fadeOut", args); // dojo._Animation 
    6969        }, 
     
    7474                //              NodeList across the properties specified. 
    7575                //      example: 
    76                 //              dojo.query(".zork").animateProperty({ 
    77                 //                      duration: 500, 
    78                 //                      properties: {  
    79                 //                              color:          { start: "black", end: "white" }, 
    80                 //                              left:           { end: 300 }  
    81                 //                      }  
    82                 //              }).play(); 
     76                //      |       dojo.query(".zork").animateProperty({ 
     77                //      |               duration: 500, 
     78                //      |               properties: {  
     79                //      |                       color:          { start: "black", end: "white" }, 
     80                //      |                       left:           { end: 300 }  
     81                //      |               }  
     82                //      |       }).play(); 
    8383                return this._anim(dojo, "animateProperty", args); // dojo._Animation 
    8484        } 
  • dojo/trunk/_base/html.js

    r11218 r11339  
    1414// ============================= 
    1515 
    16 /*===== 
    17 dojo.byId = function(id, doc){ 
    18         //      summary: 
    19         //              similar to other library's "$" function, takes a 
    20         //              string representing a DOM id or a DomNode and 
    21         //              returns the corresponding DomNode. If a Node is 
    22         //              passed, this function is a no-op. Returns a 
    23         //              single DOM node or null, working around several 
    24         //              browser-specific bugs to do so. 
    25         //      id: String|DomNode 
    26         //              DOM id or DOM Node 
    27         //      doc: DocumentElement? 
    28         //              optional, defaults to the current value of 
    29         //              dojo.doc.  Can be used to retreive 
    30         //              node references from other documents. 
    31         //      return: 
    32         //              DomNode 
    33 } 
    34 =====*/ 
    35  
    3616if(dojo.isIE || dojo.isOpera){ 
    37         dojo.byId = function(id, doc){ 
     17        dojo.byId = function(/*String|DOMNode*/ id, /*DocumentElement?*/ doc){ 
     18                //      summary: 
     19                //              similar to other library's "$" function, takes a 
     20                //              string representing a DOM id or a DomNode 
     21                //              and returns the corresponding DomNode. If a Node is 
     22                //              passed, this function is a no-op. Returns a 
     23                //              single DOM node or null, working around several 
     24                //              browser-specific bugs to do so. 
     25                //      id: 
     26                //              DOM id or DOM Node 
     27                //      doc: 
     28                //              optional, defaults to the current value of 
     29                //              dojo.doc.  Can be used to retreive 
     30                //              node references from other documents. 
    3831                if(dojo.isString(id)){ 
    3932                        var _d = doc || dojo.doc; 
     
    244237 
    245238/*===== 
    246         dojo.getComputedStyle = function(node){ //DomNode 
    247                 //      summary: 
    248                 //              returns a "computed style" object. 
     239        dojo.getComputedStyle = function(node){ 
     240                //      summary: 
     241                //              Returns a "computed style" object. 
    249242                //      description: 
    250243                //              get "computed style" object which can be used to gather 
     
    326319        dojo._getOpacity = function(node){ 
    327320                        //      summary: 
    328                         //              returns the current opacity of the passed node as a 
     321                        //              Returns the current opacity of the passed node as a 
    329322                        //              floating-point value between 0 and 1. 
    330323                        //      node: DomNode