Correct Doxygen documentation

Jürgen Knödlseder
1 parent 08cf3fa3
Showing 8 changed files with 12 additions and 13 deletions
src/ctbkgcube/ctbkgcube.hpp
src/ctmodel/ctmodel.cpp
src/ctprob/main.cpp
src/ctskymap/ctskymap.cpp
src/support/ctlikelihood.cpp
src/support/ctobservation.cpp
src/support/support.cpp
src/support/support.hpp
 /***************************************************************************
  *               ctbkgcube - Background cube generation tool               *
  * ----------------------------------------------------------------------- *
- *  copyright (C) 2014-2018 by Chia-Chun Lu                                *
+ *  copyright (C) 2014-2019 by Chia-Chun Lu                                *
  * ----------------------------------------------------------------------- *
  *                                                                         *
  *  This program is free software: you can redistribute it and/or modify   *
@@ -87,7 +87,7 @@ protected:
 /***********************************************************************//**
  * @brief Set event cube
  *
- * @param[in] Event cube.
+ * @param[in] cntcube Event cube.
  ***************************************************************************/
 inline
 void ctbkgcube::cntcube(const GCTAEventCube& cntcube)
@@ -837,9 +837,10 @@ void ctmodel::extract_cube_properties(void)
 /***********************************************************************//**
- * @brief Fill model into model cube
+ * @brief Fill models into model cube
  *
  * @param[in] obs CTA observation.
+ * @param[in] models Model container.
  *
  * Adds the expected number of events for a given observation to the events
  * that are already found in the model cube. The method also updates the
@@ -19,7 +19,7 @@
  *                                                                         *
  ***************************************************************************/
 /**
- * @file main.cpp
+ * @file ctprob/main.cpp
  * @brief Computes event probability for a given model
  * @author Leonardo Di Venere
  */
@@ -610,8 +610,6 @@ void ctskymap::setup_maps(void)
 /***********************************************************************//**
  * @brief Generates map of pixel exclusions
  *
- * @param[in] filename Exclusion file name.
- *
  * Generates a sky map of the pixels that are to be excluded from the
  * background estimation. Pixels with values different from 0 will be
  * excluded.
 /***************************************************************************
  *              ctlikelihood - Base class for likelihood tools             *
  * ----------------------------------------------------------------------- *
- *  copyright (C) 2016-2018 by Juergen Knoedlseder                         *
+ *  copyright (C) 2016-2019 by Juergen Knoedlseder                         *
  * ----------------------------------------------------------------------- *
  *                                                                         *
  *  This program is free software: you can redistribute it and/or modify   *
@@ -119,7 +119,7 @@ ctlikelihood::ctlikelihood(const std::string&amp; name,
  *
  * @param[in] name Likelihood tool name.
  * @param[in] version Likelihood tool version.
- * param[in] obs Observation container.
+ * @param[in] obs Observation container.
  *
  * Constructs a likelihood tool from the @p name, @p version and an
  * observation container.
@@ -116,7 +116,7 @@ ctobservation::ctobservation(const std::string&amp; name,
  *
  * @param[in] name Observation tool name.
  * @param[in] version Observation tool version.
- * param[in] obs Observation container.
+ * @param[in] obs Observation container.
  *
  * Constructs a observation tool from the @p name, @p version and an
  * observation container.
 /***************************************************************************
  *                      support - support functions                        *
  * ----------------------------------------------------------------------- *
- *  copyright (C) 2016 by Juergen Knoedlseder                              *
+ *  copyright (C) 2016-2019 by Juergen Knoedlseder                         *
  * ----------------------------------------------------------------------- *
  *                                                                         *
  *  This program is free software: you can redistribute it and/or modify   *
@@ -19,7 +19,7 @@
  *                                                                         *
  ***************************************************************************/
 /**
- * @file support
+ * @file support.cpp
  * @brief Support function implementation
  * @author Juergen Knoedlseder
  */
 /***************************************************************************
  *                      support - support functions                        *
  * ----------------------------------------------------------------------- *
- *  copyright (C) 2016 by Juergen Knoedlseder                              *
+ *  copyright (C) 2016-2019 by Juergen Knoedlseder                         *
  * ----------------------------------------------------------------------- *
  *                                                                         *
  *  This program is free software: you can redistribute it and/or modify   *
@@ -19,7 +19,7 @@
  *                                                                         *
  ***************************************************************************/
 /**
- * @file support
+ * @file support.hpp
  * @brief Support function definitions
  * @author Juergen Knoedlseder
  */