Removes template specializations for ygm::container::detail::base_iteration and splits into _value and _key_value names. This leads to _value and _key_value variants of the ygm::container::detail::*_proxy classes. This is being done to allow doxygen to understand the code well enough to make reasonable documentation.
A similar split was performed with ygm::container::detail::base_batch_erase. Because the _key_value variant is still inheriting from the _key variant, not all of the generated erase() functions end up in the Doxygen output. This still needs to be pulled apart (with more duplicated code).
Developing locally, I encountered a bug in doxygen that makes it unable to handle trailing requires clauses, causing most of the functions to remain undocumented. This was fixed in doxygen here. A new enough version of doxygen should be available on Ubuntu 24.04, but I'm not sure if this is being used by readthedocs. If it's not by default, it looks like it is possible to set our repo to use 24.04 for generating docs.
Removes template specializations for
ygm::container::detail::base_iterationand splits into_valueand_key_valuenames. This leads to_valueand_key_valuevariants of theygm::container::detail::*_proxyclasses. This is being done to allow doxygen to understand the code well enough to make reasonable documentation.A similar split was performed with
ygm::container::detail::base_batch_erase. Because the_key_valuevariant is still inheriting from the_keyvariant, not all of the generatederase()functions end up in the Doxygen output. This still needs to be pulled apart (with more duplicated code).Developing locally, I encountered a bug in doxygen that makes it unable to handle trailing
requiresclauses, causing most of the functions to remain undocumented. This was fixed in doxygen here. A new enough version of doxygen should be available on Ubuntu 24.04, but I'm not sure if this is being used by readthedocs. If it's not by default, it looks like it is possible to set our repo to use 24.04 for generating docs.