docs: add IDs to @requirement tags to fix Doxygen autolinking#5162
Merged
Conversation
Signed-off-by: Swastik Bose <cpswastik31@gmail.com>
Owner
|
Thank you! |
Contributor
Author
|
Thanks a lot Niels! This was my first PR! Thank you very much! |
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
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.
This PR fixes a documentation bug where the word "The" was being incorrectly identified as a requirement ID by Doxygen. This caused Doxygen's autolinking feature to turn every instance of the word "The" in the generated documentation into a hyperlink.
Changes:
REQ-JSON-01andREQ-JSON-02) to the@requirementtags initer_impl.hppandjson_reverse_iterator.hpp.single_include/nlohmann/json.hppfile.Why:
Doxygen's
@requirementcommand (often an alias for\xrefitem) expects the first argument to be a unique identifier. Without it, the first word of the description ("The") was used as the ID, leading to global autolinking of that word.