summaryrefslogtreecommitdiffstats
path: root/index.js
diff options
context:
space:
mode:
authorWilson Page <wilsonpage@me.com>2014-12-26 10:35:01 +0000
committerWilson Page <wilsonpage@me.com>2014-12-26 10:35:01 +0000
commitc230ac64e453f25a14387c07e6342b33e060e0ec (patch)
tree0da2d9aa90f6aaf65b7c5e20f922b4d9f0b3135a /index.js
parentcb94019569275f6ac2636c179b6b92b28cbf1636 (diff)
downloadfastdom-c230ac64e453f25a14387c07e6342b33e060e0ec.zip
fastdom-c230ac64e453f25a14387c07e6342b33e060e0ec.tar.gz
fastdom-c230ac64e453f25a14387c07e6342b33e060e0ec.tar.bz2
Fixed invalid JSDoc (fixes #47)
Diffstat (limited to 'index.js')
-rw-r--r--index.js25
1 files changed, 13 insertions, 12 deletions
diff --git a/index.js b/index.js
index c9cc7c8..4609a51 100644
--- a/index.js
+++ b/index.js
@@ -49,7 +49,7 @@
* a new frame if need be.
*
* @param {Function} fn
- * @api public
+ * @public
*/
FastDom.prototype.read = function(fn, ctx) {
var job = this.add('read', fn, ctx);
@@ -79,7 +79,7 @@
* a new frame if need be.
*
* @param {Function} fn
- * @api public
+ * @public
*/
FastDom.prototype.write = function(fn, ctx) {
var job = this.add('write', fn, ctx);
@@ -117,7 +117,7 @@
*
* @param {Number} frame
* @param {Function} fn
- * @api public
+ * @public
*/
FastDom.prototype.defer = function(frame, fn, ctx) {
@@ -144,7 +144,7 @@
* 'write' or 'defer' job.
*
* @param {Number} id
- * @api public
+ * @public
*/
FastDom.prototype.clear = function(id) {
@@ -168,7 +168,7 @@
* Clears a scheduled frame.
*
* @param {Function} frame
- * @api private
+ * @private
*/
FastDom.prototype.clearFrame = function(frame) {
var index = this.frames.indexOf(frame);
@@ -179,7 +179,7 @@
* Schedules a new read/write
* batch if one isn't pending.
*
- * @api private
+ * @private
*/
FastDom.prototype.scheduleBatch = function() {
var self = this;
@@ -200,7 +200,7 @@
* id for a job.
*
* @return {Number}
- * @api private
+ * @private
*/
FastDom.prototype.uniqueId = function() {
return ++this.lastId;
@@ -216,7 +216,7 @@
* current `this` is used.
*
* @param {Array} list
- * @api private
+ * @private
*/
FastDom.prototype.flush = function(list) {
var id;
@@ -235,7 +235,7 @@
* are able to recover and continue
* to flush the batch until it's empty.
*
- * @api private
+ * @private
*/
FastDom.prototype.runBatch = function() {
try {
@@ -266,7 +266,7 @@
* @param {Function} fn
* @param {Object} ctx
* @returns {Number} id
- * @api private
+ * @private
*/
FastDom.prototype.add = function(type, fn, ctx) {
var id = this.uniqueId();
@@ -299,7 +299,7 @@
* };
*
* @param {Object} job
- * @api private
+ * @private
*/
FastDom.prototype.run = function(job){
var ctx = job.ctx || this;
@@ -329,7 +329,7 @@
* Starts a rAF loop
* to empty the frame queue.
*
- * @api private
+ * @private
*/
FastDom.prototype.loop = function() {
var self = this;
@@ -372,6 +372,7 @@
* @param {Number} index
* @param {Function} fn
* @return {Function}
+ * @private
*/
FastDom.prototype.schedule = function(index, fn) {