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

Doxygen CI: Warnings as Error #3560

Open
wants to merge 9 commits into
base: development
Choose a base branch
from

Conversation

ax3l
Copy link
Member

@ax3l ax3l commented Dec 9, 2022

Make sure that no Doxygen warnings get in, as we do in other CI runs already.

Depends on AMReX-Codes/amrex#3061

@ax3l ax3l added component: documentation Docs, readme and manual component: tests Tests and CI labels Dec 9, 2022
@ax3l ax3l force-pushed the ci-doxygen-werror branch from bc910c2 to d615120 Compare December 20, 2022 18:15
@ax3l ax3l requested a review from dpgrote December 20, 2022 18:16
@ax3l ax3l force-pushed the ci-doxygen-werror branch from d615120 to 69a2954 Compare January 2, 2023 13:15
@ax3l ax3l force-pushed the ci-doxygen-werror branch from 69a2954 to d9bd694 Compare January 12, 2023 00:20
@ax3l ax3l requested a review from RemiLehe January 12, 2023 00:27
Copy link
Member

@dpgrote dpgrote left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@ax3l ax3l mentioned this pull request Jan 12, 2023
@ax3l ax3l force-pushed the ci-doxygen-werror branch from 72198c8 to 5568331 Compare January 17, 2023 18:14
@EZoni
Copy link
Member

EZoni commented Dec 6, 2024

Found this old PR and just merged development in to see if we can finalize it easily.

@EZoni EZoni force-pushed the ci-doxygen-werror branch 3 times, most recently from 4492996 to 440d9ed Compare December 6, 2024 23:55
@EZoni
Copy link
Member

EZoni commented Dec 7, 2024

FYI, still struggling to "fix" this:

/home/runner/work/WarpX/WarpX/Source/Utils/ParticleUtils.H:36: error: no matching file member found for 
amrex::DenseBins< ParticleTileDataType > ParticleUtils::findParticlesInEachCell(int lev, const amrex::MFIter &mfi, WarpXParticleContainer::ParticleTileType &ptile)
Possible candidates:
 'amrex::DenseBins< ParticleTileDataType > findParticlesInEachCell(int lev, const amrex::MFIter &mfi, ParticleTileType &ptile)' at line 40 of file /home/runner/work/WarpX/WarpX/Source/Utils/ParticleUtils.cpp
 (warning treated as error, aborting now)

@ax3l ax3l force-pushed the ci-doxygen-werror branch from 440d9ed to 4e593df Compare January 14, 2025 17:57
@EZoni
Copy link
Member

EZoni commented Jan 14, 2025

I'd be happy to finalize this, unfortunately when I tried in December I ran into the weird "error" (which seems to me like a false positive) described in #3560 (comment) above, and I could not figure out how to fix it. We can see how it goes now, after the latest rebase.

@ax3l
Copy link
Member Author

ax3l commented Jan 14, 2025

We could try to check if the .H and .cpp use the same namespace::prefixes:: for their types in arguments and that the include of the .H file is in the respective .cpp file. I see something similar in the implicit solver.

@EZoni
Copy link
Member

EZoni commented Feb 4, 2025

Since I saw some momentum on the Doxygen side of things in AMReX, ImpactX, etc., I merged development again here to see where we stand.

@EZoni
Copy link
Member

EZoni commented Feb 5, 2025

Despite trying many manual fixes, I still see errors like the following one, which I have not managed to fix yet. The two signatures seem identical, except for the namespace prefix ParticleUtils::, which I thought would be automatically propagated, given that everything seems to be included correctly in the source code:

/home/runner/work/WarpX/WarpX/Source/Utils/ParticleUtils.H:36: error: no matching file member found for 
amrex::DenseBins< ParticleTileDataType > ParticleUtils::findParticlesInEachCell(int lev, const amrex::MFIter &mfi, WarpXParticleContainer::ParticleTileType &ptile)
Possible candidates:
 'amrex::DenseBins< ParticleTileDataType > findParticlesInEachCell(int lev, const amrex::MFIter &mfi, WarpXParticleContainer::ParticleTileType &ptile)' at line 40 of file /home/runner/work/WarpX/WarpX/Source/Utils/ParticleUtils.cpp
 (warning treated as error, aborting now)

@AlexanderSinn @WeiqunZhang

Is this similar to the issue you fixed in AMReX recently or was it something different?

@AlexanderSinn
Copy link
Member

Its a different issue. Maybe it would help to remove the using declaration of ParticleTileType and ParticleTileDataType from the cpp file, since they are already in the header.

@EZoni
Copy link
Member

EZoni commented Feb 5, 2025

Since the issue persists, I was looking more into this and also noted that I don't seem to see a problem when I run .github/workflows/source/doxygen locally. I see that my Doxygen version is 1.9.8, while the version used in our GitHub Actions workflow is 1.9.1.

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: tests Tests and CI
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants