📝 Add docstrings to fix-typedoc

Docstrings generation was requested by @snipsnipsnip.

* #32 (comment)

The following files were modified:

* `src/ghosttext-runner/ghost_text_runner.ts`
* `src/root/background_helper.ts`
* `src/root/util/wireless.ts`

Author: coderabbitai[bot]

src/ghosttext-runner/ghost_text_runner.ts

@@ -95,6 +95,18 @@ async function receiveChange(editor: IClientEditor, session: ISession): Promise<
   }
 }
 
+/**
+ * Await a single event from the editor or the session and produce the corresponding command result.
+ *
+ * @param editor - Client editor used to wait for an edit and to pop the last edit when one occurs
+ * @param session - Session used to wait for a server change and to pop the server change when one occurs
+ * @returns A `CommandResult` describing the event:
+ * - `{ type: "clientEdited", edit }` when an editor edit was produced
+ * - `{ type: "serverChanged", change }` when a server change was produced
+ * - `{ type: "editorClosed" }` when the editor closed without an edit
+ * - `{ type: "disconnected" }` when the session disconnected without a change
+ * - `undefined` if an edit/change event was signaled but no payload was available to include.
+ */
 async function receiveChangeOnce(editor: IClientEditor, session: ISession): Promise<CommandResult | undefined> {
   let type = await Promise.race([
     editor.waitEdit().then(
@@ -117,6 +129,10 @@ async function receiveChangeOnce(editor: IClientEditor, session: ISession): Prom
     return { type }
   }
 }
+
+/**
+ * Map a connection status to a user-visible ClientStatus.
+ */
 function translateStatus(s: SessionStatus): ClientStatus {
   switch (s) {
     case "error":

src/root/background_helper.ts

@@ -10,10 +10,10 @@ let routerCache: BackgroundEventRouter | undefined
 let routerPromise: Promise<BackgroundEventRouter> | undefined
 
 /**
- * Executes a handler function with the background event router.
+ * Ensure a BackgroundEventRouter is available and invoke the given handler with it.
  *
- * @param handler The function to execute with the router
- * @returns A promise that resolves when the handler completes, or undefined if an error occurs
+ * @param handler - Function invoked with the prepared BackgroundEventRouter
+ * @returns a promise when the handler is running async or the BackgroundEventRouter has been initialized, or `undefined` if finished synchronously
  */
 export function withRouter(handler: RouterHandler): Promise<void> | undefined {
   if (routerCache) {
@@ -31,11 +31,11 @@ export function withRouter(handler: RouterHandler): Promise<void> | undefined {
 }
 
 /**
- * Executes a handler function synchronously with the provided router.
+ * Invokes the provided handler with the given BackgroundEventRouter and returns the handler's result.
  *
- * @param handler The function to execute with the router
- * @param router The background event router to use
- * @returns A promise that resolves when the handler completes, or undefined if an error occurs
+ * @param handler - The function to execute with the router
+ * @param router - The background event router to pass to `handler`
+ * @returns A promise or an undefined returned by `handler`
  */
 function runHandler(handler: RouterHandler, router: BackgroundEventRouter): Promise<void> | undefined {
   try {

src/root/util/wireless.ts

@@ -36,7 +36,11 @@ export type WirelessInjector<TCatalog> = <TCtor>(
 ) => Resolved<TCatalog, TCtor>
 
 /**
- * Collects available classes from given module objects to make a factory.
+ * Creates a convention-based injector by scanning modules for startup classes and wiring constructors with resolved dependencies.
+ *
+ * @param modules - Iterable of module objects to scan for startup classes and their metadata
+ * @param registry - Registry used to resolve dependencies and that will receive the created injector under the key `"$injector"`
+ * @returns A `WirelessInjector` function that, given a constructor and optional dependency keys, returns a resolved instance for the catalog
  */
 export function wireless<TCatalog>(
   modules: Iterable<Record<string, unknown>>,