v3: comments say what the code can't — the documentation pass wanted JSDoc on every export and every field of an exported interface, which filled the code with restatements ("The dump.", "Whether it is loading.", "The props of X.", "Renders the X.") and module docs that told a reader nothing ("The hot and new feeds, and the props every main feed of the index takes."); some were wrong as well as vague. Every comment in api/, shared/ and src/ is rewritten under one rule, now stated in the README's "Comments" section: every module and export still has a JSDoc, and it gives context (who uses it and where), usage (what a caller must know: a precondition, what it leaves to the caller, a side effect) or its place in the chain (where its input comes from, where its output goes); a field, parameter, private function or local gets one only when it adds to its parent's, and context about a whole type goes on the type; a type's doc is phrased from the value's side ("Returned to Y by X when Z", "Passed to Y by X"); full sentences, as short as they can be, no label-colon-list; // goes wherever the code isn't obvious and says why, and the section banners and narration go. Every claim was checked against the code, which turned up some forty comments that were wrong: DumpCard's claimed it was only used by the hot and new feeds, the WebSocket welcome claimed to be a socket's first message (presence comes first), UpdateUserRequest said null removes a description (it keeps it), deletedDumpIds leaves out that it also holds dumps made private, THEME_COLOR claimed to mirror index.html's, and the like. The routers' JSDoc now says where they are mounted and what becomes of a thrown APIException. doc-lint.ts lets a field without a doc through; a module or export without one still fails. No code changes; 204 backend and 628 frontend tests pass, and doc:lint, deno check, deno lint and tsc are clean.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

api/services/email-service.ts

@@ -1,5 +1,7 @@
 /**
- * Sending mail through the SMTP server in {@link SMTPS_URL}.
+ * Sends mail through the SMTP server of {@link SMTPS_URL}, which may be unset.
+ * Its two callers, the welcome email at sign-up and the password reset link,
+ * check {@link isEmailEnabled} first and don't wait for delivery.
  *
  * @module
  */
@@ -8,42 +10,43 @@ import nodemailer, { type SendMailOptions, type Transporter } from "nodemailer";
 
 import { SMTPS_URL } from "../config.ts";
 
-/** One address, a comma-separated list of them, or an array. */
+/**
+ * One address, a comma-separated list of them, or an array, as nodemailer
+ * takes them.
+ */
 export type EmailRecipient = string | string[];
 
-/** A message to send. It needs a recipient, a subject, and a text or HTML body. */
+/**
+ * Passed to {@link sendEmail}. It needs a recipient, a subject, and a text or
+ * HTML body; the callers send the same Markdown as both, rendered for `html`.
+ */
 export interface EmailMessage {
-  /** The sender's address. */
   from: string;
-  /** The recipients. */
   to: EmailRecipient;
-  /** The subject line. */
   subject: string;
-  /** The plain-text body. */
   text?: string;
-  /** The HTML body. */
   html?: string;
-  /** The carbon-copy recipients. */
   cc?: EmailRecipient;
-  /** The blind-carbon-copy recipients. */
   bcc?: EmailRecipient;
-  /** The address replies go to. */
   replyTo?: string;
 }
 
-/** What the SMTP server said about a sent message. */
+/**
+ * Returned by {@link sendEmail} once the SMTP server has taken the message.
+ * No caller reads it yet.
+ */
 export interface EmailSendResult {
-  /** The message's `Message-ID`. */
   messageId: string;
-  /** The recipients the server accepted. */
   accepted: string[];
-  /** The recipients the server rejected. */
   rejected: string[];
 }
 
 let transporter: Transporter | null = null;
 
-/** Checks whether an SMTP server is configured. */
+/**
+ * Checks whether an SMTP server is configured. Without one, sign-up sends no
+ * welcome email and a password reset request does nothing.
+ */
 export function isEmailEnabled(): boolean {
   return SMTPS_URL.length > 0;
 }
@@ -76,8 +79,8 @@ function getTransporter(): Transporter {
 }
 
 /**
- * Checks the connection to the SMTP server. Resolves false when email is
- * disabled.
+ * Checks the connection to the SMTP server, or resolves false when email is
+ * disabled. Nothing calls it yet.
  *
  * @throws {Error} When the server can't be reached or refuses the login.
  */
@@ -88,7 +91,8 @@ export async function verifyEmailTransport(): Promise<boolean> {
 }
 
 /**
- * Sends `message`.
+ * Sends `message` and resolves once the SMTP server has accepted it. The
+ * transport is created on the first send.
  *
  * @throws {Error} When email is disabled, the message lacks a recipient,
  * subject or body, or the server refuses it.