input\code\inherit\examplemodule.js File

  1. /**
  2.  * This is my example module
  3.  * @module ExampleModule
  4.  * @example
  5.  *
  6.  *     var bar;
  7.  *
  8.  */
  9.  
  10. YUI.add('examplemodule', function (Y) {
  11.         Y.namespace('mywidget');
  12.         
  13.         /**
  14.          * <b>Superclass</b> description.<br>This is a second line too.
  15.          * 
  16.          * @constructor
  17.          * @class SuperWidget
  18.          * @extends Widget
  19.          * @namespace mywidget
  20.          * @example
  21.          *
  22.          *     var bar;
  23.          *
  24.          */
  25.         Y.mywidget.superwidget = Y.Base.create("mysuperwidget", Y.Widget, [], {
  26.                 
  27.                 /**
  28.                  * <b>Supermethod</b> description.<br>This is a second line.
  29.                  * 
  30.                  * @method myMethod
  31.                  * @async
  32.                  * @example
  33.                  *
  34.                  *     var bar;
  35.                  *
  36.                  */
  37.                 myMethod: function () {}
  38.                 
  39.                 /**
  40.                 * Overwritten method see {{#crossLink "mywidget.SuperWidget"}}{{/crossLink}}
  41.                 * also see {{#crossLink "mywidget.SuperWidget/myMethod"}}{{/crossLink}}
  42.                 * This is also a test
  43.                 * @method getTargets2
  44.                 * @example
  45.                 *
  46.                 *     var bar;
  47.                 *
  48.                 */
  49.  
  50.                 /**
  51.                 * Overwritten method see {{#crossLink "mywidget.SuperWidget"}}{{/crossLink}}
  52.                 * also see {{#crossLink "mywidget.SuperWidget/myMethod"}}{{/crossLink}}
  53.                 * This is also a test
  54.                 *
  55.                 * ```javascript
  56.                 *
  57.                 * var test = "hello from a code block!";
  58.                 *
  59.                 * ```
  60.                 *
  61.                 * @method getTargets3
  62.                 * @demo inherit/getTargets3.js
  63.                 */
  64.  
  65.                 /**
  66.                 * Override Attribute
  67.                 * @attribute focused2
  68.                 * @optional
  69.                 */
  70.  
  71.                 /**
  72.                 * Override Attribute
  73.                 * @attribute focused3
  74.                 * @required
  75.                 * @example 
  76.                 *         {
  77.                 *             a:1
  78.                 *         }
  79.                 */
  80.  
  81.                 /**
  82.                 * Override Property
  83.                 * @property name2
  84.                 * @type String
  85.                 */
  86.  
  87.                 /**
  88.                 * Override Event
  89.                 * @event init2
  90.                 * @param {object} opt options
  91.                 * @example
  92.                 *         var a = '';
  93.                 */
  94.                  init2 : function(opt){
  95.  
  96.                  }
  97.         }, {
  98.         
  99.         });
  100.         
  101.         /**
  102.          * Subclass description.
  103.          * 
  104.          * @constructor
  105.          * @namespace mywidget
  106.          * @class SubWidget
  107.          * @extends mywidget.SuperWidget
  108.          */
  109.         Y.mywidget.superwidget = Y.Base.create("mysuperwidget", Y.mywidget.superwidget, [], {
  110.                 
  111.                 /**
  112.                  * Submethod description.
  113.                  * 
  114.                  * @method myMethod
  115.                  * @param {boolean} d Foo
  116.                  */
  117.                 myMethod: function () {}
  118.                  
  119.         }, {
  120.         
  121.         });
  122.  
  123.         /**
  124.          * Subclass description.
  125.          * 
  126.          * @constructor
  127.          * @namespace mywidget
  128.          * @class SubWidget2
  129.          * @extends Accordion
  130.          */
  131. });
  132.  
  133.
Top