Skip to content

Commit

Permalink
fits: fix doxygen warnings
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
PaulPrice committed Oct 4, 2017
1 parent 6486c12 commit 5d3072c
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 3 deletions.
1 change: 1 addition & 0 deletions doc/doxygen.conf.in
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,5 @@ EXCLUDE += src/geom/ellipses
EXCLUDE += src/detection/Psf.cc
EXCLUDE += src/detection/DoubleGaussianPsf.cc
EXCLUDE += src/fits.cc
EXCLUDE += src/fitsCompression.cc
EXCLUDE_SYMBOLS += _swig_property
7 changes: 4 additions & 3 deletions include/lsst/afw/fitsCompression.h
Original file line number Diff line number Diff line change
Expand Up @@ -377,7 +377,8 @@ class ImageScalingOptions {
std::vector<std::string> maskPlanes; ///< Mask planes to ignore when doing statistics
float quantizeLevel; ///< Divisor of the standard deviation for STDEV_* scaling
float quantizePad; ///< Number of stdev to allow on the low/high side (for STDEV_POSITIVE/NEGATIVE)
double bscale, bzero; ///< Manually specified BSCALE and BZERO (for MANUAL scaling)
double bscale; ///< Manually specified BSCALE (for MANUAL scaling)
double bzero; ///< Manually specified BZERO (for MANUAL scaling)

/// Default Ctor
///
Expand Down Expand Up @@ -417,7 +418,7 @@ class ImageScalingOptions {
ImageScalingOptions(int bitpix_, double bscale_=1.0, double bzero_=0.0)
: ImageScalingOptions(MANUAL, bitpix_, {}, 1, 4.0, 5.0, false, bscale_, bzero_) {}

//{
//@{
/// Determine the scaling for a particular image
///
/// @param[in] image Image for which to determine scaling
Expand All @@ -436,7 +437,7 @@ class ImageScalingOptions {
ndarray::Array<T const, N, N> const& image,
ndarray::Array<bool, N, N> const& mask
) const;
//}
//@}

private:
/// Convert image,mask to arrays
Expand Down

0 comments on commit 5d3072c

Please sign in to comment.