v3: src/ is documented like api/ and shared/, and the reference covers the whole repository — the frontend had no module docs, JSDoc on some components and hooks and not on others, props typed inline in half the components and in private interfaces in the rest, // comments on declarations, and no return types on 147 exported functions, so deno doc --lint over src/ found 637 errors. The rule api/ follows is applied to every non-test module of src/: a /** … @module */ block, JSDoc on every export and every field of an exported interface, /** */ for declarations and // for notes, verbs for functions ("Renders…" for a component), parameters named in the prose, {@link} only for symbols in scope, and a page's JSDoc names its route and who may see it (App.tsx's module doc lists the route table). For deno doc to show them, every exported function states its return type: components React.JSX.Element (or | null, or a portal), memo and forwardRef components their exotic types, contexts React.Context<…>, and a hook returning several things a documented Use<Name>Result interface (useAuth, useRequiredAuth, useFading, useEmojiTrigger, useMentionAutocomplete, useDumpCardLink, usePlayRichContent; FeedCacheResult, YouTubePlaylistControls and UseApiFormReturn are renamed to match). Every component that takes props takes an exported, documented <Name>Props interface — the 64 inline prop types are lifted into one, DumpFeed gets DumpFeedProps extending MainFeedProps. React types go through the global React namespace: the four default imports of react are gone, since deno doc can't follow them. Two duplicates go too: useMentionAutocomplete's UserResult was shared/'s UserSuggestion, and JournalCard re-exported JournalShape for no one; i18n.ts no longer re-exports Lingui's i18n, which its three users now import from @lingui/core. deno task doc and doc:lint now take src/ (but its tests and the generated locales), the index page gains a Frontend section linking every module by layer and domain, mod.test.ts walks src/ as well, and the docs workflow runs on changes to src/. deno doc doesn't document npm packages, so it takes a type imported from one — react-hook-form's FieldValues in the form fields, frimousse's SkinTone — for a private one; doc:lint now goes through doc-lint.ts, which fails on every diagnostic but those, 25 of them. The README states the frontend's part of the rule. No behaviour changes; 205 backend and 628 frontend tests pass, and tsc, deno check and deno lint are clean.

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

src/hooks/dump/useUserDumpFeed.ts

@@ -1,3 +1,9 @@
+/**
+ * A profile subpage's paginated list of dumps.
+ *
+ * @module
+ */
+
 import {
   type RefCallback,
   useCallback,
@@ -22,7 +28,8 @@ import { useFeedCache } from "../feed/useFeedCache.ts";
 import { useInfiniteScroll } from "../feed/useInfiniteScroll.ts";
 import { useScrollSave } from "../feed/useScrollSave.ts";
 
-type State =
+/** The feed's state: loading, failed, or loaded with a page of dumps. */
+export type UserDumpFeedState =
   | { status: "loading" }
   | { status: "error"; error: string }
   | {
@@ -34,26 +41,33 @@ type State =
     loadingMore: boolean;
   };
 
-interface UseUserDumpFeedOptions {
+/** How {@link useUserDumpFeed} reports. */
+export interface UseUserDumpFeedOptions {
   /** Called with newly appended items whenever a loadMore succeeds. */
   onItemsAppended?: (items: Dump[]) => void;
 }
 
-interface UseUserDumpFeedResult {
-  state: State;
-  setState: React.Dispatch<React.SetStateAction<State>>;
+/** What {@link useUserDumpFeed} returns. */
+export interface UseUserDumpFeedResult {
+  /** The feed's state. */
+  state: UserDumpFeedState;
+  /** Replaces the state. */
+  setState: React.Dispatch<React.SetStateAction<UserDumpFeedState>>;
+  /** Updates the loaded dumps, for live sync. */
   setItems: (fn: (prev: Dump[]) => Dump[]) => void;
+  /**
+   * The ref of the element that loads the next page when scrolled into view.
+   */
   sentinelRef: RefCallback<HTMLDivElement>;
 }
 
 /**
- * Shared data-fetching, pagination, and scroll-save logic for profile subpages
- * that display a paginated list of dumps (e.g. UserDumps, UserUpvoted).
- *
- * @param username  The route param value (may be undefined during hydration)
- * @param endpoint  Relative path after /api/users/:username, e.g. "dumps" or "votes"
- * @param cacheKey  sessionStorage key for the feed cache
- * @param options   Optional callbacks
+ * 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".
  */
 export function useUserDumpFeed(
   username: string | undefined,
@@ -64,7 +78,7 @@ export function useUserDumpFeed(
   const { token } = useAuth();
   const { cached, saveState } = useFeedCache<Dump>(cacheKey, hydrateDump);
 
-  const [state, setState] = useState<State>({ status: "loading" });
+  const [state, setState] = useState<UserDumpFeedState>({ status: "loading" });
   const [prevUsername, setPrevUsername] = useState(username);
   if (prevUsername !== username) {
     setPrevUsername(username);