Committer: dpetrov
LJSUP-10919: Update documentation of javascript source codeU trunk/htdocs/js/jquery/jquery.lj.basicWidget.js
Modified: trunk/htdocs/js/jquery/jquery.lj.basicWidget.js =================================================================== --- trunk/htdocs/js/jquery/jquery.lj.basicWidget.js 2011-12-29 13:33:05 UTC (rev 11302) +++ trunk/htdocs/js/jquery/jquery.lj.basicWidget.js 2011-12-29 14:44:09 UTC (rev 11303) @@ -1,19 +1,16 @@ -/*! - * LiveJournal basic widget + /** + * @author dmitry.petrov@sup.com (Dmitry Petrov) + * @fileoverview Base widget for all livejournal widgets. + */ + +/** + * @name $.lj.basicWidget + * @requires $.ui.core, $.ui.widget + * @class Base widget for all livejournal widgets.<br /> + * Basic widget adds pub/sub system to the widget hierarchy. By convention widgets add prefix equal + * to the widget name of the most parent element who fires it. E.g. if someWidget and subSomeWidget + * that extends someWidget do fire open event, it should be prefixed with someWidget - someWidget/open. * - * Copyright 2011, dmitry.petrov@sup.com - * - * http://docs.jquery.com/UI - * - * Depends: - * jquery.ui.core.js - * jquery.ui.widget.js - * - * @overview Base widget for all livejournal widgets. - * - * Basic widget adds pub/sub system to the widget hierarchy. By convention widgets add prefix equal - * to the widget name of the most parent element who fires it. E.g. if someWidget and subSomeWidget - * that extends someWidget do fire open event, it should be prefixed with someWidget - someWidget/open */ ( function( $ ) { @@ -24,8 +21,14 @@ documentClick: false } + /** @lends $.lj.basicWidget.prototype */ $.widget( 'lj.basicWidget', { + /** + * Default options for widgets. + * @type Object + * @private + */ options: { /** * Object contains strings with class names that are used within widget. @@ -47,7 +50,8 @@ _create: function() { /** - * {Object} Contains all events that should not trigger events on next fire for this widget. + * Contains all events that should not trigger events on next fire for this widget. + * @type Object */ this.__suppressedEvents = {}; }, @@ -123,8 +127,8 @@ * Dispatch event. * * @param {String} type Event type. - * @param {Array=[]} args array with arguments that will be passed to the callback functions. - * @param {Boolean=False} includeOwner If false the message is not recieved by + * @param {Array|[]} args array with arguments that will be passed to the callback functions. + * @param {Boolean|False} includeOwner If false the message is not recieved by * the object that dispatched it. */ _fire: function( type, args, includeOwner ) { @@ -173,6 +177,5 @@ } } } - } ); } )( jQuery );