chore(docs): JSDoc completeness validation check#592
Open
Raina451 wants to merge 4 commits into
Open
Conversation
Adds a `docs:validate` script that runs TypeDoc's built-in notDocumented validation over the public API (Method, CallSignature, Parameter). Surfaces undocumented methods, missing/empty @param tags, and @param name mismatches without any custom parsing. Report-only for now (no treatValidationWarningsAsErrors) so it does not fail CI while existing gaps are cleaned up in follow-up work. Generated with Claude Code Co-Authored-By: Claude <noreply@anthropic.com>
Contributor
|
✅ No issues found. Checked for bugs and CLAUDE.md compliance. |
Flip typedoc.validation.json to treatValidationWarningsAsErrors and add a jsdoc-validation job to the PR Checks workflow. Expected to fail until the existing undocumented methods/parameters are documented or tagged @internal. Generated with Claude Code Co-Authored-By: Claude <noreply@anthropic.com>
![claude[bot]](https://avatars.githubusercontent.com/in/1236702?s=60&v=4){kind=small}
Raina451
marked this pull request as ready for review
July 10, 2026 07:55
Raina451
changed the title
vnaren23
reviewed
Jul 10, 2026
Contributor
|
✅ No issues found. Checked for bugs and CLAUDE.md compliance. |
Addresses review feedback — pins actions/checkout and actions/setup-node to full commit SHAs (with version comments) instead of floating @v4 tags, across both the new jsdoc-validation job and the existing jobs in the file. Generated with Claude Code Co-Authored-By: Claude <noreply@anthropic.com>
Contributor
|
✅ No issues found. Checked for bugs and CLAUDE.md compliance. |
- Add missing @param/@returns to error type guards and getErrorDetails - Add JSDoc to createAgentWithMethods; fix stale @param name on createEntityWithMethods - Document QueueServiceModel.getById options param (model + service) and drop the unknown @Signature tag from getAll - Document ConversationSessionMethods params and the UiPath constructor - Mark internal telemetry exports and error-class constructors @internal Clears all notDocumented findings; npm run docs:validate exits 0. Generated with Claude Code Co-authored-by: Claude <noreply@anthropic.com>
Contributor
|
✅ No issues found. Checked for bugs and CLAUDE.md compliance. |
|
vnaren23
approved these changes
Jul 14, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds a JSDoc completeness gate using TypeDoc's built-in
notDocumentedvalidation — no custom parsing, reuses the TypeDoc dependency already in the pipeline.It flags:
CallSignature)@param@paramtags whose name doesn't match a parameterWhy this approach
Evaluated
eslint-plugin-jsdoc,@microsoft/api-extractor, and a hand-rolled TS-compiler-API checker. TypeDoc wins: already installed, already runs onsrc/index.ts— a config file + one script line instead of a new toolchain or bespoke logic.Expected to fail initially
fix exisitng gaps in this pr: #593