Improve selected API documentation - #375
Merged
Merged
Conversation
Co-authored-by: Ihar Yermalayeu <ermig1979@gmail.com>
Contributor
There was a problem hiding this comment.
Pull request overview
This pull request improves the Doxygen/C API documentation in src/Simd/SimdLib.h for a set of Synet activation/utility APIs, texture/transform APIs, UYVY conversion, warp affine, and Winograd helper routines, aligning the descriptions and pseudo-code more closely with the actual implementations. It also updates the 2026 release notes to reflect these documentation improvements.
Changes:
- Refined/expanded API descriptions and algorithm details for selected Synet, texture, transform, UYVY, warp affine, and Winograd functions.
- Clarified parameter semantics/constraints (e.g., scalar pointer parameters, padding constraints, supported formats).
- Added corresponding “Improving” entries to
docs/2026.html.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| src/Simd/SimdLib.h | Updates and clarifies Doxygen comments/pseudo-code for multiple public C APIs to better match implementation behavior and constraints. |
| docs/2026.html | Adds release-note items documenting the improved function descriptions. |
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
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
SimdLib.hdescriptions for selected Synet activation/utility, texture, transform, UYVY, warp affine, and Winograd APIs based on their implementations.docs/2026.htmlrelease notes with the improved documentation entries.Testing
git diff --check