Add Doxygen comments to .h files in tests/Utils - #17
Open
MichaelBCG wants to merge 1 commit into
Open
Conversation
Author
|
Also see #18 (specifying PREDEFINED tag in the Doxyfile) |
MichaelBCG
referenced
this pull request
in MichaelBCG/devops_ue
Apr 17, 2024
Add Doxygen comments to .h files in tests/Utils
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
1 participant
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 pull request addresses the request outlined in this part of the video by adding Doxygen comments to the .h files in the tests/Utils directory.
The comments have been generated using ChatGPT and are intended as a starting point for generating documentation for these files using Doxygen.
I have also tested the documentation generation process on my local environment to ensure its functionality.
Additionally, to ensure that Doxygen generates documentation from code within conditional blocks utilizing macro names, it's necessary to specify these macro names in the PREDEFINED tag within the Doxygen configuration file.
For example, in TestUtils.h, we utilize #if WITH_AUTOMATION_TESTS, so it's crucial to specify "WITH_AUTOMATION_TESTS" in the PREDEFINED tag of the Doxyfile to ensure that Doxygen processes the code within this conditional block correctly:
PREDEFINED = WITH_AUTOMATION_TESTSThis pull request does NOT include changes for PREDEFINED tag in the Doxyfile.