mouse: Update the property documentation.
This commit is contained in:
parent
a18b40e12b
commit
b662bf772f
10
mouse.c
10
mouse.c
|
@ -76,7 +76,15 @@ static int miss_newindex_handler = LUA_REFNIL;
|
||||||
/**
|
/**
|
||||||
* The `screen` under the cursor
|
* The `screen` under the cursor
|
||||||
* @property screen
|
* @property screen
|
||||||
* @tparam screen screen
|
* @tparam screen|nil screen
|
||||||
|
* @propertytype nil This will only happen if `screen` is set to `off` in the
|
||||||
|
* modeline or command line options. It happens very early in the initialization
|
||||||
|
* before the screens are created. If you check the screen from a signal, then
|
||||||
|
* you should never have to worry about this. Another corner case where this
|
||||||
|
* *might* happen is if you use `fake_resize` to have a smaller area than the
|
||||||
|
* physical screen.
|
||||||
|
* @propertydefault It checks where the cursor is and match it to one of the
|
||||||
|
* screen `geometry`.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/** Get the pointer position.
|
/** Get the pointer position.
|
||||||
|
|
Loading…
Reference in New Issue