docs: add @throws ZVecException annotations on all FFI-calling methods (closes #62)#161
Merged
Conversation
closes #62) - Added @throws ZVecException to ~122 methods across 8 source files - Methods without existing PHPDoc: added single-line /** @throws ZVecException */ - Methods with existing PHPDoc: added @throws inside existing doc block - Skipped: __destruct, __clone, getHandle, ffi, checkStatus, private helpers - All php -l syntax checks pass
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.
Description
Closes #62
Changes
@throws ZVecExceptionto ~122 methods across 8 source files:ZVec.php(40 annotations) — all public methods callingcheckStatus()orffi()ZVecSchema.php(30 annotations) —__construct,setMaxDocCountPerSegment, alladd*methodsZVecDoc.php(4 annotations) —setSparseVectorFp32,setSparseVectorFp16,serialize,deserializeZVecIndexParams.php(6 annotations) — all 6 factory methodsZVecVectorQuery.php(13 annotations) —__construct, all setter methodsZVecGroupByVectorQuery.php(12 annotations) —__construct, all setter methodsZVecFieldSchema.php(13 annotations) — all getter/introspection methodsZVecCollectionStats.php(4 annotations) —getDocCount,getIndexCount,getIndexName,getIndexCompleteness@throws ZVecExceptioninside the doc block/** @throws ZVecException */__destruct,__clone,getHandle(),ffi(),checkStatus(), private helpersTesting
php -lsyntax checkCode Review