chore: add comments to C++ client to adapt Doxygen #2233
Conversation
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
There was a problem hiding this comment.
Pull request overview
This PR aims to make the Pegasus C++ client easier to document with Doxygen by adding Doxygen-friendly comments and introducing a Doxygen config/guide under src/client_lib/doxygen/.
Changes:
- Added extensive Doxygen comment blocks to C++ client headers (
pegasus_client_impl.h,pegasus_client_factory_impl.h). - Added a Doxygen configuration file and a short generation guide under
src/client_lib/doxygen/. - Introduced a Doxygen group (
pegasus_cpp_client) and file-level@fileheaders.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 10 comments.
| File | Description |
|---|---|
| src/client_lib/pegasus_client_impl.h | Adds Doxygen file header, group tags, and API comments across client/scanner declarations. |
| src/client_lib/pegasus_client_factory_impl.h | Adds Doxygen file header, group tags, and factory method documentation. |
| src/client_lib/doxygen/README.md | Adds instructions for generating Doxygen docs. |
| src/client_lib/doxygen/Doxyfile | Adds a Doxygen configuration targeting the C++ client headers. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
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.
No description provided.