From 1c7cb6008bb09150e95cac19c5f8cb13792d07ee Mon Sep 17 00:00:00 2001 From: Jürgen Knödlseder Date: Fri, 4 Dec 2020 11:47:49 +0100 Subject: [PATCH] Fix some Doxygen issues --- include/GResponseVectorCache.hpp | 6 +++--- inst/com/include/GCOMEventBin.hpp | 2 +- inst/com/src/GCOMResponse.cpp | 12 +++++------- inst/cta/src/cta_helpers_response_stacked_vector.cpp | 9 ++++++++- src/obs/GEnergies.cpp | 2 +- src/obs/GResponse.cpp | 10 +++++----- src/sky/GSkyDirs.cpp | 2 +- src/sky/GSkyMap.cpp | 2 -- 8 files changed, 24 insertions(+), 21 deletions(-) diff --git a/include/GResponseVectorCache.hpp b/include/GResponseVectorCache.hpp index 8f97822..4012789 100644 --- a/include/GResponseVectorCache.hpp +++ b/include/GResponseVectorCache.hpp @@ -115,11 +115,11 @@ bool GResponseVectorCache::is_empty(void) const /***********************************************************************//** - * @brief Remove cache for source + * @brief Returns size of vector chache * - * @param[in] name Source name. + * @return Size of vector cache. * - * Remove cache for source with @p name. + * Returns the number of vectors that are stored in the vector cache. ***************************************************************************/ inline int GResponseVectorCache::size(void) const diff --git a/inst/com/include/GCOMEventBin.hpp b/inst/com/include/GCOMEventBin.hpp index cd26981..4061b0b 100644 --- a/inst/com/include/GCOMEventBin.hpp +++ b/inst/com/include/GCOMEventBin.hpp @@ -135,7 +135,7 @@ const int& GCOMEventBin::index(void) const /***********************************************************************//** * @brief Set bin index * - * @return Bin index. + * @param[in] index Bin index. * * Set the index of the event bin if the bin is part of an event cube. If * the event is not part of an event cube the index should be set to -1. diff --git a/inst/com/src/GCOMResponse.cpp b/inst/com/src/GCOMResponse.cpp index 6a9a82a..034e8bf 100644 --- a/inst/com/src/GCOMResponse.cpp +++ b/inst/com/src/GCOMResponse.cpp @@ -841,21 +841,19 @@ void GCOMResponse::free_members(void) /***********************************************************************//** - * @brief Return instrument response + * @brief Return instrument response vector * - * @param[in] event Event. - * @param[in] source Source. + * @param[in] model Sky model. * @param[in] obs Observation. - * @return Instrument response. + * @return Instrument response vector. * * @exception GException::invalid_argument * Invalid observation or event type specified. * @exception GException::feature_not_implemented * Computation for specified spatial model not implemented. * - * Returns the instrument response for a given event, source and observation. - * If all spatial model parameters are fixed a DRM cube stored in the COMPTEL - * observation is used. The computation of this cube is handled by the + * Returns the instrument response to a sky model for all events in a given + * observation. The computation of the response is handled by the * GCOMObservation::drm() method that also will update the cube in case that * any of the parameters changes. ***************************************************************************/ diff --git a/inst/cta/src/cta_helpers_response_stacked_vector.cpp b/inst/cta/src/cta_helpers_response_stacked_vector.cpp index bdde7a4..cb67279 100644 --- a/inst/cta/src/cta_helpers_response_stacked_vector.cpp +++ b/inst/cta/src/cta_helpers_response_stacked_vector.cpp @@ -80,7 +80,14 @@ int cta_psf_radial_kerns_delta::size(void) const /***********************************************************************//** * @brief Kernel constructor for PSF integration of radial model * - * @param[in] delta PSF offset angle (radians). + * @param[in] rsp Pointer to CTA response cube. + * @param[in] model Pointer to radial spatial model. + * @param[in] obsDir Observed sky direction. + * @param[in] srcEngs True energies. + * @param[in] zeta Angular distance between event direction of model centre (radians). + * @param[in] theta_max Maximum model radius (radians). + * @param[in] iter Number of iterations for azimuth integration. + * @param[in] grad Compute parameter gradients? ***************************************************************************/ cta_psf_radial_kerns_delta::cta_psf_radial_kerns_delta(const GCTAResponseCube* rsp, const GModelSpatialRadial* model, diff --git a/src/obs/GEnergies.cpp b/src/obs/GEnergies.cpp index dd97939..99c38d5 100644 --- a/src/obs/GEnergies.cpp +++ b/src/obs/GEnergies.cpp @@ -120,7 +120,7 @@ GEnergies::GEnergies(const GEbounds& ebounds) /***********************************************************************//** * @brief Copy constructor * - * @param energies[in] Energy container. + * @param[in] energies Energy container. * * Construct energy container by copying from another energy container. ***************************************************************************/ diff --git a/src/obs/GResponse.cpp b/src/obs/GResponse.cpp index 7c140e5..b5e5968 100644 --- a/src/obs/GResponse.cpp +++ b/src/obs/GResponse.cpp @@ -619,15 +619,15 @@ double GResponse::irf_spatial(const GEvent& event, /***********************************************************************//** - * @brief Return instrument response integrated over the spatial model + * @brief Return instrument response vector integrated over the spatial model * - * @param[in] source Source. + * @param[in] model Sky model. * @param[in] obs Observation. * @param[in] gradients Gradients matrix. - * @return Instrument response to a spatial model. + * @return Instrument response vector to a spatial model. * - * Returns the instrument response for a given event, source and observation - * integrated over the spatial model component. The method computes + * Returns the instrument response to a sky model integrated over the spatial + * model component for all events in a given observation. The method computes * * \f[ * {\tt irf}(p', E', t') = \int_p M_{\rm S}(p | E, t) \, diff --git a/src/sky/GSkyDirs.cpp b/src/sky/GSkyDirs.cpp index d54749b..3170639 100644 --- a/src/sky/GSkyDirs.cpp +++ b/src/sky/GSkyDirs.cpp @@ -97,7 +97,7 @@ GSkyDirs::GSkyDirs(const GSkyDir& dir) /***********************************************************************//** * @brief Copy constructor * - * @param[in] dir Sky directions. + * @param[in] dirs Sky directions. * * Construct sky directions container by copying from another sky directions * container. diff --git a/src/sky/GSkyMap.cpp b/src/sky/GSkyMap.cpp index 1fc8bbb..8e165ae 100644 --- a/src/sky/GSkyMap.cpp +++ b/src/sky/GSkyMap.cpp @@ -2169,8 +2169,6 @@ GSkyMap GSkyMap::extract(const GSkyRegions& inclusions) const /***********************************************************************//** * @brief Stack all maps into a single map * - * @return Stacked map. - * * The methods replaces the sky map by a version with only a single map * by summing over the pixel values for all maps. If the sky map has no * pixels or there is only a single map in the object, the method does -- libgit2 0.21.4