v3: the backend is documented for deno doc, one way in every file, and the docs build and publish themselves — comments were in three shapes: file headers as // lines, as an untagged /** */ (which deno doc drops, only an @module block counts) or missing; 43 exports described by a // deno doc can't see, two JSDoc blocks sitting on the wrong declaration and one duplicated; endpoints commented in 5 of 18 route files, three ways, on router.get() calls no doc tool reads. The rule, applied to every non-test module of api/, migrations included: each opens with a /** … @module */ block; every export has JSDoc, and so does every field of an exported interface; a comment describing a declaration is /** */, // only notes code; functions open with a verb, everything else with a noun phrase; parameters are named in the prose, {@link} only for symbols in scope; whatever throws to its caller says so with @throws (for an APIException, the statuses and when); a router's JSDoc lists its endpoints, method and path, who may call it, what it does. deno doc --lint goes from 528 errors to none in api/ (shared/ keeps its 385; it is next). The lint also wanted explicit types on config.ts's settings and a few return types, JsonLdResult exported, and the routers typed Router. deno task doc builds the HTML reference into docs/ from every module of api/ and shared/ but the tests, deno task doc:lint lints it; the index page is the module doc of a root mod.ts (deno.json's exports), which introduces the backend, shared/ and the frontend to come and links every module, and mod.test.ts fails when one is missing. The docs workflow builds it on every push to main that touches them and publishes it to the gh-pages branch, like publish-assistant's. Two defects found along the way are fixed: a private playlist's cover was served to anyone who had its id or slug, and now needs its owner's media token, as private dump files do (playlistImageUrl adds it for private playlists only, so public cover URLs stay the same for everyone); og.ts and static.ts each filled index.html's placeholders, and now share lib/index-html.ts, so the OG middleware picks up a rebuilt index.html instead of keeping the first it read. The README states the documentation rule. 205 backend and 628 frontend tests pass.

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

api/services/vote-service.ts

@@ -1,3 +1,9 @@
+/**
+ * Upvotes on dumps.
+ *
+ * @module
+ */
+
 import { APIErrorCode } from "../../shared/api.ts";
 import { APIException } from "../lib/api-exception.ts";
 import { isUserRow, type User, userRowToApi } from "../model/user.ts";
@@ -5,14 +11,18 @@ 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. */
 export interface VoteResult {
+  /** The dump's vote count now. */
   voteCount: number;
-  /** Private dumps' vote counts go to their owner only. */
+  /** Whether the dump is private: its vote count goes to its owner only. */
   isPrivate: boolean;
 }
 
-// Visibility of the dump, or a 404 when the user can't see it — voting must not
-// confirm that a private dump exists.
+/**
+ * Returns whether the dump is private, or throws a 404 when the user can't see
+ * it — voting must not confirm that a private dump exists.
+ */
 function visibleDump(dumpId: string, userId: string): { isPrivate: boolean } {
   const row = db.prepare(
     `SELECT is_private, user_id FROM dumps WHERE id = ?;`,
@@ -23,6 +33,12 @@ function visibleDump(dumpId: string, userId: string): { isPrivate: boolean } {
   return { isPrivate: Boolean(row.is_private) };
 }
 
+/**
+ * Records `userId`'s upvote on a dump and notifies its poster.
+ *
+ * @throws {APIException} 404 when the dump doesn't exist or is someone else's
+ * private dump, 409 when the user already voted for it.
+ */
 export function castVote(dumpId: string, userId: string): VoteResult {
   const { isPrivate } = visibleDump(dumpId, userId);
   let voteCount: number;
@@ -59,8 +75,13 @@ export function castVote(dumpId: string, userId: string): VoteResult {
   return { voteCount, isPrivate };
 }
 
-// No visibility check: taking back a vote on a dump that has since gone
-// private is harmless, and it's the voter's own row.
+/**
+ * Takes back `userId`'s upvote on a dump. No visibility check: taking back a
+ * vote on a dump that has since gone private is harmless, and it's the voter's
+ * own row.
+ *
+ * @throws {APIException} 404 when the user hasn't voted for the dump.
+ */
 export function removeVote(dumpId: string, userId: string): VoteResult {
   const row = db.prepare(`SELECT is_private FROM dumps WHERE id = ?;`).get(
     dumpId,
@@ -90,6 +111,7 @@ export function removeVote(dumpId: string, userId: string): VoteResult {
   }
 }
 
+/** Returns the ids of every dump `userId` upvoted. */
 export function getUserVotes(userId: string): string[] {
   const rows = db.prepare(
     `SELECT dump_id FROM votes WHERE user_id = ?;`,
@@ -97,6 +119,7 @@ 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. */
 export function getDumpVoters(
   dumpId: string,
   page: number,