Add doxygen biref to ale.h #1017
Merged
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
blaisb
approved these changes
Feb 9, 2024
M-Badri
pushed a commit
to M-Badri/lethe
that referenced
this pull request
Sep 29, 2024
Description of the problem Doxygen missing in ale.h Description of the solution Add the required description. How Has This Been Tested? compile and inspect the doxygen output. Future changes parameters.h is next. Comments Since it is in the parameters namespace, the same description will be use in the parameters.h for declare and parse. I wanted to avoid the repetition of the description for declare and parse, but sometimes they differ a little bit, so I guess we should add the description everywher. Former-commit-id: 23dbe56
blaisb
pushed a commit
that referenced
this pull request
Sep 30, 2024
Description of the problem Doxygen missing in ale.h Description of the solution Add the required description. How Has This Been Tested? compile and inspect the doxygen output. Future changes parameters.h is next. Comments Since it is in the parameters namespace, the same description will be use in the parameters.h for declare and parse. I wanted to avoid the repetition of the description for declare and parse, but sometimes they differ a little bit, so I guess we should add the description everywher. Former-commit-id: 23dbe56
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.
Description of the problem
Description of the solution
How Has This Been Tested?
Future changes
Comments