Removing all clever tricks and introducing duplicate code so doxygen can create docs #250
Conversation
This file contains 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
… from ygm::container::detail::base_batch_erase_key in order to make inherited member functions to show up in docs properly
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
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.