Skip to content

Commit

Permalink
JSDoc cleanup.
Browse files Browse the repository at this point in the history
Enyo-DCO-1.1-Signed-Off-By: Jim Tang (jim.tang@lge.com)
  • Loading branch information
Jim Tang committed Oct 13, 2014
1 parent 6138ed5 commit 8f88582
Show file tree
Hide file tree
Showing 4 changed files with 26 additions and 26 deletions.
10 changes: 5 additions & 5 deletions imageview/source/PanZoomView.js
Expand Up @@ -4,7 +4,7 @@
* Fires whenever the user adjusts the zoom via double-tap/double-click, mousewheel,
* or pinch-zoom.
*
* @event enyo.PanZoomView#event:onZoom
* @event enyo.PanZoomView#onZoom
* @type {Object}
* @property {Number} scale - The new scaling factor.
* @public
Expand All @@ -13,7 +13,7 @@
/**
* Fires after a zoom to notify children to position non-zooming controls.
*
* @event enyo.PanZoomView#event:onPositionPin
* @event enyo.PanZoomView#onPositionPin
* @type {Object}
* @property {Numer} scale - The new scaling factor.
* @property {Object} bounds - An object containing the current viewport bounds.
Expand All @@ -33,7 +33,7 @@
* }
* ```
*
* An [onZoom]{@link enyo.PanZoomView#event:onZoom} event is triggered when the
* An [onZoom]{@link enyo.PanZoomView#onZoom} event is triggered when the
* user changes the zoom level.
*
* If you wish, you may add {@link enyo.ScrollThumb} indicators, disable zoom
Expand Down Expand Up @@ -514,7 +514,7 @@
/**
* Persists the scaling factor when a gesture finishes.
*
* @fires enyo.PanZoomView#event:onZoom
* @fires enyo.PanZoomView#onZoom
* @private
*/
saveState: function (sender, event) {
Expand Down Expand Up @@ -619,7 +619,7 @@
},

