From 18d74479a275a4b4e91a1cef14e97c5111389e20 Mon Sep 17 00:00:00 2001 From: Devine Lu Linvega Date: Wed, 27 Sep 2017 13:59:41 +1300 Subject: [PATCH] * --- README.md | 23 ++++++++++++++++++----- sources/scripts/docs.js | 10 +++++----- 2 files changed, 23 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 79138a0..f1dee4b 100644 --- a/README.md +++ b/README.md @@ -8,32 +8,45 @@ Ronin is a simple open-source graphic design tool. - `size`, default 4 - `color`, default #000 - `opacity`, default 1 + ### Methods + ### Ports -- `->speed`{false,true}, **0/50** The cursor speed. -- `->distance`{false,true}, **0/null** The cursor distance. -- `->red`{true,true}, **0/255** The brush color value(red). -- `->green`{true,true}, **0/255** The brush color value(green). -- `->blue`{true,true}, **0/255** The brush color value(blue). +- `->speed` *false,true* **0/50** The cursor speed. +- `->distance` *false,true* **0/null** The cursor distance. +- `->red` *true,true* **0/255** The brush color value(red). +- `->green` *true,true* **0/255** The brush color value(green). +- `->blue` *true,true* **0/255** The brush color value(blue). + ## eraser ### Settings + ### Methods + ### Ports + ## frame ### Settings - `width`, default 930 - `height`, default 540 + ### Methods - `resize:`, no details. - `rescale:`, no details. - `crop:`, no details. + ### Ports + ## line ### Settings - `steps`, default 100 + ### Methods - `tween:`, no details. - `stroke:`, no details. + ### Ports + + ## License See the [LICENSE](LICENSE.md) file for license rights and limitations (CC). diff --git a/sources/scripts/docs.js b/sources/scripts/docs.js index 38fbbf9..82623fb 100644 --- a/sources/scripts/docs.js +++ b/sources/scripts/docs.js @@ -37,11 +37,11 @@ function Docs() for(module_name in modules){ var module = modules[module_name]; html += "## "+module_name+"\n"; - html += this.print_settings(module.settings); - html += this.print_methods(module.methods); - html += this.print_ports(module.ports); + html += this.print_settings(module.settings)+"\n"; + html += this.print_methods(module.methods)+"\n"; + html += this.print_ports(module.ports)+"\n"; } - return html; + return html+"\n"; } this.print_settings = function(settings) @@ -73,7 +73,7 @@ function Docs() for(port_name in ports){ var port = ports[port_name]; console.log(ports); - html += "- `->"+port.name+"`{"+port.input+","+port.output+"}, **"+port.value+"/"+port.max+"** "+port.docs+".\n"; + html += "- `->"+port.name+"` *"+port.input+","+port.output+"* **"+port.value+"/"+port.max+"** "+port.docs+".\n"; } return html; }