Rolf Buehler / gammalib

Commit 09d541d54f79e2ea0f8e2025b1b1f149acd3a7c6

Authored by Jürgen Knödlseder
1 parent 5a2913a6

Correct some Doxygen errors

Inline Side-by-side
Showing 9 changed files with 62 additions and 66 deletions
include/GModelSpatialRadialProfileDMBurkert.hpp
  View file @09d541d
1 1 /***************************************************************************
2 2 * GModelSpatialRadialProfileDMBurkert.hpp - DM Burkert profile class *
3 3 * ----------------------------------------------------------------------- *
4   - * copyright (C) 2016 by Nathan Kelley-Hoskins *
  4 + * copyright (C) 2016-2017 by Nathan Kelley-Hoskins *
5 5 * ----------------------------------------------------------------------- *
6 6 * *
7 7 * This program is free software: you can redistribute it and/or modify *
... ... @@ -150,7 +150,7 @@ std::string GModelSpatialRadialProfileDMBurkert::type(void) const
150 150 /***********************************************************************//**
151 151 * @brief Return scale radius
152 152 *
153   - *@return scale radius (kpc).
  153 + * @return Scale radius (kpc).
154 154 *
155 155 * Returns the scale radius of the halo profile in kpc.
156 156 ***************************************************************************/
... ... @@ -163,21 +163,21 @@ double GModelSpatialRadialProfileDMBurkert::scale_radius(void) const
163 163 /***********************************************************************//**
164 164 * @brief Set scale radius
165 165 *
166   - * @param[in] radius scale radius (kpc).
  166 + * @param[in] radius Scale radius (kpc).
167 167 *
168 168 * Sets the scale radius of the halo profile in kpc.
169 169 ***************************************************************************/
170 170 inline
171   -void GModelSpatialRadialProfileDMBurkert::scale_radius(const double& scale_radius)
  171 +void GModelSpatialRadialProfileDMBurkert::scale_radius(const double& radius)
172 172 {
173   - m_scale_radius.value(scale_radius);
  173 + m_scale_radius.value(radius);
174 174 return;
175 175 }
176 176  
177 177 /***********************************************************************//**
178 178 * @brief Return scale density
179 179 *
180   - *@return scale density (GeV/cm^3).
  180 + * @return Scale density (GeV/cm^3).
181 181 *
182 182 * Returns the scale density (mass/volume density at the scale radius) of
183 183 * the halo profile in GeV/cm^3.
... ... @@ -191,22 +191,22 @@ double GModelSpatialRadialProfileDMBurkert::scale_density(void) const
191 191 /***********************************************************************//**
192 192 * @brief Set scale density
193 193 *
194   - * @param[in] scale density (GeV/cm^3).
  194 + * @param[in] density Scale density (GeV/cm^3).
195 195 *
196 196 * Sets the scale density ( mass/volume density at the scale radius) of the
197 197 * halo profile in GeV/cm^3.
198 198 ***************************************************************************/
199 199 inline
200   -void GModelSpatialRadialProfileDMBurkert::scale_density(const double& scale_density)
  200 +void GModelSpatialRadialProfileDMBurkert::scale_density(const double& density)
201 201 {
202   - m_scale_density.value(scale_density);
  202 + m_scale_density.value(density);
203 203 return;
204 204 }
205 205  
206 206 /***********************************************************************//**
207 207 * @brief Return halo distance
208 208 *
209   - * @return halo distance (kpc).
  209 + * @return Halo distance (kpc).
210 210 *
211 211 * Returns the distance to the halo center in kpc.
212 212 ***************************************************************************/
... ... @@ -219,14 +219,14 @@ double GModelSpatialRadialProfileDMBurkert::halo_distance(void) const
219 219 /***********************************************************************//**
220 220 * @brief Set halo distance
221 221 *
222   - * @param[in] halo distance (kpc).
  222 + * @param[in] distance Halo distance (kpc).
223 223 *
224 224 * Sets the distance between the observer and the halo center in kpc.
225 225 ***************************************************************************/
226 226 inline
227   -void GModelSpatialRadialProfileDMBurkert::halo_distance(const double& halo_distance)
  227 +void GModelSpatialRadialProfileDMBurkert::halo_distance(const double& distance)
