Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add doxygen biref to ale.h #1017

Merged
merged 3 commits into from
Feb 9, 2024
Merged

Add doxygen biref to ale.h #1017

merged 3 commits into from
Feb 9, 2024

Conversation

hepap
Copy link
Collaborator

@hepap hepap commented Feb 9, 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.

@hepap hepap requested a review from blaisb February 9, 2024 15:48
@blaisb blaisb merged commit 23dbe56 into master Feb 9, 2024
8 checks passed
@blaisb blaisb deleted the doxygen_ale branch February 9, 2024 16:00
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
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants