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/model/comment.ts

@@ -1,6 +1,6 @@
 /**
- * The `comments` table: its row type, its guard, and its mapper to the API's
- * {@link Comment}.
+ * Types the rows the comment service reads from `comments`, and turns them into
+ * the {@link Comment} the comment routes send.
  *
  * @module
  */
@@ -8,38 +8,31 @@
 import type { SQLOutputValue } from "node:sqlite";
 import type { Comment } from "../../shared/comment.ts";
 
-/** A row of the `comments` table, joined with its author. */
+/**
+ * Returned by the comment service's `SELECT`s on `comments`, joined with
+ * `users` for the `author_` columns.
+ */
 export interface CommentRow {
-  /** The comment's id. */
   id: string;
-  /** The id of the dump it is posted under. */
   dump_id: string;
-  /** The author's id. */
   user_id: string;
-  /** The id of the comment it replies to; null at the top level. */
+  /** It is null on a top-level comment. */
   parent_id: string | null;
-  /** The comment, in Markdown. */
   body: string;
-  /** When the comment was posted. */
   created_at: string;
-  /** When the comment was last edited, if ever. */
   updated_at: string | null;
   /**
-   * 1 once deleted: the body is emptied but the row stays, so its replies
-   * keep their place.
+   * 1 once deleted. The body is emptied but the row stays, so its replies keep
+   * their place in the thread.
    */
   deleted: number;
-  /** How many users like the comment. */
   like_count: number;
-  /** The author's name (joined). */
   author_username: string;
-  /** The author's avatar type, null without one (joined). */
   author_avatar_mime: string | null;
-  /** Any other column the query selects. */
   [key: string]: SQLOutputValue;
 }
 
-/** Checks whether `obj` is a {@link CommentRow}. */
+/** Checks whether a row `node:sqlite` returned is a {@link CommentRow}. */
 export function isCommentRow(
   obj: unknown,
 ): obj is CommentRow {
@@ -61,7 +54,10 @@ export function isCommentRow(
       obj.author_avatar_mime === null);
 }
 
-/** Converts a row to the API's {@link Comment}. */
+/**
+ * Converts `row` to the {@link Comment} the comment routes send and the
+ * WebSocket broadcasts.
+ */
 export function commentRowToApi(row: CommentRow): Comment {
   return {
     id: row.id,