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

Fix Doxygen warnings #979

Merged
merged 4 commits into from
Jan 17, 2024

Conversation

turboencabulator
Copy link
Contributor

This fixes miscellaneous warnings from Doxygen, mostly about missing parameters and mismatched verbatim tags.

My editor is complaining about CRLF line endings in the *dmd* files so I've stripped those out, along with any trailing whitespace. Only these files had CRLF line endings and I'm not sure why git hasn't automatically been normalizing them.

sed -i 's/\s\+$//' SRC/*dmd* TESTING/EIG/*dmd*
Plus manually stripping empty lines at EOF.
SRC/cgedmdq.f90:548: warning: argument 'lzwork' from the argument list of cgedmdq has multiple @param documentation sections
SRC/zgedmdq.f90:546: warning: argument 'lzwork' from the argument list of zgedmdq has multiple @param documentation sections
SRC/zgedmd.f90:213: warning: reached end of comment while inside a \verbatim block; check for missing \endverbatim tag!
SRC/zgedmdq.f90:710: warning: unexpected command endverbatim
SRC/slaqp3rk.f:585: warning: unexpected command endverbatim
SRC/dlaqp3rk.f:585: warning: unexpected command endverbatim
SRC/claqp3rk.f:579: warning: unexpected command endverbatim
SRC/zlaqp3rk.f:579: warning: unexpected command endverbatim
Copy link

codecov bot commented Jan 17, 2024

Codecov Report

Attention: 1563 lines in your changes are missing coverage. Please review.

Comparison is base (5d705a1) 0.00% compared to head (dead4e4) 0.00%.

Files Patch % Lines
SRC/dgedmd.f90 0.00% 258 Missing ⚠️
SRC/sgedmd.f90 0.00% 258 Missing ⚠️
SRC/cgedmd.f90 0.00% 257 Missing ⚠️
SRC/zgedmd.f90 0.00% 256 Missing ⚠️
SRC/zgedmdq.f90 0.00% 138 Missing ⚠️
SRC/cgedmdq.f90 0.00% 136 Missing ⚠️
SRC/dgedmdq.f90 0.00% 130 Missing ⚠️
SRC/sgedmdq.f90 0.00% 130 Missing ⚠️
Additional details and impacted files
@@           Coverage Diff           @@
##           master     #979   +/-   ##
=======================================
  Coverage    0.00%    0.00%           
=======================================
  Files        1930     1930           
  Lines      190421   190421           
=======================================
  Misses     190421   190421           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@langou langou merged commit 0a3aa4d into Reference-LAPACK:master Jan 17, 2024
14 checks passed
@turboencabulator turboencabulator deleted the doxygen-warnings branch January 17, 2024 06:53
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