Project

General

Profile

« Previous | Next » 

Revision 1374

Added by Dietmar over 13 years ago

fixed headerinfos

View differences:

yahoo-debug.js
66 66
     * The YAHOO global namespace object.  If YAHOO is already defined, the
67 67
     * existing YAHOO object will not be overwritten so that defined
68 68
     * namespaces are preserved.
69
     * @class YAHOO
70
     * @static
69
    * @class YAHOO
70
    * @static
71 71
     */
72 72
    var YAHOO = {};
73 73
}
......
199 199

  
200 200
    /**
201 201
     * Keeps the version info for all YUI modules that have reported themselves
202
     * @property modules
203
     * @type Object[]
202
    * @property modules
203
    * @type Object[]
204 204
     */
205 205
    modules: [],
206 206
    
207 207
    /**
208 208
     * List of functions that should be executed every time a YUI module
209 209
     * reports itself.
210
     * @property listeners
211
     * @type Function[]
210
    * @property listeners
211
    * @type Function[]
212 212
     */
213 213
    listeners: []
214 214
};
......
264 264

  
265 265
        /**
266 266
         * Internet Explorer version number or 0.  Example: 6
267
         * @property ie
268
         * @type float
267
        * @property ie
268
        * @type float
269 269
         */
270 270
        ie: 0,
271 271

  
272 272
        /**
273 273
         * Opera version number or 0.  Example: 9.2
274
         * @property opera
275
         * @type float
274
        * @property opera
275
        * @type float
276 276
         */
277 277
        opera: 0,
278 278

  
......
286 286
         * Firefox 2.0.0.3: 1.8.1.3 <-- Reports 1.8
287 287
         * Firefox 3 alpha: 1.9a4   <-- Reports 1.9
288 288
         * </pre>
289
         * @property gecko
290
         * @type float
289
        * @property gecko
290
        * @type float
291 291
         */
292 292
        gecko: 0,
293 293

  
......
316 316
         *                                   
317 317
         * </pre>
318 318
         * http://developer.apple.com/internet/safari/uamatrix.html
319
         * @property webkit
320
         * @type float
319
        * @property webkit
320
        * @type float
321 321
         */
322 322
        webkit: 0,
323 323

  
......
326 326
         * user agent information when a modern mobile browser is detected.
327 327
         * Currently limited to Safari on the iPhone/iPod Touch, Nokia N-series
328 328
         * devices with the WebKit-based browser, and Opera Mini.  
329
         * @property mobile 
330
         * @type string
329
        * @property mobile 
330
        * @type string
331 331
         */
332 332
        mobile: null,
333 333

  
334 334
        /**
335 335
         * Adobe AIR version number or 0.  Only populated if webkit is detected.
336 336
         * Example: 1.0
337
         * @property air
338
         * @type float
337
        * @property air
338
        * @type float
339 339
         */
340 340
        air: 0,
341 341

  
342 342
        /**
343 343
         * Google Caja version number or 0.
344
         * @property caja
345
         * @type float
344
        * @property caja
345
        * @type float
346 346
         */
347 347
        caja: nav.cajaVersion,
348 348

  
349 349
        /**
350 350
         * Set to true if the page appears to be in SSL
351
         * @property secure
352
         * @type boolean
353
         * @static
351
        * @property secure
352
        * @type boolean
353
        * @static
354 354
         */
355 355
        secure: false,
356 356

  
357 357
        /**
358 358
         * The operating system.  Currently only detecting windows or macintosh
359
         * @property os
360
         * @type string
361
         * @static
359
        * @property os
360
        * @type string
361
        * @static
362 362
         */
363 363
        os: null
364 364

  
......
493 493

  
494 494
    /**
495 495
     * Determines wheather or not the provided object is an array.
496
     * @method isArray
497
     * @param {any} o The object being testing
498
     * @return {boolean} the result
496
    * @method isArray
497
    * @param {any} o The object being testing
498
    * @return {boolean} the result
499 499
     */
