Commit 1899308d6c30d4e05de1f41049c4505e025b3496
1 parent
08cf3fa3
Correct Doxygen documentation
Showing
8 changed files
with
12 additions
and
13 deletions
src/ctbkgcube/ctbkgcube.hpp
| 1 | 1 | /*************************************************************************** |
| 2 | 2 | * ctbkgcube - Background cube generation tool * |
| 3 | 3 | * ----------------------------------------------------------------------- * |
| 4 | - * copyright (C) 2014-2018 by Chia-Chun Lu * | |
| 4 | + * copyright (C) 2014-2019 by Chia-Chun Lu * | |
| 5 | 5 | * ----------------------------------------------------------------------- * |
| 6 | 6 | * * |
| 7 | 7 | * This program is free software: you can redistribute it and/or modify * |
| ... | ... | @@ -87,7 +87,7 @@ protected: |
| 87 | 87 | /***********************************************************************//** |
| 88 | 88 | * @brief Set event cube |
| 89 | 89 | * |
| 90 | - * @param[in] Event cube. | |
| 90 | + * @param[in] cntcube Event cube. | |
| 91 | 91 | ***************************************************************************/ |
| 92 | 92 | inline |
| 93 | 93 | void ctbkgcube::cntcube(const GCTAEventCube& cntcube) | ... | ... |
src/ctmodel/ctmodel.cpp
| ... | ... | @@ -837,9 +837,10 @@ void ctmodel::extract_cube_properties(void) |
| 837 | 837 | |
| 838 | 838 | |
| 839 | 839 | /***********************************************************************//** |
| 840 | - * @brief Fill model into model cube | |
| 840 | + * @brief Fill models into model cube | |
| 841 | 841 | * |
| 842 | 842 | * @param[in] obs CTA observation. |
| 843 | + * @param[in] models Model container. | |
| 843 | 844 | * |
| 844 | 845 | * Adds the expected number of events for a given observation to the events |
| 845 | 846 | * that are already found in the model cube. The method also updates the | ... | ... |
src/ctprob/main.cpp
src/ctskymap/ctskymap.cpp
| ... | ... | @@ -610,8 +610,6 @@ void ctskymap::setup_maps(void) |
| 610 | 610 | /***********************************************************************//** |
| 611 | 611 | * @brief Generates map of pixel exclusions |
| 612 | 612 | * |
| 613 | - * @param[in] filename Exclusion file name. | |
| 614 | - * | |
| 615 | 613 | * Generates a sky map of the pixels that are to be excluded from the |
| 616 | 614 | * background estimation. Pixels with values different from 0 will be |
| 617 | 615 | * excluded. | ... | ... |
src/support/ctlikelihood.cpp
| 1 | 1 | /*************************************************************************** |
| 2 | 2 | * ctlikelihood - Base class for likelihood tools * |
| 3 | 3 | * ----------------------------------------------------------------------- * |
| 4 | - * copyright (C) 2016-2018 by Juergen Knoedlseder * | |
| 4 | + * copyright (C) 2016-2019 by Juergen Knoedlseder * | |
| 5 | 5 | * ----------------------------------------------------------------------- * |
| 6 | 6 | * * |
| 7 | 7 | * This program is free software: you can redistribute it and/or modify * |
| ... | ... | @@ -119,7 +119,7 @@ ctlikelihood::ctlikelihood(const std::string& name, |
| 119 | 119 | * |
| 120 | 120 | * @param[in] name Likelihood tool name. |
| 121 | 121 | * @param[in] version Likelihood tool version. |
| 122 | - * param[in] obs Observation container. | |
| 122 | + * @param[in] obs Observation container. | |
| 123 | 123 | * |
| 124 | 124 | * Constructs a likelihood tool from the @p name, @p version and an |
| 125 | 125 | * observation container. | ... | ... |
src/support/ctobservation.cpp
| ... | ... | @@ -116,7 +116,7 @@ ctobservation::ctobservation(const std::string& name, |
| 116 | 116 | * |
| 117 | 117 | * @param[in] name Observation tool name. |
| 118 | 118 | * @param[in] version Observation tool version. |
| 119 | - * param[in] obs Observation container. | |
| 119 | + * @param[in] obs Observation container. | |
| 120 | 120 | * |
| 121 | 121 | * Constructs a observation tool from the @p name, @p version and an |
| 122 | 122 | * observation container. | ... | ... |
src/support/support.cpp
| 1 | 1 | /*************************************************************************** |
| 2 | 2 | * support - support functions * |
| 3 | 3 | * ----------------------------------------------------------------------- * |
| 4 | - * copyright (C) 2016 by Juergen Knoedlseder * | |
| 4 | + * copyright (C) 2016-2019 by Juergen Knoedlseder * | |
| 5 | 5 | * ----------------------------------------------------------------------- * |
| 6 | 6 | * * |
| 7 | 7 | * This program is free software: you can redistribute it and/or modify * |
| ... | ... | @@ -19,7 +19,7 @@ |
| 19 | 19 | * * |
| 20 | 20 | ***************************************************************************/ |
| 21 | 21 | /** |
| 22 | - * @file support | |
| 22 | + * @file support.cpp | |
| 23 | 23 | * @brief Support function implementation |
| 24 | 24 | * @author Juergen Knoedlseder |
| 25 | 25 | */ | ... | ... |
src/support/support.hpp
| 1 | 1 | /*************************************************************************** |
| 2 | 2 | * support - support functions * |
| 3 | 3 | * ----------------------------------------------------------------------- * |
| 4 | - * copyright (C) 2016 by Juergen Knoedlseder * | |
| 4 | + * copyright (C) 2016-2019 by Juergen Knoedlseder * | |
| 5 | 5 | * ----------------------------------------------------------------------- * |
| 6 | 6 | * * |
| 7 | 7 | * This program is free software: you can redistribute it and/or modify * |
| ... | ... | @@ -19,7 +19,7 @@ |
| 19 | 19 | * * |
| 20 | 20 | ***************************************************************************/ |
| 21 | 21 | /** |
| 22 | - * @file support | |
| 22 | + * @file support.hpp | |
| 23 | 23 | * @brief Support function definitions |
| 24 | 24 | * @author Juergen Knoedlseder |
| 25 | 25 | */ | ... | ... |