dbusinterface: add doc comment for queryWindowInfo()
Adds a simple doc comment to explain what the method does.
This commit is contained in:
parent
94de28bfbe
commit
ab09fdf0b2
1 changed files with 8 additions and 0 deletions
|
@ -60,6 +60,14 @@ public Q_SLOTS: // METHODS
|
|||
Q_NOREPLY void showDebugConsole();
|
||||
Q_NOREPLY void replace();
|
||||
|
||||
/**
|
||||
* Allows the user to pick a window and get info on it.
|
||||
*
|
||||
* When called the user's mouse cursor will become a targeting reticule.
|
||||
* On clicking a window with the target a map will be returned
|
||||
* with various information about the picked window, such as:
|
||||
* height, width, minimized, fullscreen, etc.
|
||||
*/
|
||||
QVariantMap queryWindowInfo();
|
||||
|
||||
/**
|
||||
|
|
Loading…
Reference in a new issue