228 228 {
229   - m_halo_distance.value(halo_distance);
  229 + m_halo_distance.value(distance);
230 230 return;
231 231 }
232 232  
... ...
include/GModelSpatialRadialProfileDMEinasto.hpp
  View file @09d541d
1 1 /***************************************************************************
2 2 * GModelSpatialRadialProfileDMEinasto.hpp - DM Einasto profile class *
3 3 * ----------------------------------------------------------------------- *
4   - * copyright (C) 2016 by Nathan Kelley-Hoskins *
  4 + * copyright (C) 2016-2017 by Nathan Kelley-Hoskins *
5 5 * ----------------------------------------------------------------------- *
6 6 * *
7 7 * This program is free software: you can redistribute it and/or modify *
... ... @@ -169,21 +169,21 @@ double GModelSpatialRadialProfileDMEinasto::scale_radius(void) const
169 169 /***********************************************************************//**
170 170 * @brief Set scale radius
171 171 *
172   - * @param[in] radius scale radius (kpc).
  172 + * @param[in] radius Scale radius (kpc).
173 173 *
174 174 * Sets the scale radius of the halo profile in kpc.
175 175 ***************************************************************************/
176 176 inline
177   -void GModelSpatialRadialProfileDMEinasto::scale_radius(const double& scale_radius)
  177 +void GModelSpatialRadialProfileDMEinasto::scale_radius(const double& radius)
178 178 {
179   - m_scale_radius.value(scale_radius);
  179 + m_scale_radius.value(radius);
180 180 return;
181 181 }
182 182  
183 183 /***********************************************************************//**
184 184 * @brief Return scale density
185 185 *
186   - * @return scale radius (GeV/cm^3).
  186 + * @return Scale density (GeV/cm^3).
187 187 *
188 188 * Returns the scale radius of the halo profile in kpc.
189 189 ***************************************************************************/
... ... @@ -196,22 +196,22 @@ double GModelSpatialRadialProfileDMEinasto::scale_density(void) const
196 196 /***********************************************************************//**
197 197 * @brief Set scale density
198 198 *
199   - * @param[in] radius scale density (GeV/cm^3).
  199 + * @param[in] density Scale density (GeV/cm^3).
200 200 *
201 201 * Sets the scale density (mass/volume density at the scale radius) of
202 202 * the halo profile in GeV/cm^3.
203 203 ***************************************************************************/
204 204 inline
205   -void GModelSpatialRadialProfileDMEinasto::scale_density(const double& scale_density)
  205 +void GModelSpatialRadialProfileDMEinasto::scale_density(const double& density)
206 206 {
207   - m_scale_density.value(scale_density);
  207 + m_scale_density.value(density);
208 208 return;
209 209 }
210 210  
211 211 /***********************************************************************//**
212 212 * @brief Return halo distance
213 213 *
214   - * @return halo distance (kpc).
  214 + * @return Halo distance (kpc).
215 215 *
216 216 * Returns the distance to the halo center in kpc.
217 217 ***************************************************************************/
... ... @@ -224,21 +224,21 @@ double GModelSpatialRadialProfileDMEinasto::halo_distance(void) const
224 224 /***********************************************************************//**
225 225 * @brief Set halo distance
226 226 *
227   - * @param[in] halo distance (kpc).
  227 + * @param[in] distance Halo distance (kpc).
228 228 *
229 229 * Sets the distance between the observer and the halo center in kpc.
230 230 ***************************************************************************/
231 231 inline
232   -void GModelSpatialRadialProfileDMEinasto::halo_distance(const double& halo_distance)
  232 +void GModelSpatialRadialProfileDMEinasto::halo_distance(const double& distance)
233 233 {
234   - m_halo_distance.value(halo_distance);
  234 + m_halo_distance.value(distance);
235 235 return;
236 236 }
237 237  
238 238 /***********************************************************************//**
239 239 * @brief Return Einasto alpha power index
240 240 *
241   - * @return alpha (unitless).
  241 + * @return Einasto profile power index alpha (unitless).
242 242 *
243 243 * Returns the alpha power index in the Einasto halo density function.
244 244 ***************************************************************************/
... ... @@ -249,9 +249,9 @@ double GModelSpatialRadialProfileDMEinasto::alpha(void) const
249 249 }
250 250  
251 251 /***********************************************************************//**
252   - * @brief Set Einasto alpha power index
  252 + * @brief Set Einasto profile power index
253 253 *
254   - * @param[in] alpha (unitless).
  254 + * @param[in] alpha Einasto profile power index (unitless).
255 255 *
256 256 * Sets the Einasto profile power index, should be positive.
257 257 ***************************************************************************/
... ...
include/GModelSpatialRadialProfileDMZhao.hpp
  View file @09d541d
