Skip to content

Commit

Permalink
Merge pull request #566 from /issues/565@v2
Browse files Browse the repository at this point in the history 
jsdoc: use specific type in case of return this (close #565)
  • Loading branch information
@dfilatov
dfilatov committed Jun 30, 2014
2 parents d76d9f1 + 7828397 commit b132167
Show file tree
Hide file tree
Showing 5 changed files with 27 additions and 27 deletions.
4 changes: 2 additions & 2 deletions common.blocks/cookie/cookie.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ provide(/** @exports */{
* @param {String} name
* @param {String} val
* @param {Object} options
* @returns {this}
* @returns {cookie} this
*/
set : function(name, val, options) {
options = options || {};
Expand Down Expand Up @@ -63,4 +63,4 @@ provide(/** @exports */{
}
});

});
});
8 changes: 4 additions & 4 deletions common.blocks/events/events.vanilla.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ var undef,
* @param {Object} [data] Additional data that the handler gets as e.data
* @param {Function} fn Handler
* @param {Object} [ctx] Handler context
* @returns {this}
* @returns {Emitter} this
*/
on : function(e, data, fn, ctx, _special) {
if(typeof e === 'string') {
Expand Down Expand Up @@ -140,7 +140,7 @@ var undef,
* @param {Object} [data] Additional data that the handler gets as e.data
* @param {Function} fn Handler
* @param {Object} [ctx] Handler context
* @returns {this}
* @returns {Emitter} this
*/
once : function(e, data, fn, ctx) {
return this.on(e, data, fn, ctx, { once : true });
Expand All @@ -151,7 +151,7 @@ var undef,
* @param {String} [e] Event type
* @param {Function} [fn] Handler
* @param {Object} [ctx] Handler context
* @returns {this}
* @returns {Emitter} this
*/
un : function(e, fn, ctx) {
if(typeof e === 'string' || typeof e === 'undefined') {
Expand Down Expand Up @@ -207,7 +207,7 @@ var undef,
* Fires event handlers
* @param {String|events:Event} e Event
* @param {Object} [data] Additional data
* @returns {this}
* @returns {Emitter} this
*/
emit : function(e, data) {
var storage = this[storageExpando],
Expand Down
2 changes: 1 addition & 1 deletion common.blocks/i-bem/__dom/_elem-instances/i-bem__dom_elem-instances.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -249,7 +249,7 @@ provide(BEMDOM.decl(/** @lends BEMDOM.prototype */{
* @protected
* @param {String} event Event name
* @param {Function} [callback] Handler to be called after successful initialization in the new element's context
* @returns {this}
* @returns {Function} this
*/
liveInitOnBlockEvent : function(event, callback) {
return (typeof callback === 'string')?
Expand Down
22 changes: 11 additions & 11 deletions common.blocks/i-bem/__dom/i-bem__dom.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -370,7 +370,7 @@ var DOM = BEM.decl('i-bem__dom',/** @lends BEMDOM.prototype */{
* @param {jQuery} domElem DOM element where the event will be listened for
* @param {String|Object} event Event name or event object
* @param {Function} fn Handler function, which will be executed in the block's context
* @returns {this}
* @returns {BEMDOM} this
*/
bindToDomElem : function(domElem, event, fn) {
fn?
Expand All @@ -389,7 +389,7 @@ var DOM = BEM.decl('i-bem__dom',/** @lends BEMDOM.prototype */{
* @protected
* @param {String} event Event name
* @param {Function} fn Handler function, which will be executed in the block's context
* @returns {this}
* @returns {BEMDOM} this
*/
bindToDoc : function(event, fn) {
this._needSpecialUnbind = true;
Expand All @@ -401,7 +401,7 @@ var DOM = BEM.decl('i-bem__dom',/** @lends BEMDOM.prototype */{
* @protected
* @param {String} event Event name
* @param {Function} fn Handler function, which will be executed in the block's context
* @returns {this}
* @returns {BEMDOM} this
*/
bindToWin : function(event, fn) {
this._needSpecialUnbind = true;
Expand All @@ -414,7 +414,7 @@ var DOM = BEM.decl('i-bem__dom',/** @lends BEMDOM.prototype */{
* @param {jQuery|String} [elem] Element
* @param {String} event Event name
* @param {Function} fn Handler function, which will be executed in the block's context
* @returns {this}
* @returns {BEMDOM} this
*/
bindTo : function(elem, event, fn) {
if(!event || functions.isFunction(event)) { // if there is no element
Expand All @@ -434,7 +434,7 @@ var DOM = BEM.decl('i-bem__dom',/** @lends BEMDOM.prototype */{
* @param {jQuery} domElem DOM element where the event was being listened for
* @param {String|Object} event Event name or event object
* @param {Function} [fn] Handler function
* @returns {this}
* @returns {BEMDOM} this
*/
unbindFromDomElem : function(domElem, event, fn) {
if(typeof event === 'string') {
Expand All @@ -456,7 +456,7 @@ var DOM = BEM.decl('i-bem__dom',/** @lends BEMDOM.prototype */{
* @protected
* @param {String|Object} event Event name or event object
* @param {Function} [fn] Handler function
* @returns {this}
* @returns {BEMDOM} this
*/
unbindFromDoc : function(event, fn) {
return this.unbindFromDomElem(doc, event, fn);
Expand All @@ -467,7 +467,7 @@ var DOM = BEM.decl('i-bem__dom',/** @lends BEMDOM.prototype */{
* @protected
* @param {String|Object} event Event name or event object
* @param {Function} [fn] Handler function
* @returns {this}
* @returns {BEMDOM} this
*/
unbindFromWin : function(event, fn) {
return this.unbindFromDomElem(win, event, fn);
Expand All @@ -479,7 +479,7 @@ var DOM = BEM.decl('i-bem__dom',/** @lends BEMDOM.prototype */{
* @param {jQuery|String} [elem] Nested element
* @param {String|Object} event Event name or event object
* @param {Function} [fn] Handler function
* @returns {this}
* @returns {BEMDOM} this
*/
unbindFrom : function(elem, event, fn) {
var argLen = arguments.length;
Expand Down Expand Up @@ -568,7 +568,7 @@ var DOM = BEM.decl('i-bem__dom',/** @lends BEMDOM.prototype */{
* @param {jQuery} [elem] Nested element
* @param {String} modName Modifier name
* @param {String} modVal Modifier value
* @returns {this}
* @returns {BEMDOM} this
*/
setMod : function(elem, modName, modVal) {
if(elem && typeof modVal !== 'undefined' && elem.length > 1) {
Expand Down Expand Up @@ -777,7 +777,7 @@ var DOM = BEM.decl('i-bem__dom',/** @lends BEMDOM.prototype */{
* @param {String} [names] Nested element name (or names separated by spaces)
* @param {String} [modName] Modifier name
* @param {String} [modVal] Modifier value
* @returns {this}
* @returns {BEMDOM} this
*/
dropElemCache : function(names, modName, modVal) {
if(names) {
Expand Down Expand Up @@ -1279,7 +1279,7 @@ var DOM = BEM.decl('i-bem__dom',/** @lends BEMDOM.prototype */{
* @param {Object} [data] Additional information that the handler gets as e.data
* @param {Function} fn Handler
* @param {Object} [fnCtx] Handler context
* @returns {this}
* @returns {BEMDOM} this
*/
_liveCtxBind : function(ctx, e, data, fn, fnCtx) {
if(typeof e === 'object') {
Expand Down
18 changes: 9 additions & 9 deletions common.blocks/i-bem/i-bem.vanilla.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -191,7 +191,7 @@ var BEM = inherit(events.Emitter, /** @lends BEM.prototype */ {
* @param {Object} [data] Additional data that the handler gets as e.data
* @param {Function} fn Handler
* @param {Object} [ctx] Handler context
* @returns {this}
* @returns {BEM} this
*/
on : function(e, data, fn, ctx) {
if(typeof e === 'object' && (functions.isFunction(data) || functions.isFunction(fn))) { // mod change event
Expand All @@ -206,7 +206,7 @@ var BEM = inherit(events.Emitter, /** @lends BEM.prototype */ {
* @param {String|Object} [e] Event type
* @param {Function} [fn] Handler
* @param {Object} [ctx] Handler context
* @returns {this}
* @returns {BEM} this
*/
un : function(e, fn, ctx) {
if(typeof e === 'object' && functions.isFunction(fn)) { // mod change event
Expand All @@ -221,7 +221,7 @@ var BEM = inherit(events.Emitter, /** @lends BEM.prototype */ {
* @protected
* @param {String} e Event name
* @param {Object} [data] Additional information
* @returns {this}
* @returns {BEM} this
*/
emit : function(e, data) {
var isModJsEvent = false;
Expand Down Expand Up @@ -345,7 +345,7 @@ var BEM = inherit(events.Emitter, /** @lends BEM.prototype */ {
* @param {Object} [elem] Nested element
* @param {String} modName Modifier name
* @param {String} modVal Modifier value
* @returns {this}
* @returns {BEM} this
*/
setMod : function(elem, modName, modVal) {
if(typeof modVal === 'undefined') {
Expand Down Expand Up @@ -439,7 +439,7 @@ var BEM = inherit(events.Emitter, /** @lends BEM.prototype */ {
* @param {String} modVal1 First modifier value
* @param {String} [modVal2] Second modifier value
* @param {Boolean} [condition] Condition
* @returns {this}
* @returns {BEM} this
*/
toggleMod : function(elem, modName, modVal1, modVal2, condition) {
if(typeof elem === 'string') { // if this is a block
Expand Down Expand Up @@ -478,7 +478,7 @@ var BEM = inherit(events.Emitter, /** @lends BEM.prototype */ {
* @protected
* @param {Object} [elem] Nested element
* @param {String} modName Modifier name
* @returns {this}
* @returns {BEM} this
*/
delMod : function(elem, modName) {
if(!modName) {
Expand Down Expand Up @@ -548,7 +548,7 @@ var BEM = inherit(events.Emitter, /** @lends BEM.prototype */ {
* Executes given callback on next turn eventloop in block's context
* @protected
* @param {Function} fn callback
* @returns {this}
* @returns {BEM} this
*/
nextTick : function(fn) {
var _this = this;
Expand Down Expand Up @@ -692,7 +692,7 @@ var BEM = inherit(events.Emitter, /** @lends BEM.prototype */ {
* @param {Object} [data] Additional data that the handler gets as e.data
* @param {Function} fn Handler
* @param {Object} [ctx] Handler context
* @returns {this}
* @returns {Function} this
*/
on : function(e, data, fn, ctx) {
if(typeof e === 'object' && (functions.isFunction(data) || functions.isFunction(fn))) { // mod change event
Expand All @@ -707,7 +707,7 @@ var BEM = inherit(events.Emitter, /** @lends BEM.prototype */ {
* @param {String|Object} [e] Event type
* @param {Function} [fn] Handler
* @param {Object} [ctx] Handler context
* @returns {this}
* @returns {Function} this
*/
un : function(e, fn, ctx) {
if(typeof e === 'object' && functions.isFunction(fn)) { // mod change event
Expand Down

0 comments on commit b132167

Please sign in to comment.