fill empty jsdocs

Author: sirtimid

packages/kernel-browser-runtime/src/PlatformServicesClient.ts

@@ -36,7 +36,16 @@ export type PlatformServicesClientStream = PostMessageDuplexStream<
 >;
 
 /**
+ * The client end of the platform services, intended to be constructed in
+ * the kernel worker. Sends launch and terminate worker requests to the
+ * server and wraps the launch response in a DuplexStream for consumption
+ * by the kernel, and provides network connectivity.
  *
+ * @see {@link PlatformServicesServer} for the other end of the service.
+ *
+ * @param stream - The stream to use for communication with the server.
+ * @param logger - An optional {@link Logger}. Defaults to a new logger labeled '[platform services client]'.
+ * @returns A new {@link PlatformServicesClient}.
  */
 export class PlatformServicesClient implements PlatformServices {
   readonly #logger: Logger;

packages/kernel-browser-runtime/src/PlatformServicesServer.ts

@@ -41,7 +41,20 @@ export type PlatformServicesStream = PostMessageDuplexStream<
 >;
 
 /**
+ * The server end of the platform services, intended to be constructed in
+ * the offscreen document. Listens for launch and terminate worker requests
+ * from the client and uses the {@link VatWorker} methods to effect those
+ * requests, and provides network connectivity.
  *
+ * Note that {@link PlatformServicesServer.start} must be called to start
+ * the server.
+ *
+ * @see {@link PlatformServicesClient} for the other end of the service.
+ *
+ * @param stream - The stream to use for communication with the client.
+ * @param makeWorker - A method for making a {@link VatWorker}.
+ * @param logger - An optional {@link Logger}. Defaults to a new logger labeled '[platform services server]'.
+ * @returns A new {@link PlatformServicesServer}.
  */
 export class PlatformServicesServer {
   readonly #logger;

packages/ocap-kernel/src/Kernel.ts

@@ -36,7 +36,17 @@ import type { VatHandle } from './vats/VatHandle.ts';
 import { VatManager } from './vats/VatManager.ts';
 
 /**
+ * The kernel is the main class for the kernel. It is responsible for
+ * managing the lifecycle of the kernel and the vats.
  *
+ * @param commandStream - Command channel from whatever external software is driving the kernel.
+ * @param platformServices - Service to do things the kernel worker can't.
+ * @param kernelDatabase - Database holding the kernel's persistent state.
+ * @param options - Options for the kernel constructor.
+ * @param options.resetStorage - If true, the storage will be cleared.
+ * @param options.logger - Optional logger for error and diagnostic output.
+ * @param options.keySeed - Optional seed for libp2p key generation.
+ * @returns A new {@link Kernel}.
  */
 export class Kernel {
   /** Command channel from the controlling console/browser extension/test driver */