Skip to content

docs: add @throws ZVecException PHPDoc to all FFI-calling methods (closes #62)#163

Merged
s2x merged 1 commit into
mainfrom
feat/issue-62-throws-annotations
Jul 8, 2026
Merged

docs: add @throws ZVecException PHPDoc to all FFI-calling methods (closes #62)#163
s2x merged 1 commit into
mainfrom
feat/issue-62-throws-annotations

Conversation

@s2x

@s2x s2x commented Jul 8, 2026

Copy link
Copy Markdown
Contributor

Description

Closes #62

Changes

  • Added @throws ZVecException On FFI error PHPDoc annotation to all public methods that call FFI across 4 source files
  • src/ZVec.php — 57 methods annotated (create/open/query, addColumn*, version API, etc.)
  • src/ZVecSchema.php — 38 methods annotated (all add* methods including deprecated aliases)
  • src/ZVecDoc.php — 65 methods annotated (all set*/get*/has* methods, constructor, serialize/deserialize, etc.)
  • src/ZVecIndexParams.php — 6 methods annotated (forHnsw, forFlat, forIvf, forVamana, forInvert, forHnswRabitq)
  • CHANGELOG.md — added entry under [Unreleased] > ### Added

Testing

  • Builds locally (php -l on all 4 files)
  • All existing tests pass (47 failures pre-existing, same as before changes)
  • No test database leftovers

Code Review

  • Passed subagent code review
  • All review comments addressed

@s2x s2x self-assigned this Jul 8, 2026
@s2x
s2x merged commit 14b19e4 into main Jul 8, 2026
3 checks passed
@s2x
s2x deleted the feat/issue-62-throws-annotations branch July 8, 2026 08:45
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.

DOC-003: Missing @throws ZVecException on All FFI-Calling Methods

1 participant