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>

src/hooks/dump/useUserDumpFeed.ts

@@ -1,5 +1,6 @@
 /**
- * A profile subpage's paginated list of dumps.
+ * Loads a user's dumps or upvoted dumps, a page at a time, for the profile
+ * subpages that list them in full.
  *
  * @module
  */
@@ -28,7 +29,11 @@ import { useFeedCache } from "../feed/useFeedCache.ts";
 import { useInfiniteScroll } from "../feed/useInfiniteScroll.ts";
 import { useScrollSave } from "../feed/useScrollSave.ts";
 
-/** The feed's state: loading, failed, or loaded with a page of dumps. */
+/**
+ * Held by {@link useUserDumpFeed} for `UserDumps` and `UserUpvoted`. It fails
+ * when the user doesn't exist, and holds an empty list when only the dumps
+ * failed to load.
+ */
 export type UserDumpFeedState =
   | { status: "loading" }
   | { status: "error"; error: string }
@@ -41,33 +46,30 @@ export type UserDumpFeedState =
     loadingMore: boolean;
   };
 
-/** How {@link useUserDumpFeed} reports. */
+/** Passed to {@link useUserDumpFeed} by `UserUpvoted`. */
 export interface UseUserDumpFeedOptions {
-  /** Called with newly appended items whenever a loadMore succeeds. */
+  /** Called with the dumps of each page after the first, once appended. */
   onItemsAppended?: (items: Dump[]) => void;
 }
 
-/** What {@link useUserDumpFeed} returns. */
+/** Returned by {@link useUserDumpFeed} to `UserDumps` and `UserUpvoted`. */
 export interface UseUserDumpFeedResult {
-  /** The feed's state. */
   state: UserDumpFeedState;
-  /** Replaces the state. */
+  /** Lets `UserUpvoted` prepend a dump the user just upvoted. */
   setState: React.Dispatch<React.SetStateAction<UserDumpFeedState>>;
-  /** Updates the loaded dumps, for live sync. */
+  /** Does nothing until loaded. Passed to `useDumpListSync`. */
   setItems: (fn: (prev: Dump[]) => Dump[]) => void;
-  /**
-   * The ref of the element that loads the next page when scrolled into view.
-   */
+  /** From `useInfiniteScroll`, for an element after the last card. */
   sentinelRef: RefCallback<HTMLDivElement>;
 }
 
 /**
- * Returns the dumps of `username` from `endpoint`, with pagination, and saves
- * the feed and its scroll position under `cacheKey` so going back restores
- * both. Shared by the profile subpages that display a paginated list of dumps
- * (UserDumps, UserUpvoted). `username` is the route param (may be undefined
- * during hydration); `endpoint` the path after /api/users/:username, e.g.
- * "dumps" or "votes".
+ * Returns the profile of `username`, from `GET /api/users/:username`, with its
+ * dumps from `GET /api/users/:username/<endpoint>`, `endpoint` being "dumps"
+ * or "votes". The dumps are fetched signed in, so the user sees their own
+ * private ones. The next page loads as the sentinel scrolls into view. The
+ * list and its scroll position are saved under `cacheKey` as the page is
+ * left, and going back restores them, refetching only the profile.
  */
 export function useUserDumpFeed(
   username: string | undefined,