Add some @function annotations to APIs that are defined by assignment.

This helps analyzer understand when something is a function despite not
having any function-looking syntax on the right-hand-side.
This commit is contained in:
Alexander Marks
2017-11-28 21:34:13 -08:00
parent fbebc5929f
commit 29f2a0e7c4
2 changed files with 6 additions and 1 deletions
+2 -1
View File
@@ -298,6 +298,7 @@ subject to an additional IP rights grant found at http://polymer.github.io/PATEN
* perform the more expensive minimum edit distance calculation over the
* non-shared portions of the arrays.
*
* @function
* @memberof Polymer.ArraySplice
* @param {Array} current The "changed" array for which splices will be
* calculated.
@@ -312,4 +313,4 @@ subject to an additional IP rights grant found at http://polymer.github.io/PATEN
};
})();
</script>
</script>
+4
View File
@@ -79,6 +79,7 @@ subject to an additional IP rights grant found at http://polymer.github.io/PATEN
/**
* Enqueues a function called in the next task.
*
* @function
* @memberof Polymer.Async.timeOut
* @param {Function} fn Callback to run
* @return {number} Handle used for canceling task
@@ -87,6 +88,7 @@ subject to an additional IP rights grant found at http://polymer.github.io/PATEN
/**
* Cancels a previously enqueued `timeOut` callback.
*
* @function
* @memberof Polymer.Async.timeOut
* @param {number} handle Handle returned from `run` of callback to cancel
*/
@@ -104,6 +106,7 @@ subject to an additional IP rights grant found at http://polymer.github.io/PATEN
/**
* Enqueues a function called at `requestAnimationFrame` timing.
*
* @function
* @memberof Polymer.Async.animationFrame
* @param {Function} fn Callback to run
* @return {number} Handle used for canceling task
@@ -112,6 +115,7 @@ subject to an additional IP rights grant found at http://polymer.github.io/PATEN
/**
* Cancels a previously enqueued `animationFrame` callback.
*
* @function
* @memberof Polymer.Async.timeOut
* @param {number} handle Handle returned from `run` of callback to cancel
*/