From abc946261063d5a560383e6890861eb0edff688d Mon Sep 17 00:00:00 2001 From: Jürgen Knödlseder Date: Sat, 15 Jul 2017 21:59:15 +0200 Subject: [PATCH] Correct Doxygen documentation --- doc/source/develop/index.rst | 8 ++++++++ inst/cta/src/GCTAPsfKing.cpp | 2 +- src/model/GModelSpectralSmoothBrokenPlaw.cpp | 13 ++++++------- src/model/GModelTemporalPhaseCurve.cpp | 16 ++++++++-------- 4 files changed, 23 insertions(+), 16 deletions(-) diff --git a/doc/source/develop/index.rst b/doc/source/develop/index.rst index c0d0f21..96c319c 100644 --- a/doc/source/develop/index.rst +++ b/doc/source/develop/index.rst @@ -37,6 +37,14 @@ Below a few links to learn how to contribute to GammaLib: profiling/index releasing/index +Links: + +* `GitLab `_ +* `GitHub `_ +* `Redmine `_ +* `Open HUB `_ +* `Source code documentation (Doxygen) <../doxygen/index.html>`_ + And here some status shields: .. image:: https://cta-jenkins.irap.omp.eu/buildStatus/icon?job=gammalib-integrate-os diff --git a/inst/cta/src/GCTAPsfKing.cpp b/inst/cta/src/GCTAPsfKing.cpp index 9ed4720..b2990ae 100644 --- a/inst/cta/src/GCTAPsfKing.cpp +++ b/inst/cta/src/GCTAPsfKing.cpp @@ -703,7 +703,7 @@ void GCTAPsfKing::free_members(void) * only depends on energy, the only parameter on which the cache values * depend is the energy. If the PSF parameters are invalid the m_par_norm * member will be set to zero. Valid PSF parameters are \f$\gamma > 1\f$ and - * \f$\simga > 0\f$. + * \f$\sigma > 0\f$. ***************************************************************************/ void GCTAPsfKing::update(const double& logE, const double& theta) const { diff --git a/src/model/GModelSpectralSmoothBrokenPlaw.cpp b/src/model/GModelSpectralSmoothBrokenPlaw.cpp index b77ca36..f11580b 100644 --- a/src/model/GModelSpectralSmoothBrokenPlaw.cpp +++ b/src/model/GModelSpectralSmoothBrokenPlaw.cpp @@ -141,13 +141,12 @@ GModelSpectralSmoothBrokenPlaw::GModelSpectralSmoothBrokenPlaw( * @param[in] beta Break smoothness parameter * * Constructs a smoothly broken power law using the model parameters - * - * power law @p prefactor (ph/cm2/s/MeV) - * spectral @p index1 - * Energy @p pivot energy - * spectral @p index2 - * Energy @p breakenergy of spectral break - * spectral @p beta + * power law @p prefactor (ph/cm2/s/MeV), + * spectral @p index1, + * @p pivot energy, + * spectral @p index2, + * @p breakenergy of spectral break, and + * smoothness parameter @p beta. ***************************************************************************/ GModelSpectralSmoothBrokenPlaw::GModelSpectralSmoothBrokenPlaw( const double& prefactor, diff --git a/src/model/GModelTemporalPhaseCurve.cpp b/src/model/GModelTemporalPhaseCurve.cpp index 1097258..54c0c8f 100644 --- a/src/model/GModelTemporalPhaseCurve.cpp +++ b/src/model/GModelTemporalPhaseCurve.cpp @@ -260,9 +260,9 @@ GModelTemporalPhaseCurve* GModelTemporalPhaseCurve::clone(void) const * * where * - * \f$r(\Phi(t))$\f is the phase dependent rate, defined by linear - * interpolation between the nodes in a FITS file, \f$\Phi(t)$\f is the time - * dependent phase, and \f${\tt m\_norm}$\f is a normalisation constant. + * \f$r(\Phi(t))\f$ is the phase dependent rate, defined by linear + * interpolation between the nodes in a FITS file, \f$\Phi(t)\f$ is the time + * dependent phase, and \f${\tt m\_norm}\f$ is a normalisation constant. ***************************************************************************/ double GModelTemporalPhaseCurve::eval(const GTime& srcTime, const bool& gradients) const @@ -464,12 +464,12 @@ void GModelTemporalPhaseCurve::write(GXmlElement& xml) const * \f] * * where - * \f$t_0$\f is a reference time, - * \f$\Phi_0$\f is the phase at the reference time, - * \f$f$\f is the variation frequency at the reference time, - * \f$\dot{f}$\f is the first derivative of the variation frequency at the + * \f$t_0\f$ is a reference time, + * \f$\Phi_0\f$ is the phase at the reference time, + * \f$f\f$ is the variation frequency at the reference time, + * \f$\dot{f}\f$ is the first derivative of the variation frequency at the * reference time, and - * \f$\dot{f}$\f is the second derivative of the variation frequency at the + * \f$\dot{f}\f$ is the second derivative of the variation frequency at the * reference time. * * The phase \f$\Phi(t)\f$ is in the interval [0,1]. -- libgit2 0.21.4