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>

doc-lint.ts

@@ -7,6 +7,10 @@
  * whose type the module imports from a package is let through, and counted;
  * every other diagnostic fails the run.
  *
+ * A `missing-jsdoc` on a member (an interface field, a class property) is let
+ * through too: a field gets a doc only when it adds something its type's doc
+ * doesn't, so most fields have none. A module or an export without one fails.
+ *
  * It also checks what `deno doc --lint` doesn't: that every summary stands on
  * its own. The reference shows a doc's first paragraph alone, in lists and
  * above a symbol, so a first paragraph ending in a colon reads cut short.
@@ -22,6 +26,8 @@ interface Diagnostic {
   message: string;
   /** The module it was reported in. */
   file: string;
+  /** The column it was reported at: 1 for a top-level declaration. */
+  column: number;
   /** The diagnostic as printed, location and excerpt included. */
   text: string;
 }
@@ -37,9 +43,15 @@ async function lint(modules: string[]): Promise<Diagnostic[]> {
   const output = new TextDecoder().decode(stderr);
   return output.split(/\n(?=error\[)/).flatMap((text) => {
     const head = /^error\[([\w-]+)\]: (.*)$/m.exec(text);
-    const at = /--> (.+?):\d+:\d+/.exec(text);
+    const at = /--> (.+?):\d+:(\d+)/.exec(text);
     if (!head || !at) return [];
-    return [{ rule: head[1], message: head[2], file: at[1], text }];
+    return [{
+      rule: head[1],
+      message: head[2],
+      file: at[1],
+      column: Number(at[2]),
+      text,
+    }];
   });
 }
 
@@ -59,13 +71,20 @@ function importedFromPackage(file: string, name: string): boolean {
   return false;
 }
 
-/** Checks whether `d` is a private type from a package, which is let through. */
+/**
+ * Checks whether `d` is a private type from a package, which is let through.
+ */
 function isPackageTypeRef(d: Diagnostic): boolean {
   const type = /references private type '([\w$]+)/.exec(d.message)?.[1];
   return d.rule === "private-type-ref" && !!type &&
     importedFromPackage(d.file, type);
 }
 
+/** Checks whether `d` is a member without a doc, which is let through. */
+function isUndocumentedMember(d: Diagnostic): boolean {
+  return d.rule === "missing-jsdoc" && d.column > 1;
+}
+
 /** Returns the first paragraph of `doc`, which the reference shows alone. */
 function summary(doc: string): string {
   return doc.trim().split(/\n\s*\n|\n\s*(?:[-*]|\d+\.)\s|\n\s*```/)[0].trim();
@@ -103,6 +122,7 @@ async function colonSummaries(modules: string[]): Promise<Diagnostic[]> {
           rule: "colon-summary",
           message,
           file,
+          column: 1,
           text: `error[colon-summary]: ${message}\n --> ${file}`,
         });
       }
@@ -124,13 +144,15 @@ if (import.meta.main) {
     ...await lint(Deno.args),
     ...await colonSummaries(Deno.args),
   ];
-  const failures = diagnostics.filter((d) => !isPackageTypeRef(d));
+  const failures = diagnostics.filter((d) =>
+    !isPackageTypeRef(d) && !isUndocumentedMember(d)
+  );
   for (const d of failures) console.error(d.text.trimEnd() + "\n");
   const allowed = diagnostics.length - failures.length;
   console.error(
     `${failures.length} documentation lint errors` +
       (allowed
-        ? `, ${allowed} references to npm packages' types let through`
+        ? `, ${allowed} undocumented members and npm type references let through`
         : ""),
   );
   if (failures.length) Deno.exit(1);