Skip to content

Add internal JSDocs throughout the codebase#1835

Draft
Copilot wants to merge 2 commits intomainfrom
copilot/add-internal-jsdocs
Draft

Add internal JSDocs throughout the codebase#1835
Copilot wants to merge 2 commits intomainfrom
copilot/add-internal-jsdocs

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Apr 11, 2026

Summary

Adds JSDoc comments to all major public APIs across src/server/, src/typescript-generator/, src/repl/, and src/util/. No functional changes.

Original Prompt

Add JSDocs throughout the codebase.

Manual acceptance tests

  • Hover over Registry, Dispatcher, ModuleLoader, or ContextRegistry in an IDE — JSDoc tooltip appears with a meaningful description
  • Hover over Requirement.select() or Specification.fromFile()@param and @returns docs are shown
  • Hover over RouteBuilder.send() in the repl source — @throws annotations are visible
  • Hover over Config interface fields (e.g. alwaysFakeOptionals, buildCache) — inline field docs appear
  • No new TypeScript errors or test failures introduced (yarn test passes)

Tasks

  • Added class-level JSDoc to all major classes: Registry, ContextRegistry, Dispatcher, ModuleLoader, Transpiler, ModuleTree, ModuleDependencyGraph, ScenarioRegistry, FileDiscovery, Tools, Specification, Requirement, Coder, Script, Repository, OperationCoder, OperationTypeCoder, CodeGenerator, RouteBuilder, RawHttpClient
  • Documented all public methods with @param, @returns, and @throws where applicable
  • Documented all fields of the Config interface
  • Added function-level JSDoc to module-level exports: generate, writeApplyContextType, createResponseBuilder, createKoaApp, koaMiddleware, openapiMiddleware, isProxyEnabledForPath, jsonToXml, determineModuleKind, ensureDirectoryExists, readFile, runtimeCanExecuteErasableTs, escapePathForWindows, startRepl, createRouteFunction
  • Fixed a */ sequence inside a JSDoc body (*/**/*) that caused a parse error
  • Added changeset entry (patch)

Copilot AI linked an issue Apr 11, 2026 that may be closed by this pull request
Copilot AI changed the title [WIP] Add JSDocs throughout the codebase Add internal JSDocs throughout the codebase Apr 11, 2026
Copilot AI requested a review from pmcelhaney April 11, 2026 19:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add internal JSDocs

2 participants