Fix some Doxygen issues

Jürgen Knödlseder
1 parent 83a2a1d6
Showing 8 changed files with 24 additions and 21 deletions
include/GResponseVectorCache.hpp
inst/com/include/GCOMEventBin.hpp
inst/com/src/GCOMResponse.cpp
inst/cta/src/cta_helpers_response_stacked_vector.cpp
src/obs/GEnergies.cpp
src/obs/GResponse.cpp
src/sky/GSkyDirs.cpp
src/sky/GSkyMap.cpp
@@ -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
@@ -135,7 +135,7 @@ const int&amp; 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.
@@ -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.
  ***************************************************************************/
@@ -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,
@@ -120,7 +120,7 @@ GEnergies::GEnergies(const GEbounds&amp; ebounds)
 /***********************************************************************//**
  * @brief Copy constructor
  *
- * @param energies[in] Energy container.
+ * @param[in] energies Energy container.
  *
  * Construct energy container by copying from another energy container.
  ***************************************************************************/
@@ -619,15 +619,15 @@ double GResponse::irf_spatial(const GEvent&amp;       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) \,
@@ -97,7 +97,7 @@ GSkyDirs::GSkyDirs(const GSkyDir&amp; 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.
@@ -2169,8 +2169,6 @@ GSkyMap GSkyMap::extract(const GSkyRegions&amp; 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