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/validators/dump.ts

@@ -1,6 +1,7 @@
 /**
- * Guards for the dump request bodies. File dumps arrive as multipart forms
- * and are checked in their route.
+ * Checks the JSON bodies that `routes/dumps.ts` takes to post a link and to
+ * edit a dump. A file dump arrives as a multipart form instead, and
+ * `dump-service.ts` checks its title and comment.
  *
  * @module
  */
@@ -16,8 +17,9 @@ function isStringArray(value: unknown): value is string[] {
 }
 
 /**
- * Checks whether `obj` is a valid {@link CreateUrlDumpRequest}, its title and
- * comment within the `VALIDATION` limits.
+ * Checks whether `obj` is a {@link CreateUrlDumpRequest} whose title and
+ * comment fit the `VALIDATION` limits. It leaves the URL to `createUrlDump`,
+ * which rejects anything but a public http(s) URL.
  */
 export function isCreateUrlDumpRequest(
   obj: unknown,
@@ -47,9 +49,9 @@ export function isCreateUrlDumpRequest(
 }
 
 /**
- * Checks whether `obj` is a valid {@link UpdateDumpRequest}: a title, when
- * given, that isn't blank, and title and comment within the `VALIDATION`
- * limits.
+ * Checks whether `obj` is an {@link UpdateDumpRequest} whose title and comment
+ * fit the `VALIDATION` limits. Unlike on creation, a title that is given must
+ * not be blank.
  */
 export function isUpdateDumpRequest(obj: unknown): obj is UpdateDumpRequest {
   if (!obj || typeof obj !== "object") return false;