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) #2463

Merged
merged 2 commits into from
Oct 22, 2021
Merged

Docs: Tagfile (Doxygen) #2463

merged 2 commits into from
Oct 22, 2021

Conversation

ax3l
Copy link
Member

@ax3l ax3l commented Oct 21, 2021

Interlink the WarpX Doxygen with the AMReX Doxygen pages.

Also generate a WarpX/ABLASTR tagfile. Used as an anchor in external projects.

Before

Screenshot from 2021-10-21 15-44-58

After

Screenshot from 2021-10-21 15-44-48

Generate a tagfile.
Used as anchor in external projects.
@ax3l ax3l added the component: documentation Docs, readme and manual label Oct 21, 2021
@ax3l ax3l added the component: third party Changes in WarpX that reflect a change in a third-party library label Oct 21, 2021
Link AMReX objects to the AMReX doxygen page via its latest
Doxygen tagfile.
@ax3l ax3l requested a review from RemiLehe October 22, 2021 16:45
@ax3l ax3l requested a review from MaxThevenet October 22, 2021 16:46
@RemiLehe RemiLehe merged commit 339bd48 into ECP-WarpX:development Oct 22, 2021
@ax3l ax3l mentioned this pull request Oct 22, 2021
9 tasks
@ax3l ax3l deleted the doc-doxytag branch October 22, 2021 17:18
dpgrote pushed a commit to dpgrote/WarpX that referenced this pull request Nov 29, 2021
* Docs: Tagfile (Doxygen)

Generate a tagfile.
Used as anchor in external projects.

* Doxygen Interlink: External AMReX Tagfile

Link AMReX objects to the AMReX doxygen page via its latest
Doxygen tagfile.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component: documentation Docs, readme and manual component: third party Changes in WarpX that reflect a change in a third-party library
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants