small initialize/finalize adjustments#46
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR refactors the initialize and finalize functions to make them symmetric by providing template-based free functions for both. The PR also hides the registry::initialize and registry::finalize member functions from public documentation and removes initialize from the aliases namespace since it's typically called only once from main.
Key changes:
- Added a templated free function
finalize<Registry>()to match the existinginitialize<Registry>()pattern - Removed
initializefrom theboost::openmethod::aliasesnamespace - Moved documentation from
registry::finalizemember function to the new free functionfinalize
Reviewed Changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| test/test_dispatch.cpp | Updated test to use new finalize<test_registry>() syntax instead of test_registry::finalize() |
| include/boost/openmethod/preamble.hpp | Removed documentation comments from registry::finalize member function |
| include/boost/openmethod/initialize.hpp | Added templated finalize free function with comprehensive documentation; removed initialize from aliases namespace |
| doc/mrdocs.yml | Added exclusions to hide registry::initialize and registry::finalize from generated documentation |
| doc/modules/ROOT/examples/shared_libs/static_main.cpp | Updated to use fully qualified boost::openmethod::initialize() instead of unqualified initialize() |
| doc/modules/ROOT/examples/shared_libs/indirect_main.cpp | Updated all three calls to use fully qualified boost::openmethod::initialize() |
| doc/modules/ROOT/examples/shared_libs/dynamic_main.cpp | Updated all three calls to use fully qualified boost::openmethod::initialize() |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## develop #46 +/- ##
===========================================
- Coverage 93.03% 92.03% -1.00%
===========================================
Files 40 40
Lines 2713 2838 +125
Branches 1226 1354 +128
===========================================
+ Hits 2524 2612 +88
- Misses 159 187 +28
- Partials 30 39 +9
... and 3 files with indirect coverage changes Continue to review full report in Codecov by Sentry.
🚀 New features to boost your workflow:
|
initializeandfinalizesymmetric.registryinitializeshould not go inaliases, as that is for frequently used names only andinitializeis typically called only frommain.