continued cleaning up filter docs

This commit is contained in:
Eric Rowell
2014-01-03 21:26:07 -08:00
parent 3f125aff43
commit 3814a1dddc
5 changed files with 14 additions and 20 deletions

View File

@@ -25,14 +25,12 @@
Kinetic.Factory.addFilterGetterSetter(Kinetic.Node, 'level', 0.5); Kinetic.Factory.addFilterGetterSetter(Kinetic.Node, 'level', 0.5);
/** /**
* get/set levels. Must be a number between 0 and 1 * get/set levels. Must be a number between 0 and 1
* @name level * @name level
* @method * @method
* @memberof Kinetic.Node.prototype * @memberof Kinetic.Node.prototype
* @param {Number} level between 0 and 1 * @param {Number} level between 0 and 1
* @returns {Number} * @returns {Number}
*/ */
})(); })();

View File

@@ -1,8 +1,7 @@
(function () { (function () {
/** /**
* Noise Filter. Randomly adds or substracts to the color channels. * Noise Filter. Randomly adds or substracts to the color channels
* Performs w*h pixel reads and w*h pixel writes.
* @function * @function
* @memberof Kinetic.Filters * @memberof Kinetic.Filters
* @param {Object} imagedata * @param {Object} imagedata
@@ -25,14 +24,11 @@
Kinetic.Factory.addFilterGetterSetter(Kinetic.Node, 'noise', 0.2); 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 * @name noise
* @method * @method
* @memberof Kinetic.Node.prototype * @memberof Kinetic.Node.prototype
* @param {Number} noise * @param {Number} noise
* @returns {Number} * @returns {Number}
*/ */
})(); })();

View File

@@ -4,9 +4,9 @@
* Pixelate Filter. Averages groups of pixels and redraws * Pixelate Filter. Averages groups of pixels and redraws
* them as larger pixels * them as larger pixels
* @function * @function
* @author ippo615
* @memberof Kinetic.Filters * @memberof Kinetic.Filters
* @param {Object} imageData * @param {Object} imageData
* @author ippo615
*/ */
Kinetic.Filters.Pixelate = function (imageData) { Kinetic.Filters.Pixelate = function (imageData) {

View File

@@ -24,10 +24,10 @@
Kinetic.Factory.addFilterGetterSetter(Kinetic.Node, 'threshold', 0.5); 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 * @name threshold
* @method * @method
* @memberof Kinetic.Image.prototype * @memberof Kinetic.Node.prototype
* @param {Number} threshold * @param {Number} threshold
* @returns {Number} * @returns {Number}
*/ */

View File

@@ -87,7 +87,7 @@
<script src="unit/filters/Invert-test.js"></script> <script src="unit/filters/Invert-test.js"></script>
<script src="unit/filters/Mask-test.js"></script> <script src="unit/filters/Mask-test.js"></script>
<!--<script src="unit/filters/ConvolvePack-test.js"></script>--> <script src="unit/filters/ConvolvePack-test.js"></script>
<script src="unit/filters/Grayscale-test.js"></script> <script src="unit/filters/Grayscale-test.js"></script>
<script src="unit/filters/Enhance-test.js"></script> <script src="unit/filters/Enhance-test.js"></script>
<!--<script src="unit/filters/Polar-test.js"></script>--> <!--<script src="unit/filters/Polar-test.js"></script>-->