Add TSDoc comments to the runAsync functions

gjsify · Nov 27, 2023 · a0e6b94 · a0e6b94
1 parent 1b9dadc
commit a0e6b94
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 0 deletions.
diff --git a/packages/lib/src/injection/classes/gjs/gio-2.0.ts b/packages/lib/src/injection/classes/gjs/gio-2.0.ts
@@ -15,6 +15,21 @@ const runAsyncMethod: InjectionFunction = {
             type: 'Promise<number>',
         },
     ],
+    doc: {
+        text: "Similar to `Gio.Application.run` but return a Promise which resolves when the main loop ends, instead of blocking while the main loop runs.\nThis helps avoid the situation where Promises never resolved if you didn't run the application inside a callback.",
+        tags: [
+            {
+                tagName: 'param',
+                paramName: 'argv',
+                text: 'Commandline arguments.',
+            },
+            {
+                tagName: 'returns',
+                paramName: '',
+                text: 'The exit status of the application.',
+            },
+        ],
+    },
 }
 
 /**

diff --git a/packages/lib/src/injection/classes/gjs/glib-2.0.ts b/packages/lib/src/injection/classes/gjs/glib-2.0.ts
@@ -10,6 +10,10 @@ const runAsyncMethod: InjectionFunction = {
             type: 'Promise<void>',
         },
     ],
+    doc: {
+        text: "Similar to `GLib.MainLoop.run` but return a Promise which resolves when the main loop ends, instead of blocking while the main loop runs.\nThis helps avoid the situation where Promises never resolved if you didn't run the main loop inside a callback.",
+        tags: [],
+    },
 }
 
 export const classesGLib20Gjs: InjectionClass[] = [