Skip to content

Commit 29f2a0e

Browse files
committed
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.
1 parent fbebc59 commit 29f2a0e

2 files changed

Lines changed: 6 additions & 1 deletion

File tree

lib/utils/array-splice.html

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -298,6 +298,7 @@
298298
* perform the more expensive minimum edit distance calculation over the
299299
* non-shared portions of the arrays.
300300
*
301+
* @function
301302
* @memberof Polymer.ArraySplice
302303
* @param {Array} current The "changed" array for which splices will be
303304
* calculated.
@@ -312,4 +313,4 @@
312313
};
313314

314315
})();
315-
</script>
316+
</script>

lib/utils/async.html

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,7 @@
7979
/**
8080
* Enqueues a function called in the next task.
8181
*
82+
* @function
8283
* @memberof Polymer.Async.timeOut
8384
* @param {Function} fn Callback to run
8485
* @return {number} Handle used for canceling task
@@ -87,6 +88,7 @@
8788
/**
8889
* Cancels a previously enqueued `timeOut` callback.
8990
*
91+
* @function
9092
* @memberof Polymer.Async.timeOut
9193
* @param {number} handle Handle returned from `run` of callback to cancel
9294
*/
@@ -104,6 +106,7 @@
104106
/**
105107
* Enqueues a function called at `requestAnimationFrame` timing.
106108
*
109+
* @function
107110
* @memberof Polymer.Async.animationFrame
108111
* @param {Function} fn Callback to run
109112
* @return {number} Handle used for canceling task
@@ -112,6 +115,7 @@
112115
/**
113116
* Cancels a previously enqueued `animationFrame` callback.
114117
*
118+
* @function
115119
* @memberof Polymer.Async.timeOut
116120
* @param {number} handle Handle returned from `run` of callback to cancel
117121
*/

0 commit comments

Comments
 (0)