1 1 /***************************************************************************
2 2 * GModelSpatialRadialProfileDMZhao.hpp - DM Zhao profile class *
3 3 * ----------------------------------------------------------------------- *
4   - * copyright (C) 2016 by Nathan Kelley-Hoskins *
  4 + * copyright (C) 2016-2017 by Nathan Kelley-Hoskins *
5 5 * ----------------------------------------------------------------------- *
6 6 * *
7 7 * This program is free software: you can redistribute it and/or modify *
... ... @@ -168,7 +168,7 @@ std::string GModelSpatialRadialProfileDMZhao::type(void) const
168 168 /***********************************************************************//**
169 169 * @brief Return scale radius
170 170 *
171   - * @return scale radius (kpc).
  171 + * @return Scale radius (kpc).
172 172 *
173 173 * Returns the scale radius of the halo profile in kpc.
174 174 ***************************************************************************/
... ... @@ -181,21 +181,21 @@ double GModelSpatialRadialProfileDMZhao::scale_radius(void) const
181 181 /***********************************************************************//**
182 182 * @brief Set scale radius
183 183 *
184   - * @param[in] radius scale radius (kpc).
  184 + * @param[in] radius Scale radius (kpc).
185 185 *
186 186 * Sets the scale radius of the halo profile in kpc.
187 187 ***************************************************************************/
188 188 inline
189   -void GModelSpatialRadialProfileDMZhao::scale_radius(const double& scale_radius)
  189 +void GModelSpatialRadialProfileDMZhao::scale_radius(const double& radius)
190 190 {
191   - m_scale_radius.value(scale_radius);
  191 + m_scale_radius.value(radius);
192 192 return;
193 193 }
194 194  
195 195 /***********************************************************************//**
196 196 * @brief Return scale density
197 197 *
198   - * @return scale density (GeV/cm^3).
  198 + * @return Scale density (GeV/cm^3).
199 199 *
200 200 * Returns the scale density (mass/volume density at the scale radius) of
201 201 * the halo profile in GeV/cm^3.
... ... @@ -209,22 +209,22 @@ double GModelSpatialRadialProfileDMZhao::scale_density(void) const
209 209 /***********************************************************************//**
210 210 * @brief Set scale density
211 211 *
212   - * @param[in] radius scale density (GeV/cm^3).
  212 + * @param[in] density Scale density (GeV/cm^3).
213 213 *
214 214 * Sets the scale density (mass/volume density at the scale radius) of the
215 215 * halo profile in GeV/cm^3.
216 216 ***************************************************************************/
217 217 inline
218   -void GModelSpatialRadialProfileDMZhao::scale_density(const double& scale_density)
  218 +void GModelSpatialRadialProfileDMZhao::scale_density(const double& density)
219 219 {
220   - m_scale_density.value(scale_density);
  220 + m_scale_density.value(density);
221 221 return;
222 222 }
223 223  
224 224 /***********************************************************************//**
225 225 * @brief Return halo distance
226 226 *
227   - * @return halo distance (kpc).
  227 + * @return Halo distance (kpc).
228 228 *
229 229 * Returns the distance to the halo center in kpc.
230 230 ***************************************************************************/
... ... @@ -237,14 +237,14 @@ double GModelSpatialRadialProfileDMZhao::halo_distance(void) const
237 237 /***********************************************************************//**
238 238 * @brief Set halo distance
239 239 *
240   - * @param[in] halo distance (kpc).
  240 + * @param[in] distance Halo distance (kpc).
241 241 *
242 242 * Sets the distance between the observer and the halo center in kpc.
243 243 ***************************************************************************/
244 244 inline
245   -void GModelSpatialRadialProfileDMZhao::halo_distance(const double& halo_distance)
  245 +void GModelSpatialRadialProfileDMZhao::halo_distance(const double& distance)
246 246 {
247   - m_halo_distance.value(halo_distance);
  247 + m_halo_distance.value(distance);
248 248 return;
249 249 }
250 250  
... ...
src/linalg/GMatrix.cpp
  View file @09d541d
