The library for web and native user interfaces.
Use `@return`, not `@returns`
CommitSyncScript committed
Jun 24, 2013 at 16:09 UTC
de4084259759e7c70aad9583b2b2aadc82e41911
7 files changed
+10
-10
src/core/ReactID.js
+1
-1
@@ -31,7 +31,7 @@ var nodeCache = {};
31
* DOM node (such as window).
32
*
33
* @param {?DOMElement|DOMWindow|DOMDocument|DOMTextNode} node DOM node.
34
- * @returns {string} ID of the supplied `domNode`.
34
+ * @return {string} ID of the supplied `domNode`.
35
*/
36
function getID(node) {
37
if (node && node.getAttributeNode) {
src/dom/DOMChildrenOperations.js
+1
-1
@@ -47,7 +47,7 @@ var REMOVE_AT = keyOf({removeAt: null});
47
*
48
* @param {Element} parent Parent DOM node.
49
* @param {Object} childOperations Description of child operations.
50
- * @returns {Array?} Sparse array containing elements by their current index in
50
+ * @return {Array?} Sparse array containing elements by their current index in
51
* the DOM.
52
*/
53
var _getNodesByOriginalIndex = function(parent, childOperations) {
src/dom/Danger.js
+1
-1
@@ -65,7 +65,7 @@ function getParentDummy(parent) {
65
* @param {Element} elem Parent element.
66
* @param {Element} insert Element to insert.
67
* @param {Element} after Element to insert after.
68
- * @returns {Element} Element that was inserted.
68
+ * @return {Element} Element that was inserted.
69
*/
70
function insertNodeAfterNode(elem, insert, after) {
71
if (__DEV__) {
src/event/EventPluginUtils.js
+3
-3
@@ -106,7 +106,7 @@ function executeDispatchesInOrder(event, executeDispatch) {
106
* Standard/simple iteration through an event's collected dispatches, but stops
107
* at the first dispatch execution returning true, and returns that id.
108
*
109
- * @returns id of the first dispatch execution who's listener returns true, or
109
+ * @return id of the first dispatch execution who's listener returns true, or
110
* null if no listener returned true.
111
*/
112
function executeDispatchesInOrderStopAtTrue(event) {
@@ -140,7 +140,7 @@ function executeDispatchesInOrderStopAtTrue(event) {
140
* return values at each dispatch execution, but it does tend to make sense when
141
* dealing with "direct" dispatches.
142
*
143
- * @returns The return value of executing the single dispatch.
143
+ * @return The return value of executing the single dispatch.
144
*/
145
function executeDirectDispatch(event) {
146
if (__DEV__) {
@@ -162,7 +162,7 @@ function executeDirectDispatch(event) {
162
163
/**
164
* @param {SyntheticEvent} event
165
- * @returns {bool} True iff number of dispatches accumulated is greater than 0.
165
+ * @return {bool} True iff number of dispatches accumulated is greater than 0.
166
*/
167
function hasDispatches(event) {
168
return !!event._dispatchListeners;
src/utils/OrderedMap.js
+2
-2
@@ -246,7 +246,7 @@ var OrderedMapMethods = {
246
*
247
* @param {Function} cb Callback to invoke for each item.
248
* @param {Object?=} context Context to invoke callback from.
249
- * @returns {OrderedMap} OrderedMap that results from mapping.
249
+ * @return {OrderedMap} OrderedMap that results from mapping.
250
*/
251
map: function(cb, context) {
252
return this.mapRange(cb, 0, this.length, context);
@@ -288,7 +288,7 @@ var OrderedMapMethods = {
288
*
289
* @param {Function} cb Callback to invoke for each item.
290
* @param {Object?=} context Context to invoke callback from.
291
- * @returns {OrderedMap} OrderedMap that results from filtering.
291
+ * @return {OrderedMap} OrderedMap that results from filtering.
292
*/
293
filter: function(cb, context) {
294
return this.filterRange(cb, 0, this.length, context);
src/utils/Transaction.js
+1
-1
@@ -153,7 +153,7 @@ var Mixin = {
153
* @param {Object} scope Scope to invoke from.
154
* @param {Object?=} args... Arguments to pass to the method (optional).
155
* Helps prevent need to bind in many cases.
156
- * @returns Return value from `method`.
156
+ * @return Return value from `method`.
157
*/
158
perform: function(method, scope, a, b, c, d, e, f) {
159
throwIf(this.isInTransaction(), DUAL_TRANSACTION);
src/utils/accumulate.js
+1
-1
@@ -35,7 +35,7 @@ if (__DEV__) {
35
* depending on the total count (if greater than one, an array is allocated).
36
* Handles most common case first (starting with an empty current value and
37
* acquiring one).
38
- * @returns {Accumulation} An accumulation which is either a single item or an
38
+ * @return {Accumulation} An accumulation which is either a single item or an
39
* Array of items.
40
*/
41
function accumulate(cur, next) {