Updated docs

This commit is contained in:
Devine Lu Linvega 2017-09-27 13:29:13 +13:00
parent 6ffabd2318
commit 5e311fd29c
2 changed files with 26 additions and 26 deletions

View File

@ -4,39 +4,39 @@ Ronin is a simple open-source graphic design tool.
## Modules
## brush
### Settings
- size
- color
- opacity
- `size`, default 4
- `color`, default #000
- `opacity`, default 1
### Methods
### Ports
- speed
- distance
- red
- green
- blue
- alpha
- x
- noise
- `speed`, no details.
- `distance`, no details.
- `red`, no details.
- `green`, no details.
- `blue`, no details.
- `alpha`, no details.
- `x`, no details.
- `noise`, no details.
## eraser
### Settings
### Methods
### Ports
## frame
### Settings
- width
- height
- `width`, default 930
- `height`, default 540
### Methods
- resize
- rescale
- crop
- `resize`, no details.
- `rescale`, no details.
- `crop`, no details.
### Ports
## line
### Settings
- steps
- `steps`, default 100
### Methods
- tween
- stroke
- `tween`, no details.
- `stroke`, no details.
### Ports
- index
- `index`, no details.
## License
See the [LICENSE](LICENSE.md) file for license rights and limitations (CC).

View File

@ -49,8 +49,8 @@ function Docs()
var html = "### Settings\n";
for(setting_name in settings){
var setting = settings[setting_name];
html += "- "+setting_name+"\n";
var setting_val = settings[setting_name];
html += "- `"+setting_name+"`, default "+setting_val+"\n";
}
return html;
}
@ -60,8 +60,8 @@ function Docs()
var html = "### Methods\n";
for(method_name in methods){
var method = methods[method_name];
html += "- "+method_name+"\n";
var method_val = methods[method_name];
html += "- `"+method_name+"`, no details.\n";
}
return html;
}
@ -71,8 +71,8 @@ function Docs()
var html = "### Ports\n";
for(port_name in ports){
var port = ports[setting_name];
html += "- "+port_name+"\n";
var port_val = ports[setting_name];
html += "- `"+port_name+"`, no details.\n";
}
return html;
}