From aea4e9f6c750559ad0c9f8a6c53a1ab635c4e202 Mon Sep 17 00:00:00 2001
From: Mikhail Zolotukhin <mail@genda.life>
Date: Fri, 17 Sep 2021 22:12:12 +0300
Subject: [PATCH] docs: :memo: add a bit more docs to KWin Scripting interface

---
 src/extern/kwin.d.ts | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

diff --git a/src/extern/kwin.d.ts b/src/extern/kwin.d.ts
index 0441d98c..e449a8b1 100644
--- a/src/extern/kwin.d.ts
+++ b/src/extern/kwin.d.ts
@@ -9,6 +9,9 @@
 // TODO: Register the rest of the API and document it according to KWin documentation.
 // Maybe it is even possible to generate this API. If so, this could be upstreamed.
 declare namespace KWin {
+  /**
+   * Wrapper for all available KWin API from various places.
+   */
   interface Api {
     workspace: KWin.WorkspaceWrapper;
     options: KWin.Options;
@@ -16,13 +19,24 @@ declare namespace KWin {
   }
 
   interface KWin {
+    /**
+     * Represents KWin::Script::readConfig
+     */
     readConfig(key: string, defaultValue?: any): any;
+
+    /**
+     * Represents KWin::Script::registerShortcut
+     */
     registerShortcut(
       title: string,
       text: string,
       keySequence: string,
       callback: any
     ): boolean;
+
+    /**
+     * Enum value of ClientAreaOption enum in KWin::JSEngineGlobalMethodsWrapper
+     */
     PlacementArea: number;
   }