500 500
    isArray: function(o) { 
501 501
        return OP.toString.apply(o) === ARRAY_TOSTRING;
......
503 503

  
504 504
    /**
505 505
     * Determines whether or not the provided object is a boolean
506
     * @method isBoolean
507
     * @param {any} o The object being testing
508
     * @return {boolean} the result
506
    * @method isBoolean
507
    * @param {any} o The object being testing
508
    * @return {boolean} the result
509 509
     */
510 510
    isBoolean: function(o) {
511 511
        return typeof o === 'boolean';
......
524 524
     * You will have to implement additional tests if these functions
525 525
     * matter to you.
526 526
     *
527
     * @method isFunction
528
     * @param {any} o The object being testing
529
     * @return {boolean} the result
527
    * @method isFunction
528
    * @param {any} o The object being testing
529
    * @return {boolean} the result
530 530
     */
531 531
    isFunction: function(o) {
532 532
        return (typeof o === 'function') || OP.toString.apply(o) === FUNCTION_TOSTRING;
......
534 534
        
535 535
    /**
536 536
     * Determines whether or not the provided object is null
537
     * @method isNull
538
     * @param {any} o The object being testing
539
     * @return {boolean} the result
537
    * @method isNull
538
    * @param {any} o The object being testing
539
    * @return {boolean} the result
540 540
     */
541 541
    isNull: function(o) {
542 542
        return o === null;
......
544 544
        
545 545
    /**
546 546
     * Determines whether or not the provided object is a legal number
547
     * @method isNumber
548
     * @param {any} o The object being testing
549
     * @return {boolean} the result
547
    * @method isNumber
548
    * @param {any} o The object being testing
549
    * @return {boolean} the result
550 550
     */
551 551
    isNumber: function(o) {
552 552
        return typeof o === 'number' && isFinite(o);
......
555 555
    /**
556 556
     * Determines whether or not the provided object is of type object
557 557
     * or function
558
     * @method isObject
559
     * @param {any} o The object being testing
560
     * @return {boolean} the result
558
    * @method isObject
559
    * @param {any} o The object being testing
560
    * @return {boolean} the result
561 561
     */  
562 562
    isObject: function(o) {
563 563
return (o && (typeof o === 'object' || L.isFunction(o))) || false;
......
565 565
        
566 566
    /**
567 567
     * Determines whether or not the provided object is a string
568
     * @method isString
569
     * @param {any} o The object being testing
570
     * @return {boolean} the result
568
    * @method isString
569
    * @param {any} o The object being testing
570
    * @return {boolean} the result
571 571
     */
572 572
    isString: function(o) {
573 573
        return typeof o === 'string';
......
575 575
        
576 576
    /**
577 577
     * Determines whether or not the provided object is undefined
578
     * @method isUndefined
579
     * @param {any} o The object being testing
580
     * @return {boolean} the result
578
    * @method isUndefined
579
    * @param {any} o The object being testing
580
    * @return {boolean} the result
581 581
     */
582 582
    isUndefined: function(o) {
583 583
        return typeof o === 'undefined';
......
588 588
     * IE will not enumerate native functions in a derived object even if the
589 589
     * function was overridden.  This is a workaround for specific functions 
590 590
     * we care about on the Object prototype. 
591
     * @property _IEEnumFix
592
     * @param {Function} r  the object to receive the augmentation
593
     * @param {Function} s  the object that supplies the properties to augment
594
     * @static
595
     * @private
591
    * @property _IEEnumFix
592
    * @param {Function} r  the object to receive the augmentation
593
    * @param {Function} s  the object that supplies the properties to augment
594
    * @static
595
    * @private
596 596
     */
597 597
    _IEEnumFix: (YAHOO.env.ua.ie) ? function(r, s) {
598 598
            var i, fname, f;
......
612 612
     * support an inheritance strategy that can chain constructors and methods.
613 613
     * Static members will not be inherited.
614 614
     *
615
     * @method extend
616
     * @static
617
     * @param {Function} subc   the object to modify
618
     * @param {Function} superc the object to inherit
619
     * @param {Object} overrides  additional properties/methods to add to the
615
    * @method extend
616
    * @static
617
    * @param {Function} subc   the object to modify
618
    * @param {Function} superc the object to inherit
619
    * @param {Object} overrides  additional properties/methods to add to the
620 620
     *                              subclass prototype.  These will override the
621 621
     *                              matching items obtained from the superclass 
622 622
     *                              if present.
......
655 655
     * properties will be applied and _will_ overwrite properties in 
656 656
     * the receiver.
657 657
     *
658
     * @method augmentObject
659
     * @static
660
     * @since 2.3.0
661
     * @param {Function} r  the object to receive the augmentation
662
     * @param {Function} s  the object that supplies the properties to augment
663
     * @param {String*|boolean}  arguments zero or more properties methods 
658
    * @method augmentObject
659
    * @static
660
    * @since 2.3.0
661
    * @param {Function} r  the object to receive the augmentation
662
    * @param {Function} s  the object that supplies the properties to augment
663
    * @param {String*|boolean}  arguments zero or more properties methods 
664 664
     *        to augment the receiver with.  If none specified, everything
665 665
     *        in the supplier will be used unless it would
666 666
     *        overwrite an existing property in the receiver. If true
......
690 690
 
691 691
    /**
692 692
     * Same as YAHOO.lang.augmentObject, except it only applies prototype properties
693
     * @see YAHOO.lang.augmentObject
694
     * @method augmentProto
695
     * @static
696
     * @param {Function} r  the object to receive the augmentation
697
     * @param {Function} s  the object that supplies the properties to augment
698
     * @param {String*|boolean}  arguments zero or more properties methods 
693
    * @see YAHOO.lang.augmentObject
694
    * @method augmentProto
695
    * @static
696
    * @param {Function} r  the object to receive the augmentation
697
    * @param {Function} s  the object that supplies the properties to augment
698
    * @param {String*|boolean}  arguments zero or more properties methods 
699 699
     *        to augment the receiver with.  If none specified, everything 
700 700
     *        in the supplier will be used unless it would overwrite an existing 
701 701
     *        property in the receiver.  if true is specified as the third 
......
720 720
     * Other types of objects will be returned unprocessed.  Arrays
721 721
     * are expected to be indexed.  Use object notation for
722 722
     * associative arrays.
723
     * @method dump
724
     * @since 2.3.0
725
     * @param o {Object} The object to dump
726
     * @param d {int} How deep to recurse child objects, default 3
727
     * @return {String} the dump result
723
    * @method dump
724
    * @since 2.3.0
725
    * @param o {Object} The object to dump
726
    * @param d {int} How deep to recurse child objects, default 3
727
    * @return {String} the dump result
728 728
     */
729 729
    dump: function(o, d) {
730 730
        var i,len,s=[],OBJ="{...}",FUN="f(){...}",
......
796 796
     * value is an object, it uses the Object's toString() if this has
797 797
     * been overridden, otherwise it does a shallow dump of the key/value
798 798
     * pairs.
799
     * @method substitute
800
     * @since 2.3.0
801
     * @param s {String} The string that will be modified.
802
     * @param o {Object} An object containing the replacement values
803
     * @param f {Function} An optional function that can be used to
799
    * @method substitute
800
    * @since 2.3.0
801
    * @param s {String} The string that will be modified.
802
    * @param o {Object} An object containing the replacement values
803
    * @param f {Function} An optional function that can be used to
804 804
     *                     process each match.  It receives the key,
805 805
     *                     value, and any extra metadata included with
806 806
     *                     the key inside of the braces.
807
     * @return {String} the substituted string
807
    * @return {String} the substituted string
808 808
     */
809 809
    substitute: function (s, o, f) {
810 810
        var i, j, k, key, v, meta, saved=[], token, 
......
887 887
    /**
888 888
     * Returns a string without any leading or trailing whitespace.  If 
889 889
     * the input is not a string, the input will be returned untouched.
890
     * @method trim
891
     * @since 2.3.0
892
     * @param s {string} the string to trim
893
     * @return {string} the trimmed string
890
    * @method trim
891
    * @since 2.3.0
892
    * @param s {string} the string to trim
893
    * @return {string} the trimmed string
894 894
     */
895 895
    trim: function(s){
896 896
        try {
......
904 904
     * Returns a new object containing all of the properties of
905 905
     * all the supplied objects.  The properties from later objects
906 906
     * will overwrite those in earlier objects.
907
     * @method merge
908
     * @since 2.3.0
909
     * @param arguments {Object*} the objects to merge
910
     * @return the new merged object
907
    * @method merge
908
    * @since 2.3.0
909
    * @param arguments {Object*} the objects to merge
910
    * @return the new merged object
911 911
     */
912 912
    merge: function() {
913 913
        var o={}, a=arguments, l=a.length, i;
......
921 921
     * Executes the supplied function in the context of the supplied 
922 922
     * object 'when' milliseconds later.  Executes the function a 
923 923
     * single time unless periodic is set to true.
924
     * @method later
925
     * @since 2.4.0
926
     * @param when {int} the number of milliseconds to wait until the fn 
924
    * @method later
925
    * @since 2.4.0
926
    * @param when {int} the number of milliseconds to wait until the fn 
927 927
     * is executed
928
     * @param o the context object
929
     * @param fn {Function|String} the function to execute or the name of 
928
    * @param o the context object
929
    * @param fn {Function|String} the function to execute or the name of 
930 930
     * the method in the 'o' object to execute
931
     * @param data [Array] data that is provided to the function.  This accepts
931
    * @param data [Array] data that is provided to the function.  This accepts
932 932
     * either a single item or an array.  If an array is provided, the
933 933
     * function is executed with one parameter for each array item.  If
934 934
     * you need to pass a single array parameter, it needs to be wrapped in
935 935
     * an array [myarray]
936
     * @param periodic {boolean} if true, executes continuously at supplied 
936
    * @param periodic {boolean} if true, executes continuously at supplied 
937 937
     * interval until canceled
938
     * @return a timer object. Call the cancel() method on this object to 
938
    * @return a timer object. Call the cancel() method on this object to 
939 939
     * stop the timer.
940 940
     */
941 941
    later: function(when, o, fn, data, periodic) {
......
977 977
     * A convenience method for detecting a legitimate non-null value.
978 978
     * Returns false for null/undefined/NaN, true for other values, 
979 979
     * including 0/false/''
980
     * @method isValue
981
     * @since 2.3.0
982
     * @param o {any} the item to test
983
     * @return {boolean} true if it is not null/undefined/NaN || false
980
    * @method isValue
981
    * @since 2.3.0
982
    * @param o {any} the item to test
983
    * @return {boolean} true if it is not null/undefined/NaN || false
984 984
     */
985 985
    isValue: function(o) {
986 986
        // return (o || o === false || o === 0 || o === ''); // Infinity fails

Also available in: Unified diff