... ... @@ -364,7 +364,7 @@ GMatrix& GMatrix::operator+=(const GMatrix& matrix)
364 364 /***********************************************************************//**
365 365 * @brief Unary matrix scalar addition operator
366 366 *
367   - * @param[in] scaler Scalar.
  367 + * @param[in] scalar Scalar.
368 368 *
369 369 * Adds a @p scalar to each matrix element.
370 370 ***************************************************************************/
... ...
src/linalg/GMatrixSparse.cpp
  View file @09d541d
... ... @@ -574,7 +574,7 @@ GMatrixSparse& GMatrixSparse::operator+=(const GMatrixSparse& matrix)
574 574 /***********************************************************************//**
575 575 * @brief Unary matrix scalar addition operator
576 576 *
577   - * @param[in] scaler Scalar.
  577 + * @param[in] scalar Scalar.
578 578 *
579 579 * Adds a @p scalar to each matrix element.
580 580 ***************************************************************************/
... ...
src/linalg/GMatrixSymmetric.cpp
  View file @09d541d
... ... @@ -414,7 +414,7 @@ GMatrixSymmetric& GMatrixSymmetric::operator+=(const GMatrixSymmetric& matrix)
414 414 /***********************************************************************//**
415 415 * @brief Unary matrix scalar addition operator
416 416 *
417   - * @param[in] scaler Scalar.
  417 + * @param[in] scalar Scalar.
418 418 *
419 419 * Adds a @p scalar to each matrix element.
420 420 ***************************************************************************/
... ...
src/model/GModelSpatialRadialProfileDMBurkert.cpp
  View file @09d541d
