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>

shared/player.ts

@@ -1,68 +1,65 @@
 /**
- * What the player's resolvers answer: a Bandcamp release's streams and a
- * YouTube playlist's tracks.
+ * Defines what the Bandcamp and YouTube routes return to the frontend's
+ * player when it plays a Bandcamp release or a YouTube playlist.
  *
  * @module
  */
 
-/** A track of a Bandcamp release, as {@link Tralbum} lists it. */
+/** Listed by a {@link Tralbum}, in the release's order. */
 export interface TralbumTrack {
   /**
-   * Position in the parsed array — the stable handle used to re-resolve a
-   * track after its signed URL expires.
+   * The track's position in the release's list. The player keeps it, with the
+   * page URL, to resolve the track again once its stream URL expires.
    */
   index: number;
-  /** The track's number on the release. */
   trackNum?: number;
-  /** The track's title. */
   title: string;
-  /** Seconds, fractional. */
+  /** In seconds, with a fraction. */
   duration?: number;
-  /** The signed stream URL, null when the track can't be played. */
+  /** A signed URL that expires. Null when the track can't be played. */
   streamUrl: string | null;
   /**
-   * False for preorder, unreleased and still-encoding tracks. They stay in
-   * the list so numbering matches the release, but never enter the queue.
+   * False for preorder, unreleased and still-encoding tracks. They stay in the
+   * list so that the numbering matches the release, but the player skips them.
    */
   streamable: boolean;
-  /** Bandcamp caps free plays per track; a capped track may serve a clip. */
+  /** Set when Bandcamp capped its free plays, so it may serve only a clip. */
   capped: boolean;
 }
 
-/** `GET /api/bandcamp/tracks`: a Bandcamp page resolved at play time. */
+/**
+ * Returned by `GET /api/bandcamp/tracks` for a Bandcamp album or track page,
+ * when the native player plays it.
+ */
 export interface Tralbum {
-  /** The page it was resolved from. */
   sourceUrl: string;
-  /** Whether the page is an album or a single track. */
   itemType: "album" | "track";
-  /** The release's title. */
   title?: string;
-  /** The artist's name. */
   artist?: string;
-  /** The release's cover. */
   artworkUrl?: string;
-  /** The release's tracks, in order. */
   tracks: TralbumTrack[];
-  /** Epoch ms of the fetch that produced these signed URLs. */
+  /**
+   * When the stream URLs were fetched, in epoch ms. The player resolves the
+   * page again once they are old enough to have expired.
+   */
   resolvedAt: number;
 }
 
-/** A video of a YouTube playlist, as {@link YouTubePlaylist} lists it. */
+/** Listed by a {@link YouTubePlaylist}, in the playlist's order. */
 export interface YouTubePlaylistTrack {
-  /** The video's id. */
   videoId: string;
-  /** The video's title. */
   title: string;
-  /** Seconds. */
+  /** In seconds. */
   duration?: number;
 }
 
-/** `GET /api/youtube/playlist`: a playlist's tracklist, for the player. */
+/**
+ * Returned by `GET /api/youtube/playlist` to the player, which shows the
+ * titles and lengths of a playlist embed's videos, since the embed exposes
+ * neither.
+ */
 export interface YouTubePlaylist {
-  /** The playlist's id. */
   listId: string;
-  /** The playlist's title. */
   title?: string;
-  /** Its videos, in order. */
   tracks: YouTubePlaylistTrack[];
 }