DM-12905: fits: fix doxygen warnings #282
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
fitsCompression.cc is causing doxygen warnings:
documented symbol `ImageScale lsst::afw::fits::ImageScalingOptions::determine' was not declared or defined.
This appears to be due to a bug in doxygen (perhaps having to do with
underscores at the end of variable names?). To deal with this, corrected
the grouping markup for ImageScalingOptions::determine and put
fitsCompression.cc on the doxygen exclusion list. This doesn't produce
correct docs (e.g., ImageScalingOptions::determine isn't listed as a
member function) but it's no worse than it was before, more correct and
doesn't produce a warning.
PaulPrice
force-pushed
the
tickets/DM-12095
branch
from
5d3072c
to
0f92493
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
fitsCompression.cc is causing doxygen warnings:
This appears to be due to a bug in doxygen (perhaps having to do with
underscores at the end of variable names?). To deal with this, corrected
the grouping markup for ImageScalingOptions::determine and put
fitsCompression.cc on the doxygen exclusion list. This doesn't produce
correct docs (e.g., ImageScalingOptions::determine isn't listed as a
member function) but it's no worse than it was before, more correct and
doesn't produce a warning.