docs: backfill JSDoc documentation for undocumented declarations#154
Open
bsamuels453 wants to merge 1 commit intosync-serverfrom
Open
docs: backfill JSDoc documentation for undocumented declarations#154bsamuels453 wants to merge 1 commit intosync-serverfrom
bsamuels453 wants to merge 1 commit intosync-serverfrom
Conversation
Add JSDoc comments to ~148 undocumented functions, classes, interfaces, enums, and type aliases across 13 source files. This brings documentation coverage from ~66% to near-complete coverage. Files updated: - src/types.ts: validation helpers, type predicates, interfaces - src/externalTypes.ts: FromLocationResponse interface - src/extension.ts: activate and openResource functions - src/decorationManager.ts: decoration factory methods - src/multiConfigs.ts: MultipleSavedFindingsTree class and methods - src/resolvedFindings.ts: ResolvedEntriesTree/ResolvedEntries classes - src/webview/webviewMessageTypes.ts: all message type interfaces - src/webview/findingDetailsMain.ts: main and field change handlers - src/webview/gitConfigMain.ts: main and change handlers - src/panels/findingDetailsPanel.ts: provider class and methods - src/panels/gitConfigPanel.ts: provider class and methods - src/panels/syncConfigPanel.ts: resolveWebviewView method - src/codeMarker.ts: CodeMarker, DragAndDropController, AuditMarker Nightshift-Task: docs-backfill Nightshift-Ref: https://github.com/marcus/nightshift Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
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
1 participant
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.
Summary
Files Modified
src/types.tssrc/codeMarker.tssrc/multiConfigs.tssrc/resolvedFindings.tssrc/decorationManager.tssrc/extension.tsactivateandopenResourcefunctionssrc/externalTypes.tsFromLocationResponseinterfacesrc/webview/webviewMessageTypes.tssrc/webview/findingDetailsMain.tssrc/webview/gitConfigMain.tssrc/panels/findingDetailsPanel.tssrc/panels/gitConfigPanel.tssrc/panels/syncConfigPanel.tsresolveWebviewViewmethodTest plan
npm run lintpassesnpm run compilepassesnpm testpasses (199 tests)🤖 Generated with Claude Code