docs: document memory ownership and lifecycle in C-API#4511
Merged
stweil merged 1 commit intotesseract-ocr:mainfrom Feb 13, 2026
Merged
docs: document memory ownership and lifecycle in C-API#4511stweil merged 1 commit intotesseract-ocr:mainfrom
stweil merged 1 commit intotesseract-ocr:mainfrom
Conversation
zdenop
approved these changes
Feb 13, 2026
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.
The current C-API documentation in capi.h is insufficient regarding memory management and object lifecycle, often leading to memory leaks or segmentation faults when implemented in C or via FFI (like Python's ctypes).
This PR updates the Doxygen comments to:
These changes improve the developer experience and system stability for anyone using the Tesseract C-API.