Alexander Ziegler / gammalib

Commit d633b93260f0ce2a3dd7e27ca539801ddb9ebf4f

Authored by Jürgen Knödlseder
1 parent aae1e665

Improve Doxygen documentation.

Inline Side-by-side
Showing 1 changed file with 7 additions and 1 deletions
inst/com/src/GCOMModelDRBFitting.cpp
  View file @d633b93
... ... @@ -149,6 +149,7 @@ GCOMModelDRBFitting::~GCOMModelDRBFitting(void)
149 149 * @brief Assignment operator
150 150 *
151 151 * @param[in] model COMPTEL DRB fitting model.
  152 + * @return COMPTEL DRB fitting model
152 153 *
153 154 * Assigns the information from a COMPTEL DRB fitting model to the actual
154 155 * object. Note that a deep copy of the information is performed, so the
... ... @@ -211,6 +212,8 @@ void GCOMModelDRBFitting::clear(void)
211 212 /***********************************************************************//**
212 213 * @brief Clone instance
213 214 *
  215 + * @return Pointer to deep copy of COMPTEL DRB fitting model.
  216 + *
214 217 * Clone a COMPTEL DRB fitting model. Cloning performs a deep copy of the
215 218 * information, so the original object can be destroyed after cloning without
216 219 * any loss of information.
... ... @@ -226,6 +229,7 @@ GCOMModelDRBFitting* GCOMModelDRBFitting::clone(void) const
226 229 *
227 230 * @param[in] event Observed event.
228 231 * @param[in] obs Observation.
  232 + * @return Background model value.
229 233 *
230 234 * @exception GCOMException::bad_observation_type
231 235 * Observation is not a COMPTEL observation.
... ... @@ -317,13 +321,15 @@ double GCOMModelDRBFitting::eval(const GEvent& event,
317 321 *
318 322 * @param[in] event Observed event.
319 323 * @param[in] obs Observation.
  324 + * @return Background model value.
320 325 *
321 326 * @exception GCOMException::bad_observation_type
322 327 * Observation is not a COMPTEL observation.
323 328 * @exception GCOMException::bad_event_type
324 329 * Event is not a COMPTEL event bin.
325 330 *
326   - * Evaluates the COMPTEL DRB fitting model value and parameter gradients.
  331 + * Evaluates the COMPTEL DRB fitting model value and sets the parameter
  332 + * gradients.
327 333 ***************************************************************************/
328 334 double GCOMModelDRBFitting::eval_gradients(const GEvent& event,
329 335 const GObservation& obs) const
... ...