Permalink
Browse files

More comment cleanup. Enyo-DCO-1.1-Signed-Off-By: Jim Tang (jim.tang@…

…lge.com)
  • Loading branch information...
1 parent acb1704 commit 057491e065c03b30abcdf5783bab2abcf2b87214 Jim Tang committed Mar 26, 2013
Showing with 126 additions and 110 deletions.
  1. +15 −15 source/kernel/mixins/MultipleDispatchSupport.js
  2. +111 −95 source/kernel/mixins/ObserverMethodSupport.js
@@ -1,11 +1,11 @@
//*@public
/**
- Allow a single object to dispatch its events to multiple registered
+ Allows a single object to dispatch its events to multiple registered
listeners. Note that events generated by the object will be dispatched
- to all listeners but events bubbled/dispatched the object will only
- be propagated if the object has an _owner_. The _owner_ property can
- be set at any time, however, if a _view_ initializes a new instance of
- the kind its _owner_ will automatically be set.
+ to all listeners, but events bubbled or dispatched to the object will
+ only be propagated if the object has an _owner_. While the _owner_
+ property may be set at any time, if a view initializes a new instance
+ of the kind, its _owner_ will automatically be set.
*/
enyo.createMixin({
@@ -27,7 +27,7 @@ enyo.createMixin({
//*@protected
/**
A boolean flag used internally to communicate how to
- handle requests to bubble events.
+ handle requests to bubble events
*/
_default_dispatch: false,
@@ -44,11 +44,11 @@ enyo.createMixin({
//*@protected
/**
- Overload the bubble target.
+ Overloads the bubble target.
*/
bubbleTarget: enyo.computed(function () {
- // if we have a valid dispatch target and default dispatching enabled
- // we go head and return that object otherwise nothing so it will
+ // if we have a valid dispatch target and default dispatching enabled,
+ // we go head and return that object; otherwise, nothing, so it will
// not propagate an event
if (this._default_target && this._default_dispatch) return this._default_target;
}, "_default_target", "_default_dispatch", {cached: true}),
@@ -58,8 +58,8 @@ enyo.createMixin({
//*@public
/**
- Accepts an instance of any _enyo.Component_ or subkind that
- supports the event API.
+ Sets as dispatch target an instance of _enyo.Component_ or a subkind
+ that supports the event API.
*/
addDispatchTarget: function (target) {
var $dist = this._dispatch_targets;
@@ -74,9 +74,9 @@ enyo.createMixin({
//*@public
/**
- Accepts an instance of a registered listener on this object
- and will remove it from active dispatch targets if it is
- present.
+ Accepts an instance of a registered listener on this object as a
+ parameter; if the passed-in listener is present the active dispatch
+ targets, it is then removed.
*/
removeDispatchTarget: function (target) {
var $dist = this._dispatch_targets;
@@ -89,7 +89,7 @@ enyo.createMixin({
//*@protected
/**
- When the _owner_ changes we have to check our state to make
+ When the _owner_ changes, we have to check our state to make
sure we are still appropriately set.
*/
ownerChanged: function () {
Oops, something went wrong.

0 comments on commit 057491e

Please sign in to comment.