From 9660f83e3023d2d3e9d159755ac961fbdf10c8c1 Mon Sep 17 00:00:00 2001
From: Kristen McWilliam <kmcwilliampublic@gmail.com>
Date: Wed, 27 Oct 2021 20:30:51 -0400
Subject: [PATCH] dbusinterface: add doc comment for getWindowInfo()

This method was lacking a doc comment, this adds basic context.
---
 src/dbusinterface.h | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/src/dbusinterface.h b/src/dbusinterface.h
index 73e5e362cc..52c29a216c 100644
--- a/src/dbusinterface.h
+++ b/src/dbusinterface.h
@@ -61,6 +61,14 @@ public Q_SLOTS: // METHODS
     Q_NOREPLY void replace();
 
     QVariantMap queryWindowInfo();
+
+    /** 
+     * Returns a map with information about the window.
+     * 
+     * The map includes entries such as position, size, status, and more.
+     * 
+     * @param uuid is a QUuid from Toplevel::internalId().
+     */
     QVariantMap getWindowInfo(const QString &uuid);
 
 private Q_SLOTS: