Skip to content

Conversation

@Nit2007
Copy link

@Nit2007 Nit2007 commented Feb 4, 2026

Documentation Enhancements

The stored_size option is powerful but easy to misinterpret as being limited to unsigned char.
A short note helps users understand that they can choose a larger integral type when they need more capacity while still reducing overhead compared to size_t.

The gcd() function already had informal comments; converting them to structured Doxygen makes the intent, preconditions, and complexity clearer and consistent with the rest of the codebase.

Both changes are documentation-only and do not affect runtime behavior.

Summary

This PR makes two small documentation improvements in Boost.Container:
1.Clarifies the stored_size option in doc_custom_vector.cpp by explicitly mentioning alternative integral types (unsigned short, unsigned int) and the memory–capacity tradeoff they provide.
2.Adds Doxygen-style documentation to the internal gcd() utility in math_functions.hpp, improving readability and generated reference docs without changing behavior.

Additional note

I’m interested to spend more time contributing to Boost.Container and would be glad to focus on specific areas, documentation gaps, or small fixes that maintainers consider useful or high priority.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant