docs: enhance examples with Doxygen tags and create Getting Started guide#655
Merged
Merged
Conversation
Add @file, @example, @brief, and @see tags to all 19 example .cpp files. Files that already had partial Doxygen blocks (config_example, crash_protection, integration_example, queue_capabilities_sample, queue_factory_sample, multi_process_monitoring_integration) are updated with consistent formatting and the missing @example/@see tags.
Contributor
📊 Performance Benchmark ResultsPerformance Benchmark ReportNo benchmark data available. ℹ️ No baseline reference availableThis is the first benchmark run or baseline file is missing. |
4 tasks
kcenon
added a commit
that referenced
this pull request
Apr 13, 2026
…uide (#655) * docs: add Doxygen example tags to existing examples Add @file, @example, @brief, and @see tags to all 19 example .cpp files. Files that already had partial Doxygen blocks (config_example, crash_protection, integration_example, queue_capabilities_sample, queue_factory_sample, multi_process_monitoring_integration) are updated with consistent formatting and the missing @example/@see tags. * docs: create Getting Started guide * docs: create API Quick Reference cheat sheet
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
@exampleDoxygen tags to existing code samples for improved documentation indexingTest plan
Closes #653