From 3814a1dddc71653fa0417a5df6b456599831eeff Mon Sep 17 00:00:00 2001 From: Eric Rowell Date: Fri, 3 Jan 2014 21:26:07 -0800 Subject: [PATCH] continued cleaning up filter docs --- src/filters/Levels.js | 18 ++++++++---------- src/filters/Noise.js | 8 ++------ src/filters/Pixelate.js | 2 +- src/filters/Threshold.js | 4 ++-- test/runner.html | 2 +- 5 files changed, 14 insertions(+), 20 deletions(-) diff --git a/src/filters/Levels.js b/src/filters/Levels.js index 3fc5eb36..7ef0d683 100644 --- a/src/filters/Levels.js +++ b/src/filters/Levels.js @@ -25,14 +25,12 @@ Kinetic.Factory.addFilterGetterSetter(Kinetic.Node, 'level', 0.5); - /** - * get/set levels. Must be a number between 0 and 1 - * @name level - * @method - * @memberof Kinetic.Node.prototype - * @param {Number} level between 0 and 1 - * @returns {Number} - */ - - + /** + * get/set levels. Must be a number between 0 and 1 + * @name level + * @method + * @memberof Kinetic.Node.prototype + * @param {Number} level between 0 and 1 + * @returns {Number} + */ })(); \ No newline at end of file diff --git a/src/filters/Noise.js b/src/filters/Noise.js index 2be18bd1..4aa30578 100644 --- a/src/filters/Noise.js +++ b/src/filters/Noise.js @@ -1,8 +1,7 @@ (function () { /** - * Noise Filter. Randomly adds or substracts to the color channels. - * Performs w*h pixel reads and w*h pixel writes. + * Noise Filter. Randomly adds or substracts to the color channels * @function * @memberof Kinetic.Filters * @param {Object} imagedata @@ -25,14 +24,11 @@ Kinetic.Factory.addFilterGetterSetter(Kinetic.Node, 'noise', 0.2); /** - * get/set noise amount. Returns the amount of noise. Between 0 and 1. + * get/set noise amount. Must be a value between 0 and 1 * @name noise * @method * @memberof Kinetic.Node.prototype * @param {Number} noise * @returns {Number} */ - - - })(); diff --git a/src/filters/Pixelate.js b/src/filters/Pixelate.js index 8052fa5f..1861522d 100644 --- a/src/filters/Pixelate.js +++ b/src/filters/Pixelate.js @@ -4,9 +4,9 @@ * Pixelate Filter. Averages groups of pixels and redraws * them as larger pixels * @function - * @author ippo615 * @memberof Kinetic.Filters * @param {Object} imageData + * @author ippo615 */ Kinetic.Filters.Pixelate = function (imageData) { diff --git a/src/filters/Threshold.js b/src/filters/Threshold.js index 4d96de98..37d4a767 100644 --- a/src/filters/Threshold.js +++ b/src/filters/Threshold.js @@ -24,10 +24,10 @@ Kinetic.Factory.addFilterGetterSetter(Kinetic.Node, 'threshold', 0.5); /** - * get/set threshold. Value between 0 and 1 + * get/set threshold. Must be a value between 0 and 1 * @name threshold * @method - * @memberof Kinetic.Image.prototype + * @memberof Kinetic.Node.prototype * @param {Number} threshold * @returns {Number} */ diff --git a/test/runner.html b/test/runner.html index 33d5b2c5..865c3512 100644 --- a/test/runner.html +++ b/test/runner.html @@ -87,7 +87,7 @@ - +