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/vote-service.ts

@@ -1,5 +1,9 @@
 /**
- * Upvotes on dumps.
+ * Stores upvotes on dumps and keeps each dump's `vote_count` in step with them.
+ *
+ * Voting has no HTTP endpoint. The WebSocket route (`routes/ws.ts`) calls this
+ * module on `vote_cast` and `vote_remove` messages, then broadcasts the new
+ * count. `routes/dumps.ts` uses it only to list a dump's voters.
  *
  * @module
  */
@@ -11,11 +15,13 @@ import { db } from "../db/connection.ts";
 import { type Page, pageOf } from "../lib/pagination.ts";
 import { notifyDumpOwnerUpvote } from "./notification-service.ts";
 
-/** A dump's votes after a vote was cast or removed. */
+/**
+ * Returned to the WebSocket route by {@link castVote} and {@link removeVote}.
+ * The route acks the voter with `voteCount`, then broadcasts it to every
+ * client, or to the dump owner's alone when `isPrivate`.
+ */
 export interface VoteResult {
-  /** The dump's vote count now. */
   voteCount: number;
-  /** Whether the dump is private: its vote count goes to its owner only. */
   isPrivate: boolean;
 }
 
@@ -34,7 +40,8 @@ function visibleDump(dumpId: string, userId: string): { isPrivate: boolean } {
 }
 
 /**
- * Records `userId`'s upvote on a dump and notifies its poster.
+ * Records `userId`'s upvote on a dump and notifies the dump's poster. The
+ * notification is best-effort: if it fails, the vote still counts.
  *
  * @throws {APIException} 404 when the dump doesn't exist or is someone else's
  * private dump, 409 when the user already voted for it.
@@ -68,7 +75,7 @@ export function castVote(dumpId: string, userId: string): VoteResult {
     }
     throw err;
   }
-  // Notification is best-effort — must not prevent vote_ack from being sent
+  // The vote is committed: a failed notification must not report it as failed.
   try {
     notifyDumpOwnerUpvote(userId, dumpId);
   } catch { /* ignore */ }
@@ -111,7 +118,10 @@ export function removeVote(dumpId: string, userId: string): VoteResult {
   }
 }
 
-/** Returns the ids of every dump `userId` upvoted. */
+/**
+ * Returns the ids of the dumps `userId` upvoted. The WebSocket route sends them
+ * in its `welcome` message, and the client shows those vote buttons pressed.
+ */
 export function getUserVotes(userId: string): string[] {
   const rows = db.prepare(
     `SELECT dump_id FROM votes WHERE user_id = ?;`,
@@ -119,7 +129,13 @@ export function getUserVotes(userId: string): string[] {
   return rows.map((r) => r.dump_id);
 }
 
-/** Returns a page of the users who upvoted a dump, latest first. */
+/**
+ * Returns a page of the users who upvoted a dump, latest vote first, for
+ * `GET /api/dumps/:dumpId/voters`. It doesn't check that the caller may see the
+ * dump: the route does that first, with `getDump`.
+ *
+ * @throws {APIException} 500 when a row doesn't parse as a user.
+ */
 export function getDumpVoters(
   dumpId: string,
   page: number,