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

Docs: Tagfile (Doxygen) #610

Merged
merged 3 commits into from
Nov 2, 2021
Merged

Conversation

ax3l
Copy link
Member

@ax3l ax3l commented Oct 22, 2021

Interlink the HiPACE++ Doxygen with the AMReX Doxygen pages.

Also generate a HiPACE++ tagfile. Used as an anchor in external projects.

Same as ECP-WarpX/WarpX#2463

  • Small enough (< few 100s of lines), otherwise it should probably be split into smaller PRs
  • Tested (describe the tests in the PR description)
  • Runs on GPU (basic: the code compiles and run well with the new module)
  • Contains an automated test (checksum and/or comparison with theory)
  • Documented: all elements (classes and their members, functions, namespaces, etc.) are documented
  • Constified (All that can be const is const)
  • Code is clean (no unwanted comments, )
  • Style and code conventions are respected at the bottom of https://github.com/Hi-PACE/hipace
  • Proper label and GitHub project, if applicable

Before (Dead Ends for AMReX Types)

Screenshot from 2021-10-22 09-51-50

After (Interlinked)

Screenshot from 2021-10-22 10-12-15

@ax3l ax3l added the documentation Improvements or additions to documentation label Oct 22, 2021
@ax3l ax3l force-pushed the doc-doxytag branch 2 times, most recently from 50eb7e7 to de667b9 Compare October 22, 2021 17:12
Interlink the HiPACE++ Doxygen with the AMReX Doxygen pages.

Also generate a HiPACE++ tagfile. Used as an anchor in external projects.
@MaxThevenet MaxThevenet merged commit b1ca79b into Hi-PACE:development Nov 2, 2021
@ax3l ax3l deleted the doc-doxytag branch November 30, 2021 06:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants