From ab09fdf0b23fdf9d3cd25af520cfe53e48b60e07 Mon Sep 17 00:00:00 2001
From: Kristen McWilliam <kmcwilliampublic@gmail.com>
Date: Mon, 1 Nov 2021 12:24:32 -0400
Subject: [PATCH] dbusinterface: add doc comment for queryWindowInfo()

Adds a simple doc comment to explain what the method does.
---
 src/dbusinterface.h | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/src/dbusinterface.h b/src/dbusinterface.h
index 006c9bcb62..e79ee2014d 100644
--- a/src/dbusinterface.h
+++ b/src/dbusinterface.h
@@ -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();
 
     /**