test doc structure

This commit is contained in:
Jack Armitage
2019-03-20 10:39:55 +00:00
parent f899a38db9
commit d2f8a72606
3 changed files with 45 additions and 27 deletions
+10 -6
View File
@@ -43,27 +43,31 @@ Functions for manipulating audio signals.
### hide
.hide()
* .hide()
### setBins
.setBins( `int` )
* .setBins( `int` )
* `int` :: integer (default x)
### setCutoff
.setCutoff( `float` )
* .setCutoff( `frequency` )
* `frequency` :: float (default x)
### setScale
.setScale( `float` )
* .setScale( `amount` )
* `amount` :: float (default x)
### setSmooth
.setSmooth( `float` )
* .setSmooth( `amount` )
* `amount` :: float (default x)
### show
.show()
* .show()
---
+28 -14
View File
@@ -1,24 +1,38 @@
# Audio
## Audio
Functions for manipulating audio signals.
- [.hide()](#.hide())
- [.setBins( `int` )](#.setBins( `int` ))
- [.setCutoff( `float` )](#.setCutoff( `float` ))
- [.setScale( `float` )](#.setScale( `float` ))
- [.setSmooth( `float` )](#.setSmooth( `float` ))
- [.show()](#.show())
- [hide](#hide)
- [setBins](#setbins)
- [setCutoff](#setcutoff)
- [setScale](#setScale)
- [setSmooth](#setSmooth)
- [show](#show)
---
### hide
### .hide()
* .hide()
### .setBins( `int` )
### setBins
### .setCutoff( `float` )
* .setBins( `int` )
* `int` :: integer (default x)
### .setScale( `float` )
### setCutoff
### .setSmooth( `float` )
* .setCutoff( `frequency` )
* `frequency` :: float (default x)
### .show()
### setScale
* .setScale( `amount` )
* `amount` :: float (default x)
### setSmooth
* .setSmooth( `amount` )
* `amount` :: float (default x)
### show
* .show()
+7 -7
View File
@@ -12,7 +12,7 @@ Functions for manipulating color.
---
### .contrast(`amount`)
* amount :: float (default 1.6)
* `amount` :: float (default 1.6)
Larger `amount` value makes higher contrast.
@@ -24,19 +24,19 @@ Larger `amount` value makes higher contrast.
Colorize texture.
### .colorama(`amount`)
* amount :: float (default 0.005)
* `amount` :: float (default 0.005)
Shift HSV values.
### .invert(`amount`)
* amount :: float (default 1.0)
* `amount` :: float (default 1.0)
Invert color.
### .luma( `threshold`, `tolerance` )
* threshold :: float (default 0.5)
* tolerance :: float (default 0.1)
* `threshold` :: float (default 0.5)
* `tolerance` :: float (default 0.1)
### .thresh( `threshold`, `tolerance` )
* threshold :: float (default 0.5)
* tolerance :: float (default 0.04)
* `threshold` :: float (default 0.5)
* `tolerance` :: float (default 0.04)