From 29f2a0e7c48eb93ca05c4141cf354c33c327b28b Mon Sep 17 00:00:00 2001 From: Alexander Marks Date: Tue, 28 Nov 2017 21:30:19 -0800 Subject: [PATCH] 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. --- lib/utils/array-splice.html | 3 ++- lib/utils/async.html | 4 ++++ 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/lib/utils/array-splice.html b/lib/utils/array-splice.html index 328284dc1e..3d0179813a 100644 --- a/lib/utils/array-splice.html +++ b/lib/utils/array-splice.html @@ -298,6 +298,7 @@ * 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 @@ }; })(); - \ No newline at end of file + diff --git a/lib/utils/async.html b/lib/utils/async.html index 1283856349..176f25501e 100644 --- a/lib/utils/async.html +++ b/lib/utils/async.html @@ -79,6 +79,7 @@ /** * 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 @@ /** * 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 @@ /** * 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 @@ /** * Cancels a previously enqueued `animationFrame` callback. * + * @function * @memberof Polymer.Async.timeOut * @param {number} handle Handle returned from `run` of callback to cancel */