From d2f8a726060beb9ac2273bb17ef717675d26a67a Mon Sep 17 00:00:00 2001 From: Jack Armitage Date: Wed, 20 Mar 2019 10:39:55 +0000 Subject: [PATCH] test doc structure --- docs/funcs.md | 16 ++++++++++------ docs/funcs_audio.md | 42 ++++++++++++++++++++++++++++-------------- docs/funcs_color.md | 14 +++++++------- 3 files changed, 45 insertions(+), 27 deletions(-) diff --git a/docs/funcs.md b/docs/funcs.md index 21ea984..4253fd3 100644 --- a/docs/funcs.md +++ b/docs/funcs.md @@ -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() --- diff --git a/docs/funcs_audio.md b/docs/funcs_audio.md index 19463bc..6498c00 100644 --- a/docs/funcs_audio.md +++ b/docs/funcs_audio.md @@ -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() \ No newline at end of file +### setScale + +* .setScale( `amount` ) + * `amount` :: float (default x) + +### setSmooth + +* .setSmooth( `amount` ) + * `amount` :: float (default x) + +### show + +* .show() diff --git a/docs/funcs_color.md b/docs/funcs_color.md index 6780c9f..188b925 100644 --- a/docs/funcs_color.md +++ b/docs/funcs_color.md @@ -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) \ No newline at end of file +* `threshold` :: float (default 0.5) +* `tolerance` :: float (default 0.04)