Skip to content

docs(api): add TSDoc comments for API documentation - #48

Merged
jsahleen merged 1 commit into
mainfrom
msg-47
Jul 21, 2026
Merged

docs(api): add TSDoc comments for API documentation#48
jsahleen merged 1 commit into
mainfrom
msg-47

Conversation

@jsahleen

Copy link
Copy Markdown
Collaborator

Summary

  • Add TSDoc comments to classes, properties, methods, types, and constants so TypeDoc can generate complete API docs (#47).
  • Export NoteTypes, MsgProjectSettings, MsgLocalesSettings, and MsgTargetLocalesSettings so referenced types appear in the generated docs (additive public API; non-breaking).
  • Tests skipped for comment-only changes; existing suite remains green at 100% coverage.

Test plan

  • npm test
  • npx tsc --noEmit
  • npm run build
  • npm run coverage (100%)
  • npm run docs (no TypeDoc warnings)

Made with Cursor

Document classes, properties, methods, types, and constants so
TypeDoc can generate complete API docs. Export NoteTypes and
project settings types referenced by the public surface.

Refs #47

Co-authored-by: Cursor <cursoragent@cursor.com>
@jsahleen
jsahleen marked this pull request as ready for review July 21, 2026 01:37
@jsahleen
jsahleen merged commit 4cb0032 into main Jul 21, 2026
1 check passed
@jsahleen
jsahleen deleted the msg-47 branch July 23, 2026 00:17
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.

1 participant