Correct Doxygen documentation

Jürgen Knödlseder
1 parent 717bee7d
Showing 4 changed files with 23 additions and 16 deletions
doc/source/develop/index.rst
inst/cta/src/GCTAPsfKing.cpp
src/model/GModelSpectralSmoothBrokenPlaw.cpp
src/model/GModelTemporalPhaseCurve.cpp
@@ -37,6 +37,14 @@ Below a few links to learn how to contribute to GammaLib:
    profiling/index
    releasing/index
  
+Links:
+
+* `GitLab <https://cta-gitlab.irap.omp.eu/gammalib/gammalib>`_
+* `GitHub <https://github.com/gammalib/gammalib>`_
+* `Redmine <https://cta-redmine.irap.omp.eu/projects/gammalib>`_
+* `Open HUB <https://www.openhub.net/p/gammalib>`_
+* `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
@@ -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
 {
@@ -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,
@@ -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&amp; 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].