/**
* @fires enyo.PanZoomView#event:onPositionPin
* @fires enyo.PanZoomView#onPositionPin
* @private
*/
positionClientControls: function (scale) {
Expand Down
14 changes: 7 additions & 7 deletions panels/source/Panels.js
Expand Up @@ -4,7 +4,7 @@
* Fires at the start of a panel transition, when [setIndex()]{@link enyo.Panels#setIndex}
* is called, and also during dragging.
*
* @event enyo.Panels#event:onTransitionStart
* @event enyo.Panels#onTransitionStart
* @type {Object}
* @property {Number} fromIndex - The index of the old panel.
* @property {Number} toIndex - The index of the new panel.
Expand All @@ -15,7 +15,7 @@
* Fires at the end of a panel transition, when [setIndex()]{@link enyo.Panels#setIndex}
* is called, and also during dragging.
*
* @event enyo.Panels#event:onTransitionFinish
* @event enyo.Panels#onTransitionFinish
* @type {Object}
* @property {Number} fromIndex - The index of the old panel.
* @property {Number} toIndex - The index of the new panel.
Expand Down Expand Up @@ -233,7 +233,7 @@
}),

/**
* Adjusts the index if the removed control is the active panel and reflows the layout
* Adjusts the index if the removed control is the active panel and reflows the layout.
*
* @method
* @private
Expand Down Expand Up @@ -620,7 +620,7 @@
* Starts the transition between two panels.
*
* @param {Boolean} sendEvents - Whether to fire an
* [onTransitionStart]{@link enyo.Panels#event:onTransitionStart} event.
* [onTransitionStart]{@link enyo.Panels#onTransitionStart} event.
* @private
*/
startTransition: function (sendEvents) {
Expand All @@ -639,7 +639,7 @@
* Completes the transition between two panels.
*
* @param {Boolean} sendEvents - Whether to fire an
* [onTransitionFinish]{@link enyo.Panels#event:onTransitionFinish} event.
* [onTransitionFinish]{@link enyo.Panels#onTransitionFinish} event.
* @private
*/
finishTransition: function (sendEvents) {
Expand All @@ -655,7 +655,7 @@
},

/**
* @fires enyo.Panels#event:onTransitionStart
* @fires enyo.Panels#onTransitionStart
* @private
*/
fireTransitionStart: function () {
Expand All @@ -667,7 +667,7 @@
},

/**
* @fires enyo.Panels#event:onTransitionFinish
* @fires enyo.Panels#onTransitionFinish
* @private
*/
fireTransitionFinish: function () {
Expand Down
8 changes: 4 additions & 4 deletions slideable/source/Slideable.js
Expand Up @@ -3,7 +3,7 @@
/**
* Fires when the Slideable finishes animating.
*
* @event enyo.Slideable#event:onAnimateFinish
* @event enyo.Slideable#onAnimateFinish
* @type {enyo.Animator}
* @public
*/
Expand All @@ -12,7 +12,7 @@
* Fires when the position (i.e., [value]{@link enyo.Slideable#value}) of the
* Slideable changes.
*
* @event enyo.Slideable#event:onChange
* @event enyo.Slideable#onChange
* @type {Object}
* @public
*/
Expand Down Expand Up @@ -390,7 +390,7 @@
},

/**
* @fires enyo.Slideable#event:onChange
* @fires enyo.Slideable#onChange
* @private
*/
valueChanged: function (inLast) {
Expand Down Expand Up @@ -656,7 +656,7 @@
},

/**
* @fires enyo.Slideable#event:onAnimateFinish
* @fires enyo.Slideable#onAnimateFinish
* @private
*/
animatorComplete: function (sender) {
Expand Down
20 changes: 10 additions & 10 deletions tree/source/Node.js
Expand Up @@ -3,15 +3,15 @@
/**
* Fires when the Node is tapped. No additional data is sent with this event.
*
* @event enyo.Node#event:onNodeTap
* @event enyo.Node#onNodeTap
* @type {Object}
* @public
*/

/**
* Fires when the Node is double-clicked. No additional data is sent with this event.
*
* @event enyo.Node#event:onNodeDblClick
* @event enyo.Node#onNodeDblClick
* @type {Object}
* @public
*/
Expand All @@ -20,7 +20,7 @@
* Fires when the Node expands or contracts, as indicated by the
* `expanded` property in the event data.
*
* @event enyo.Node#event:onExpand
* @event enyo.Node#onExpand
* @type {Object}
* @property {Boolean} expanded - `true` if the node is currently expanded;
* otherwise, `false`.
Expand All @@ -30,7 +30,7 @@
/**
* Fires when the Node is destroyed. No additional data is sent with this event.
*
* @event enyo.Node#event:onDestroyed
* @event enyo.Node#onDestroyed
* @type {Object}
* @public
*/
Expand All @@ -57,8 +57,8 @@
* The default kind of components within a node is itself {@link enyo.Node}, so only
* the top-level node of the tree needs to be explicitly defined as such.
*
* When an expandable tree node expands, an [onExpand]{@link enyo.Node#event:onExpand}
* event is sent; when it is tapped, an [onNodeTap]{@link enyo.Node#event:onNodeTap}
* When an expandable tree node expands, an [onExpand]{@link enyo.Node#onExpand}
* event is sent; when it is tapped, an [onNodeTap]{@link enyo.Node#onNodeTap}
* event is sent.
*
* When the optional [onlyIconExpands]{@link enyo.Node#onlyIconExpands} property is
Expand Down Expand Up @@ -201,7 +201,7 @@

/**
* @method
* @fires enyo.Node#event:onDestroyed
* @fires enyo.Node#onDestroyed
* @private
*/
destroy: enyo.inherit(function (sup) {
Expand Down Expand Up @@ -292,7 +292,7 @@
},

/**
* @fires enyo.Node#event:onNodeTap
* @fires enyo.Node#onNodeTap
* @private
*/
tap: function (sender, event) {
Expand All @@ -310,7 +310,7 @@
},

/**
* @fires enyo.Node#event:onNodeDblClick
* @fires enyo.Node#onNodeDblClick
* @private
*/
dblclick: function (sender, event) {
Expand Down Expand Up @@ -383,7 +383,7 @@
},

/**
* @fires enyo.Node#event:onExpand
* @fires enyo.Node#onExpand
* @private
*/
expandedChanged: function (old) {
Expand Down

0 comments on commit 8f88582

Please sign in to comment.