update doc

Author: ogios

data/doc/4.widgets/0.button.md

@@ -44,37 +44,47 @@ const `btn`
 
 Support relative value, **_but don't recommend using relative value for this property_**.
 
+_Type: `int | string`_
+
 ## `height*`
 
 Length of the button.
 
-Support relative value, **_but don't recommend using relative value for this property_**.
+Support relative value.
+
+_Type: `int | string`_
 
 ## `frame_rate`
 
 Frame rate per second, won't hurt if over screen refresh rate.
 
-Default: `60`
+_Type: `int`_  
+_Default: `60`_
 
 ## `transition_duration`
 
-Time cost of showing the widget from the edge. millisecond.
+Time cost of showing the widget from the edge.  
+Millisecond.
 
-Default: `100`
+_Type: `int`_  
+_Default: `100`_
 
 ## `extra_trigger_size`
 
 Extra mouse event input region of the widget, if `0` then the widget won't be shown by mouse hover.
 
-Default: `5`
+_Type: `int | string`_  
+_Default: `5`_
 
 ## `color`
 
-Color of the button, support: `#rgb`/`#rrggbb`/`#rrrgggbbb`/`rgb(r, g, b)`/`rgba(r, g, b, a)`...
+Color of the button.
 
+Support: `#rgb`/`#rrggbb`/`#rrrgggbbb`/`rgb(r, g, b)`/`rgba(r, g, b, a)`...  
 For full info, check [RGBA](https://gtk-rs.org/gtk4-rs/stable/latest/docs/src/gdk4/rgba.rs.html#205)
 
-Default: `#7B98FF`
+_Type: `string`_  
+_Default: `#7B98FF`_
 
 ## `event_map`
 
@@ -89,3 +99,6 @@ Default mouse keys:
 - `2` - Middle button
 - `3` - Right button
 - ...others you need to test on your self by passing `--mouse-debug`: `way-edges daemon --mouse-debug`
+
+_Type: `[[int, string]...]`_  
+_Default: `[]`_

data/doc/4.widgets/1.slide.md

@@ -32,33 +32,41 @@ const `slide`
 
 ## `width*`
 
-**\*Thickness\*** of the widget, from screen edge to the screen center.
+**\*Thickness\*** of the button, from screen edge to the screen center.
 
 Support relative value, **_but don't recommend using relative value for this property_**.
 
+_Type: `int | string`_
+
 ## `height*`
 
-Length of the widget.
+Length of the button.
 
-Support relative value, **_but don't recommend using relative value for this property_**.
+Support relative value.
+
+_Type: `int | string`_
 
 ## `frame_rate`
 
 Frame rate per second, won't hurt if over screen refresh rate.
 
-Default: `60`
+_Type: `int`_  
+_Default: `60`_
 
 ## `transition_duration`
 
-Time cost of showing the widget from the edge. millisecond.
+Time cost of showing the widget from the edge.  
+Millisecond.
 
-Default: `100`
+_Type: `int`_  
+_Default: `100`_
 
 ## `extra_trigger_size`
 
 Extra mouse event input region of the widget, if `0` then the widget won't be shown by mouse hover.
 
-Default: `5`
+_Type: `int | string`_  
+_Default: `5`_
 
 ## `event_map`
 
@@ -74,85 +82,108 @@ Default mouse keys:
 - `3` - Right button
 - ...others you need to test on your self by passing `--mouse-debug`: `way-edges daemon --mouse-debug`
 
+_Type: `[[int, string]...]`_  
+_Default: `[]`_
+
 ## `on_change`
 
-Command to execute, replace '{progress}' with the progress from 0-1.
+Command to execute, replace '{progress}' with the progress from 0-1.  
+Example: `notify-send {progress}`
 
-Default: empty string
+_Type: `null | string`_  
+_Default: `null`_
 
 ## `draggable`
 
 Is progress in slide changeable by mouse left click drag.
 
-Default: `true`
+_Type: `bool`_  
+_Default: `true`_
 
 ## `update_with_interval_ms`
 
 Array of tuples. each tuple contains `millisecond` and `shell command`:  
-`[<millisecond>, <shell_command>]`
+`[<millisecond>, <shell_command>]`  
+Example: `[1000, \"echo 0.2333\"]`
 
 For `shell command`, the returned value must be a number within `[0, 1]`.
 
-Example: `[1000, \"echo 0.2333\"]`
+_Type: `[[int, string]...]`_  
+_Default: `[]`_
 
 ## `bg_color`
 
-Color of the background of widget, support: `#rgb`/`#rrggbb`/`#rrrgggbbb`/`rgb(r, g, b)`/`rgba(r, g, b, a)`...
+Color of the background of widget.
 
+Support: `#rgb`/`#rrggbb`/`#rrrgggbbb`/`rgb(r, g, b)`/`rgba(r, g, b, a)`...  
 For full info, check [RGBA](https://gtk-rs.org/gtk4-rs/stable/latest/docs/src/gdk4/rgba.rs.html#205)
 
-Default: `#808080`
+_Type: `string`_  
+_Default: `#808080`_
 
 ## `fg_color`
 
-Color of the foreground of widget, support: `#rgb`/`#rrggbb`/`#rrrgggbbb`/`rgb(r, g, b)`/`rgba(r, g, b, a)`...
+Color of the foreground of widget.
 
+Support: `#rgb`/`#rrggbb`/`#rrrgggbbb`/`rgb(r, g, b)`/`rgba(r, g, b, a)`...  
 For full info, check [RGBA](https://gtk-rs.org/gtk4-rs/stable/latest/docs/src/gdk4/rgba.rs.html#205)
 
-Default: `#FFB847`
+_Type: `string`_  
+_Default: `#FFB847`_
 
 ## `border_color`
 
-Color of the border of widget, support: `#rgb`/`#rrggbb`/`#rrrgggbbb`/`rgb(r, g, b)`/`rgba(r, g, b, a)`...
+Color of the border of widget.
 
+Support: `#rgb`/`#rrggbb`/`#rrrgggbbb`/`rgb(r, g, b)`/`rgba(r, g, b, a)`...  
 For full info, check [RGBA](https://gtk-rs.org/gtk4-rs/stable/latest/docs/src/gdk4/rgba.rs.html#205)
 
-Default: `#646464`
+_Type: `string`_  
+_Default: `#646464`_
 
 ## `text_color`
 
-Color of the text of widget, support: `#rgb`/`#rrggbb`/`#rrrgggbbb`/`rgb(r, g, b)`/`rgba(r, g, b, a)`...
+Color of the text of widget.
+
+For full info, check [RGBA](https://gtk-rs.org/gtk4-rs/stable/latest/docs/src/gdk4/rgba.rs.html#205)
 
+Support: `#rgb`/`#rrggbb`/`#rrrgggbbb`/`rgb(r, g, b)`/`rgba(r, g, b, a)`...  
 For full info, check [RGBA](https://gtk-rs.org/gtk4-rs/stable/latest/docs/src/gdk4/rgba.rs.html#205)
 
-Default: `#000000`
+_Type: `string`_  
+_Default: `#000000`_
 
 ## `preview_size`
 
 How much area should the widget reveal when hidden
 
-Default: `3`
+_Type: `int`_  
+_Default: `3`_
 
 ## `progress_direction`
 
 Progress bar: `Forward/Backward`
 
-Default: `Forward`
+_Type: `string`_  
+_Default: `Forward`_
 
 ## `is_text_position_start`
 
 Which side percentage info at, start or end of the widget
 
-Default: `true`
+_Type: `bool`_  
+_Default: `true`_
 
 ## `obtuse_angle`
 
 The 2 obtuse angle in trapezoid, set it within `[90, 180)`, when `90`, you'll get a square.
 
-Default: `120`
+_Type: `int`_  
+_Default: `120`_
 
 ## `radius`
 
 Radius of the rounded corners for 2 obtuse angle in trapezoid.
 
-Default: `20`
+_Type: `int`_  
+_Default: `20`_

data/doc/4.widgets/2.speaker.md

@@ -37,20 +37,25 @@ const `speaker`
 
 ## `device`
 
-Device description for sink or source. you can find it with `pamixer --list-sinks/--list-sources` at the end of each line
+Device description for sink or source. you can find it with `pamixer --list-sinks/--list-sources` at the end of each line.  
+Provide `null` to use default sink.
 
-Default: `empty` to use default sink or source
+_Type: `null | string`_  
+_Default: `null`_
 
 ## `mute_color`
 
-Color of the foreground when muted, support: `#rgb`/`#rrggbb`/`#rrrgggbbb`/`rgb(r, g, b)`/`rgba(r, g, b, a)`...
+Color of the foreground when muted.
 
+Support: `#rgb`/`#rrggbb`/`#rrrgggbbb`/`rgb(r, g, b)`/`rgba(r, g, b, a)`...  
 For full info, check [RGBA](https://gtk-rs.org/gtk4-rs/stable/latest/docs/src/gdk4/rgba.rs.html#205)
 
-Default: `#000000`
+_Type: `string`_  
+_Default: `#000000`_
 
 ## `redraw_only_on_pa_change`
 
 Drag slider won't affect progress immediately. Send the changed value first and redraw after `PulseAudio` sink or source info changes
 
-Default: `false`
+_Type: `bool`_  
+_Default: `false`_

data/doc/4.widgets/3.microphone.md

@@ -38,20 +38,25 @@ const `microphone`
 
 ## `device`
 
-Device description for sink or source. you can find it with `pamixer --list-sinks/--list-sources` at the end of each line
+Device description for sink or source. you can find it with `pamixer --list-sinks/--list-sources` at the end of each line.  
+Provide `null` to use default source.
 
-Default: `empty` to use default sink or source
+_Type: `null | string`_  
+_Default: `null`_
 
 ## `mute_color`
 
-Color of the foreground when muted, support: `#rgb`/`#rrggbb`/`#rrrgggbbb`/`rgb(r, g, b)`/`rgba(r, g, b, a)`...
+Color of the foreground when muted.
 
+Support: `#rgb`/`#rrggbb`/`#rrrgggbbb`/`rgb(r, g, b)`/`rgba(r, g, b, a)`...  
 For full info, check [RGBA](https://gtk-rs.org/gtk4-rs/stable/latest/docs/src/gdk4/rgba.rs.html#205)
 
-Default: `#000000`
+_Type: `string`_  
+_Default: `#000000`_
 
 ## `redraw_only_on_pa_change`
 
 Drag slider won't affect progress immediately. Send the changed value first and redraw after `PulseAudio` sink or source info changes
 
-Default: `false`
+_Type: `bool`_  
+_Default: `false`_

data/doc/4.widgets/4.backlight.md

@@ -34,12 +34,15 @@ const `backlight`
 
 ## `device_name`
 
-Hardware name, you can find it under `/sys/class/backlight`.
+Hardware name, you can find it under `/sys/class/backlight`.  
+Provide `null` to use default from `org.freedesktop.login1.Session`.
 
-Default: `empty` to use default from `org.freedesktop.login1.Session`
+_Type: `null | string`_  
+_Default: `null`_
 
-## `redraw_only_on_change`
+## `redraw_only_on_pa_change`
 
-Drag slider won't affect progress immediately. Send the changed value first and redraw after `Backlight` changes
+Drag slider won't affect progress immediately. Send the changed value first and redraw after `Backlight`.
 
-Default: `false`
+_Type: `bool`_  
+_Default: `false`_