1 1 /***************************************************************************
2 2 * GModelSpatialRadialProfileDMBurkert.cpp - Burkert radial profile class *
3 3 * ----------------------------------------------------------------------- *
4   - * copyright (C) 2016 by Nathan Kelley-Hoskins *
  4 + * copyright (C) 2016-2017 by Nathan Kelley-Hoskins *
5 5 * ----------------------------------------------------------------------- *
6 6 * *
7 7 * This program is free software: you can redistribute it and/or modify *
... ... @@ -565,8 +565,8 @@ double GModelSpatialRadialProfileDMBurkert::profile_value(const double& theta) c
565 565 /***********************************************************************//**
566 566 * @brief Kernel for halo density profile squared
567 567 *
568   - * @param[in] distance from observer to point in space (meters)
569   - * @return Density profile value
  568 + * @param[in] los Distance from observer to point in space (meters).
  569 + * @return Halo density.
570 570 *
571 571 * Computes the value of an einasto halo density profile squared,
572 572 * at distance l from observer, at angle \f[\theta\f] from the halo center:
... ... @@ -657,11 +657,11 @@ void GModelSpatialRadialProfileDMBurkert::update() const
657 657 /***********************************************************************//**
658 658 * @brief Calculate Halo Mass Density
659 659 *
660   - * @param[in] distance from halo center (kpc)
661   - * @return Halo mass density
  660 + * @param[in] radius Distance from halo centre (kpc).
  661 + * @return Halo mass density.
662 662 *
663   - * Calculates the halo's mass density at a given radial distance from the halo
664   - * center.
  663 + * Calculates the halo's mass density at a given radial distance from the
  664 + * halo centre.
665 665 ***************************************************************************/
666 666 double GModelSpatialRadialProfileDMBurkert::mass_density(const double& radius) const
667 667 {
... ...
src/model/GModelSpatialRadialProfileDMEinasto.cpp
  View file @09d541d
1 1 /***************************************************************************
2 2 * GModelSpatialRadialProfileDMEinasto.cpp - Einasto radial profile class *
3 3 * ----------------------------------------------------------------------- *
4   - * copyright (C) 2016 by Nathan Kelley-Hoskins *
  4 + * copyright (C) 2016-2017 by Nathan Kelley-Hoskins *
5 5 * ----------------------------------------------------------------------- *
6 6 * *
7 7 * This program is free software: you can redistribute it and/or modify *
... ... @@ -622,7 +622,8 @@ double GModelSpatialRadialProfileDMEinasto::profile_value(const double& theta) c
622 622 /***********************************************************************//**
623 623 * @brief Kernel for halo density profile squared
624 624 *
625   - * @param[in] distance from observer to point in space (meters)
  625 + * @param[in] los Distance from observer to point in space (meters)
  626 + * @return Halo density.
626 627 *
627 628 * Computes the value of an einasto halo density profile squared,
628 629 * at distance l from observer, at angle \f[\theta\f] from the halo center:
... ... @@ -647,11 +648,8 @@ double GModelSpatialRadialProfileDMEinasto::profile_value(const double& theta) c
647 648 * J. Einasto, 1965
648 649 * "Kinematics and dynamics of stellar systems"
649 650 * Trudy Inst. Astrofiz. Alma-Ata 5, 87
650   - *
651   - * @return unit
652   - *
653 651 ***************************************************************************/
654   -double GModelSpatialRadialProfileDMEinasto::halo_kernel_los::eval( const double &los )
  652 +double GModelSpatialRadialProfileDMEinasto::halo_kernel_los::eval(const double &los)
655 653 {
656 654 // Calculate the scale distance g, the ( distance from integration point
657 655 // to the halo center ) divided by ( the halo scale radius )
... ... @@ -717,13 +715,13 @@ void GModelSpatialRadialProfileDMEinasto::update() const
717 715 /***********************************************************************//**
718 716 * @brief Calculate halo mass density
719 717 *
720   - * @param[in] radius from halo center (kpc)
  718 + * @param[in] radius Distance from halo center (kpc).
721 719 * @return Halo mass density.
722 720 *
723 721 * Calculates the halo's mass density at a given radial distance from the
724 722 * halo center.
725 723 ***************************************************************************/
726   -double GModelSpatialRadialProfileDMEinasto::mass_density( const double& radius ) const
  724 +double GModelSpatialRadialProfileDMEinasto::mass_density(const double& radius) const
727 725 {
728 726 // Set-up kernel
729 727 halo_kernel_los halo_shape(m_scale_radius.value(),
... ...
src/model/GModelSpatialRadialProfileDMZhao.cpp
  View file @09d541d
1 1 /***************************************************************************
2 2 * GModelSpatialRadialProfileDMZhao.cpp - Zhao radial profile class *
3 3 * ----------------------------------------------------------------------- *
4   - * copyright (C) 2016 by Nathan Kelley-Hoskins *
  4 + * copyright (C) 2016-2017 by Nathan Kelley-Hoskins *
5 5 * ----------------------------------------------------------------------- *
6 6 * *
7 7 * This program is free software: you can redistribute it and/or modify *
... ... @@ -665,8 +665,8 @@ double GModelSpatialRadialProfileDMZhao::profile_value(const double& theta) cons
665 665 /***********************************************************************//**
666 666 * @brief Kernel for zhao halo density profile squared
667 667 *
668   - * @param[in] distance from observer to point in space (meters)
669   - * @return Jalo density.
  668 + * @param[in] los Distance from observer to point in space (meters)
  669 + * @return Halo density.
670 670 *
671 671 * Computes the value of a zhao halo density profile squared,
672 672 * at distance l from observer, at angle \f[\theta\f] from the halo center,
... ... @@ -692,8 +692,6 @@ double GModelSpatialRadialProfileDMZhao::profile_value(const double& theta) cons
692 692 * "Analytical models for galactic nuclei"
693 693 * Monthly Notices of the Royal Astronomical Society, 278, 488-49
694 694 * http://mnras.oxfordjournals.org/content/278/2/488.short
695   - *
696   - *
697 695 ***************************************************************************/
698 696 double GModelSpatialRadialProfileDMZhao::halo_kernel_los::eval(const double &los)
699 697 {
... ... @@ -762,11 +760,11 @@ void GModelSpatialRadialProfileDMZhao::update() const
762 760 /***********************************************************************//**
763 761 * @brief Calculate Halo Mass Density
764 762 *
765   - * @param[in] distance from halo center (kpc)
  763 + * @param[in] radius Distance from halo center (kpc).
  764 + * @return Halo mass density.
766 765 *
767 766 * Calculates the halo's mass density at a given radial distance from the halo
768 767 * center.
769   - *
770 768 ***************************************************************************/
771 769 double GModelSpatialRadialProfileDMZhao::mass_density(const double& radius) const
772 770 {
... ...