Skip to content

Improve Background function descriptions in SimdLib.hpp - #816

Merged
ermig1979 merged 1 commit into
devfrom
cursor/improve-background-docs-3d4e
Aug 4, 2026
Merged

Improve Background function descriptions in SimdLib.hpp#816
ermig1979 merged 1 commit into
devfrom
cursor/improve-background-docs-3d4e

Conversation

@ermig1979

Copy link
Copy Markdown
Owner

Summary

  • Improve Doxygen descriptions for C++ wrappers BackgroundGrowRangeSlow, BackgroundGrowRangeFast, BackgroundIncrementCount, BackgroundAdjustRange (both overloads), BackgroundShiftRange (both overloads), and BackgroundInitMask in src/Simd/SimdLib.hpp.
  • Align short descriptions and formulas with actual implementation behavior (including corrected BackgroundShiftRange shift math, unconditional counter reset in masked BackgroundAdjustRange, and src/dst semantics in BackgroundInitMask).
  • Add matching documentation entries under release 7.2.165 in docs/2026.html.

Testing

  • Not run (documentation-only change; test suite explicitly not required for this task).
  • Verified changed files are limited to src/Simd/SimdLib.hpp and docs/2026.html.
Open in Web Open in Cursor 

Align C++ wrapper Doxygen docs with implementation behavior and the
improved C API wording, and record the changes in release 7.2.165 notes.

Co-authored-by: Ihar Yermalayeu <ermig1979@gmail.com>
@ermig1979
ermig1979 marked this pull request as ready for review August 4, 2026 11:34
@ermig1979
ermig1979 merged commit 51611b8 into dev Aug 4, 2026
1 check passed
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.

2 participants