[REFACTOR] Clarify public vs internal buffer APIs#317
Merged
Conversation
- Add @public tags to public API headers (thread_local_buffer.h, time_series_buffer.h, socket_buffer_collector.h) - Enhance @internal documentation in internal headers (ring_buffer.h, buffering_strategy.h, buffer_manager.h) - Add C++20 module migration notes to all buffer headers - Add warning messages to prevent direct use of internal APIs Part of #313
kcenon
added a commit
that referenced
this pull request
Apr 13, 2026
* docs(buffer): add public/internal API documentation to buffer headers - Add @public tags to public API headers (thread_local_buffer.h, time_series_buffer.h, socket_buffer_collector.h) - Enhance @internal documentation in internal headers (ring_buffer.h, buffering_strategy.h, buffer_manager.h) - Add C++20 module migration notes to all buffer headers - Add warning messages to prevent direct use of internal APIs Part of #313 * docs(changelog): add buffer API clarification changes Update CHANGELOG.md and CHANGELOG_KO.md with #313 changes: - Document public/internal API documentation additions - Document C++20 module migration notes - Document buffer layer preparation for module partitioning Part of #313
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.
Summary
Changes
Public API Headers (include/)
thread_local_buffer.h- Added @public documentation and module migration notestime_series_buffer.h- Added @public documentation and module migration notessocket_buffer_collector.h- Added @public documentation and module migration notesInternal API Headers (src/utils/)
ring_buffer.h- Enhanced @internal documentation with warningsbuffering_strategy.h- Enhanced @internal documentation with warningsbuffer_manager.h- Enhanced @internal documentation with warningsDocumentation
Test plan
Closes #313