Commit 02aa40a2c269644da844d1f8dc1bb602aff02d05

Authored by knodlseder
1 parent 61c1ad23

correct Doxygen documentation

src/sky/GException_sky.cpp
@@ -255,6 +255,8 @@ GException::wcs_hpx_bad_ordering::wcs_hpx_bad_ordering(std::string origin, @@ -255,6 +255,8 @@ GException::wcs_hpx_bad_ordering::wcs_hpx_bad_ordering(std::string origin,
255 * @brief Singular matrix encountered 255 * @brief Singular matrix encountered
256 * 256 *
257 * @param[in] origin Method that throws the error. 257 * @param[in] origin Method that throws the error.
  258 + * @param[in] naxis Number of matrix axes.
  259 + * @param[in] mat Matrix (stored in vector).
258 ***************************************************************************/ 260 ***************************************************************************/
259 GException::wcs_singular_matrix::wcs_singular_matrix(std::string origin, 261 GException::wcs_singular_matrix::wcs_singular_matrix(std::string origin,
260 int naxis, 262 int naxis,
src/sky/GWcslib.cpp
@@ -1783,7 +1783,7 @@ void GWcslib::cel_s2x(int nlng, int nlat, int sll, int sxy, @@ -1783,7 +1783,7 @@ void GWcslib::cel_s2x(int nlng, int nlat, int sll, int sxy,
1783 * @param[in] nphi Phi vector length. 1783 * @param[in] nphi Phi vector length.
1784 * @param[in] ntheta Theta vector length (0=no replication). 1784 * @param[in] ntheta Theta vector length (0=no replication).
1785 * @param[in] spt Input vector step. 1785 * @param[in] spt Input vector step.
1786 - * @param[in] sxy Output vector step. 1786 + * @param[in] sll Output vector step.
1787 * @param[in] phi Longitude in the native coordinate system of the 1787 * @param[in] phi Longitude in the native coordinate system of the
1788 * projection [deg]. 1788 * projection [deg].
1789 * @param[in] theta Latitude in the native coordinate system of the 1789 * @param[in] theta Latitude in the native coordinate system of the
@@ -1990,7 +1990,7 @@ void GWcslib::sph_x2s(int nphi, int ntheta, int spt, int sll, @@ -1990,7 +1990,7 @@ void GWcslib::sph_x2s(int nphi, int ntheta, int spt, int sll,
1990 /***********************************************************************//** 1990 /***********************************************************************//**
1991 * @brief Rotation in the pixel-to-world direction 1991 * @brief Rotation in the pixel-to-world direction
1992 * 1992 *
1993 - * @param[in] nlat Longitude vector length. 1993 + * @param[in] nlng Longitude vector length.
1994 * @param[in] nlat Latitude vector length (0=no replication). 1994 * @param[in] nlat Latitude vector length (0=no replication).
1995 * @param[in] sll Input vector step. 1995 * @param[in] sll Input vector step.
1996 * @param[in] spt Output vector step. 1996 * @param[in] spt Output vector step.
@@ -2868,7 +2868,9 @@ double GWcslib::atan2d(const double& y, const double& x) const @@ -2868,7 +2868,9 @@ double GWcslib::atan2d(const double& y, const double& x) const
2868 /***********************************************************************//** 2868 /***********************************************************************//**
2869 * @brief Compute sine and cosine of angle in degrees 2869 * @brief Compute sine and cosine of angle in degrees
2870 * 2870 *
2871 - * @param[in] angle Angle in degrees 2871 + * @param[in] angle Angle [degrees].
  2872 + * @param[out] s Sine of angle.
  2873 + * @param[out] c Cosine of angle.
2872 * 2874 *
2873 * Code adapted from wcstrig.c::sincosd(). 2875 * Code adapted from wcstrig.c::sincosd().
2874 ***************************************************************************/ 2876 ***************************************************************************/