diff --git a/README.md b/README.md index f1dee4b..a5357d5 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,7 @@ Ronin is a simple open-source graphic design tool. + ## Modules ## brush ### Settings @@ -12,11 +13,11 @@ Ronin is a simple open-source graphic design tool. ### 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->` (I:*false* 0, O:*true* 50), The cursor speed. +- `distance->` (I:*false* 0, O:*true* 9999), The cursor distance. +- `->red->` (I:*true* 0, O:*true* 255), The brush color value(red). +- `->green->` (I:*true* 0, O:*true* 255), The brush color value(green). +- `->blue->` (I:*true* 0, O:*true* 255), The brush color value(blue). ## eraser ### Settings diff --git a/sources/scripts/docs.js b/sources/scripts/docs.js index 82623fb..9bb41c7 100644 --- a/sources/scripts/docs.js +++ b/sources/scripts/docs.js @@ -26,7 +26,7 @@ function Docs() { html = "# Ronin\n"; html += "Ronin is a simple open-source graphic design tool.\n\n"; - html += "\n"; + html += "\n\n"; return html; } @@ -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.input ? '->' : '')+""+port.name+""+(port.output ? '->' : '')+"` (I:*"+port.input+"* "+port.value+", O:*"+port.output+"* "+port.max+"), "+port.docs+".\n"; } return html; } diff --git a/sources/scripts/modules/brush.js b/sources/scripts/modules/brush.js index db12565..d6cc0d2 100644 --- a/sources/scripts/modules/brush.js +++ b/sources/scripts/modules/brush.js @@ -13,7 +13,7 @@ function Brush() this.ports = {}; this.ports.speed = new Port("speed",false,true,0,50,"The cursor speed"); - this.ports.distance = new Port("distance",false,true,0,null,"The cursor distance"); + this.ports.distance = new Port("distance",false,true,0,9999,"The cursor distance"); this.ports.red = new Port("red",true,true,0,255,"The brush color value(red)"); this.ports.green = new Port("green",true,true,0,255,"The brush color value(green)"); this.ports.blue = new Port("blue",true,true,0,255,"The brush color value(blue)");