Fix typos in docstrings

Christoph Deil
1 parent ab61c2c6
Showing 45 changed files with 56 additions and 56 deletions
include/GApplication.hpp
include/GDerivative.hpp
include/GEnergies.hpp
include/GEvent.hpp
include/GEventAtom.hpp
include/GException.hpp
include/GFitsImage.hpp
include/GFitsTableBitCol.hpp
include/GFitsTableCol.hpp
include/GHealpix.hpp
include/GIntegral.hpp
include/GLog.hpp
include/GMatrixSymmetric.hpp
include/GObservation.hpp
include/GObservations.hpp
include/GOptimizerLM.hpp
include/GTestSuites.hpp
include/GTools.hpp
include/GVector.hpp
include/GXml.hpp
@@ -39,7 +39,7 @@
 /***********************************************************************//**
  * @class GApplication
  *
- * @brief GammaLib application interface defintion
+ * @brief GammaLib application interface definition
  *
  * This class provides the base class for ftools-like executables based on
  * GammaLib. The ftools-like executables will be implemented as derived
@@ -221,7 +221,7 @@ const bool&amp; GDerivative::silent(void) const
  *
  * @param[in] function Function.
  *
- * Sets the function for which the derivate should be determined.
+ * Sets the function for which the derivative should be determined.
  ***************************************************************************/
 inline
 void GDerivative::function(GFunction* function)
@@ -148,7 +148,7 @@ bool GEnergies::is_empty(void) const
 /***********************************************************************//**
- * @brief Reserves space for energues in container
+ * @brief Reserves space for energies in container
  *
  * @param[in] num Number of energies.
  *
@@ -41,7 +41,7 @@
  * @brief Abstract interface for the event classes.
  *
  * This class provides an abstract interface to an event. An event can be
- * either a physical event occuring in the instrument (called an event
+ * either a physical event occurring in the instrument (called an event
  * atom) or a collection of events with similar properties (called an
  * event bin). While event atoms are used for unbinned analysis, event bins
  * are used for binned analysis. The methods is_atom() and is_bin() inform
@@ -40,7 +40,7 @@
  *
  * @brief Abstract interface for the event atom class.
  *
- * An event atom is a single event occuring in an instrument. Event atoms
+ * An event atom is a single event occurring in an instrument. Event atoms
  * are used for unbinned analysis.
  *
  * Each event has 3 attributes: energy, instrument direction and time.
@@ -20,7 +20,7 @@
  ***************************************************************************/
 /**
  * @file GException.hpp
- * @brief Exception handler interface definiton.
+ * @brief Exception handler interface definition.
  * @author Juergen Knoedlseder
  */
@@ -157,7 +157,7 @@ const int&amp; GFitsImage::naxis(void) const
 /***********************************************************************//**
- * @brief Return number of nul values envountered during loading
+ * @brief Return number of nul values encountered during loading
  ***************************************************************************/
 inline
 const int& GFitsImage::anynul(void) const
@@ -39,7 +39,7 @@
  *
  * This class implements a FITS table Bit column. Bits are stored internally
  * in an array of type char and is transferred to the file in junks of
- * 8 Bits (using the cfitsio type TBYTE).
+ * 8 Bits (using the CFITSIO type TBYTE).
  ***************************************************************************/
 class GFitsTableBitCol : public GFitsTableCol {
@@ -132,7 +132,7 @@ protected:
                                   //!< This parameter is used to signal if a
                                   //!< table column corresponds to a FITS file
                                   //!< column. If it is set to 0 there is no
-                                  //!< correspondance.
+                                  //!< correspondence.
     int              m_type;      //!< Column type
     int              m_repeat;    //!< Repeat value of column
     int              m_width;     //!< Width of single column element
@@ -140,7 +140,7 @@ protected:
                                   //!< m_number = m_repeat / m_width
     int              m_length;    //!< Length of column (number of rows)
     bool             m_variable;  //!< Signals if column is variable length
-    int              m_varlen;    //!< Maximum number of elements in variable-lgth
+    int              m_varlen;    //!< Maximum number of elements in variable-length
     std::vector<int> m_rowstart;  //!< Start index of each row
     mutable int      m_size;      //!< Size of allocated data area (0 if not loaded)
     int              m_anynul;    //!< Number of NULLs encountered
@@ -37,7 +37,7 @@
 /***********************************************************************//**
  * @class GHealpix
  *
- * @brief HealPix projection class interface defintion
+ * @brief HealPix projection class interface definition
  *
  * The HealPix projection class has been implemented by adapting code from
  * the HealPix library (version 2.1). For more information about HEALPix, see
@@ -36,7 +36,7 @@
 /***********************************************************************//**
  * @class GIntegral
  *
- * @brief GIntegral class interface defintion.
+ * @brief GIntegral class interface definition.
  *
  * This class allows to perform integration using various methods. The
  * integrand is implemented by a derived class of GIntegrand.
@@ -38,7 +38,7 @@
 /***********************************************************************//**
  * @class GLog
  *
- * @brief Information logger interface defintion.
+ * @brief Information logger interface definition.
  *
  * This class implements an interface for logging of text messages to the
  * standard output and/or error streams and into an ASCII log file. It
@@ -40,7 +40,7 @@ class GVector;
 /***********************************************************************//**
  * @class GMatrixSymmetric
  *
- * @brief Symmetric matrix class interface defintion
+ * @brief Symmetric matrix class interface definition
  *
  * This class implements a symmetric matrix. The class stores only a triangle
  * physically, imposing thus strict matrix symmetry.
@@ -47,7 +47,7 @@
  *
  * This class provides an abstract interface for an observation. The
  * observation collects information about the instrument, holds the measured
- * events, and provides information about the analysis definiton.
+ * events, and provides information about the analysis definition.
  * The method model() returns the probability for an event to be measured
  * with a given instrument direction, a given energy and at a given time,
  * given a source model and an instrument pointing direction.
@@ -80,7 +80,7 @@
  *
  * Based on the list of models, the optimize() method will optimize all
  * model parameters that are marked as free in the list of models. The
- * npred() method returns the total number of events that are prediced
+ * npred() method returns the total number of events that are predicted
  * by all models after optimization.
  *
  * GObservations also provides an optimizer class that is derived from
@@ -83,7 +83,7 @@ public:
     int           max_boundary_hits(void) const { return m_max_hit; }     //!< @brief Return maximum number of boundary hits
     const double& lambda_start(void) const { return m_lambda_start; }     //!< @brief Return lambda start value
     const double& lambda_inc(void) const { return m_lambda_inc; }         //!< @brief Return lambda increment
-    const double& lambda_dec(void) const { return m_lambda_dec; }         //!< @brief Return lambda derement
+    const double& lambda_dec(void) const { return m_lambda_dec; }         //!< @brief Return lambda decrement
     const double& lambda(void) const { return m_lambda; }                 //!< @brief Return lambda value
     const double& eps(void) const { return m_eps; }                       //!< @brief Return convergence precision
@@ -20,7 +20,7 @@
  ***************************************************************************/
 /**
  * @file GTestSuites.hpp
- * @brief Test suite container class interface defintion
+ * @brief Test suite container class interface definition
  * @author Jean-Baptiste Cayrou
  */
@@ -121,7 +121,7 @@ bool gammalib::is_infinite(const double&amp; x)
  *
  * Signals if the argument @p x is not a number.
  *
- * This function is a very simple kluge. It may not work on all systems.
+ * This function is a very simple kludge. It may not work on all systems.
  ***************************************************************************/
 inline
 bool gammalib::is_notanumber(const double& x)
@@ -40,7 +40,7 @@
  * @brief Vector class
  *
  * This class implement a double precision floating point vector class that
- * is intended to be used for numerical computation (it is not ment to
+ * is intended to be used for numerical computation (it is not meant to
  * replace the std::vector template class).
  ***************************************************************************/
 class GVector : public GBase {
@@ -115,7 +115,7 @@
  * and to load and save the document from a URL. GXml derives from GContainer
  * as it behaves like a container class. It does, however, not contain an
  * explicit list, as the only data member of the class is a single instance
- * of GXmlDocument. GXmlDocument contains the hierachical list of all XML
+ * of GXmlDocument. GXmlDocument contains the hierarchical list of all XML
  * nodes.
  *
  * To manipulate the child nodes of GXmlDocument, the usual container class
@@ -693,7 +693,7 @@ void GCOMEventCube::set_scatter_directions(void)
     // Throw an error if we have no sky pixels
     if (npix() < 1) {
         throw GCOMException::no_sky(G_SET_SCATTER_DIRECTIONS,
-              "Every COMPTEL event cube needs a definiton of sky pixels.");
+              "Every COMPTEL event cube needs a definition of sky pixels.");
     }
     // Clear vectors
@@ -760,7 +760,7 @@ void GCOMEventCube::set_energies(void)
     // Throw an error if GTI is empty
     if (m_ebounds.size() < 1) {
         throw GCOMException::no_ebds(G_SET_ENERGIES, "Every COMPTEL event"
-                  " cube needs a definiton of the energy boundaries.");
+                  " cube needs a definition of the energy boundaries.");
     }
     // Compute the logarithmic mean energy
@@ -59,7 +59,7 @@ void com_wcs_mer2car(GSkymap&amp; map)
     // Apply kluge only if the skymap is in Mercator's projection
     if (wcs != NULL && wcs->code() == "MER") {
-        // Extract original WCS definiton
+        // Extract original WCS definition
         double crval1 = wcs->crval(0);
         double crval2 = wcs->crval(1);
         double crpix1 = wcs->crpix(0);
@@ -45,7 +45,7 @@ class GCTAResponse;
  * @brief CTA ARF effective area class
  *
  * This class implements the CTA effective area response that is defined by
- * an auxilliary response function (ARF) file.
+ * an auxiliary response function (ARF) file.
  ***************************************************************************/
 class GCTAAeffArf : public GCTAAeff {
@@ -159,7 +159,7 @@ const double&amp; GCTAAeffArf::sigma(void) const
  *
  * Sets the theta cut angle which defines the energy independent cut that
  * has been assumed in deriving the ARF values. If @p thetacut os 0 (which
- * is the default avlue), not thetacut will be applied.
+ * is the default value), not thetacut will be applied.
  ***************************************************************************/
 inline
 void GCTAAeffArf::thetacut(const double& thetacut)
@@ -38,7 +38,7 @@
 /***********************************************************************//**
  * @class GCTAEventBin
  *
- * @brief GCTAEventBin class interface defintion
+ * @brief GCTAEventBin class interface definition
  *
  * This class implements a CTA event bin. The event bin is a collection of
  * pointers that points to the relevant information in memory. The class
@@ -246,9 +246,9 @@ const double&amp; GCTAResponse::eps(void) const
 /***********************************************************************//**
- * @brief Return Redestribution Matrix File name
+ * @brief Return Redistribution Matrix File name
  *
- * @return Redestribution Matrix File name.
+ * @return Redistribution Matrix File name.
  ***************************************************************************/
 inline
 const std::string& GCTAResponse::rmffile(void) const
@@ -651,7 +651,7 @@ void GCTAEventCube::set_directions(void)
     // Throw an error if we have no sky pixels
     if (npix() < 1) {
         throw GCTAException::no_sky(G_SET_DIRECTIONS, "Every CTA event cube"
-                                   " needs a definiton of the sky pixels.");
+                                   " needs a definition of the sky pixels.");
     }
     // Clear old pixel directions and solid angle
@@ -697,7 +697,7 @@ void GCTAEventCube::set_energies(void)
     // Throw an error if we have no energy bins
     if (ebins() < 1) {
         throw GCTAException::no_ebds(G_SET_ENERGIES, "Every CTA event cube"
-                             " needs a definiton of the energy boundaries.");
+                             " needs a definition of the energy boundaries.");
     }
     // Clear old bin energies and energy widths
@@ -130,7 +130,7 @@ const GLATLtCube* GLATObservation::ltcube(void) const
 inline
 std::string GLATObservation::instrument(void) const
 {
-    // Return instument name
+    // Return instrument name
     return ("LAT");
 }
@@ -808,7 +808,7 @@ void GLATEventCube::set_directions(void)
     // Throw an error if we have no sky pixels
     if (npix() < 1) {
         throw GLATException::no_sky(G_SET_DIRECTIONS, "Every LAT event cube"
-                                   " needs a definiton of the sky pixels.");
+                                   " needs a definition of the sky pixels.");
     }
     // Clear old pixel directions and solid angle
@@ -848,7 +848,7 @@ void GLATEventCube::set_energies(void)
     // Throw an error if we have no energy bins
     if (ebins() < 1) {
         throw GLATException::no_ebds(G_SET_ENERGIES, "Every LAT event cube"
-                             " needs a definiton of the energy boundaries.");
+                             " needs a definition of the energy boundaries.");
     }
     // Clear old bin energies and energy widths
@@ -20,7 +20,7 @@
  ***************************************************************************/
 /**
  * @file GApplication.i
- * @brief GammaLib application base class Python interface defintion
+ * @brief GammaLib application base class Python interface definition
  * @author Juergen Knoedlseder
  */
 %{
@@ -37,7 +37,7 @@
 /***********************************************************************//**
  * @class GApplication
  *
- * @brief GammaLib application Python interface defintion.
+ * @brief GammaLib application Python interface definition.
  ***************************************************************************/
 class GApplication : public GBase {
 public:
@@ -33,7 +33,7 @@
 /***********************************************************************//**
  * @class GIntegral
  *
- * @brief Integration class Python interface defintion.
+ * @brief Integration class Python interface definition.
  *
  * This class allows to perform integration using various methods. The
  * integrand is implemented by a derived class of GIntegrand.
@@ -33,7 +33,7 @@
 /***********************************************************************//**
  * @class GLog
  *
- * @brief Information logger interface defintion.
+ * @brief Information logger interface definition.
  ***************************************************************************/
 class GLog {
 public:
@@ -32,7 +32,7 @@
 /***********************************************************************//**
  * @class GMatrixBase
  *
- * @brief Abstract matrix base class interface defintion
+ * @brief Abstract matrix base class interface definition
  ***************************************************************************/
 class GMatrixBase : public GBase {
 public:
@@ -33,7 +33,7 @@
 /***********************************************************************//**
  * @class GOptimizerLM
  *
- * @brief GOptimizerLM class SWIG interface defintion.
+ * @brief GOptimizerLM class SWIG interface definition.
  ***************************************************************************/
 class GOptimizerLM : public GOptimizer {
 public:
@@ -33,7 +33,7 @@
 /***********************************************************************//**
  * @class GSkyPixel
  *
- * @brief GSkyPixel class interface defintion
+ * @brief GSkyPixel class interface definition
  ***************************************************************************/
 class GSkyPixel : public GBase {
@@ -103,7 +103,7 @@ static int skymap_tuple(PyObject *input, int *ptr) {
 /***********************************************************************//**
  * @class GSkymap
  *
- * @brief GSkymap class interface defintion
+ * @brief GSkymap class interface definition
  ***************************************************************************/
 class GSkymap : public GBase {
@@ -32,7 +32,7 @@
 /***********************************************************************//**
  * @class GTestCase
  *
- * @brief Test case Python interface defintion
+ * @brief Test case Python interface definition
  ***************************************************************************/
 class GTestCase : public GBase {
 public:
@@ -142,7 +142,7 @@ public:
 /***********************************************************************//**
  * @class GTestSuite
  *
- * @brief Abstract test suite Python interface defintion
+ * @brief Abstract test suite Python interface definition
  ***************************************************************************/
 class GTestSuite : public GBase {
 public:        
@@ -222,7 +222,7 @@ public:
 /***********************************************************************//**
  * @class GTestSuite
  *
- * @brief Test suite Python interface defintion
+ * @brief Test suite Python interface definition
  ***************************************************************************/
 class GPythonTestSuite : public GTestSuite {
 public:        
@@ -20,7 +20,7 @@
  ***************************************************************************/
 /**
  * @file GTestSuites.i
- * @brief Test suite container class interface defintion
+ * @brief Test suite container class interface definition
  * @author Jean-Baptiste Cayrou
  */
 %{
@@ -20,7 +20,7 @@
  ***************************************************************************/
 /**
  * @file GException_app.cpp
- * @brief Application exception handler interface definiton
+ * @brief Application exception handler interface definition
  * @author Juergen Knoedlseder
  */
@@ -1266,7 +1266,7 @@ void GPars::parse(void)
         if (contains(fields[0])) {
             throw GException::par_file_syntax_error(G_PARSE, 
                                                     gammalib::strip_chars(line,"\n"),
-                          "redefiniton of parameter name \""+fields[0]+"\"");
+                          "redefinition of parameter name \""+fields[0]+"\"");
         }
         // Add parameter
@@ -908,7 +908,7 @@ GMatrix GMatrix::abs(void) const
  *
  * Returns the fill of the matrix. The fill of a matrix is defined as the
  * number non-zero elements devided by the number of total elements. By
- * definiton, the fill is comprised in the interval [0,..,1].
+ * definition, the fill is comprised in the interval [0,..,1].
  *
  * The fill of a matrix with zero elements will be set to 0.
  ***************************************************************************/
@@ -1511,7 +1511,7 @@ GMatrixSparse GMatrixSparse::abs(void) const
  * @brief Returns fill of matrix
  *
  * The fill of a matrix is defined as the number non-zero elements devided
- * by the number of total elements. By definiton, the fill is comprised
+ * by the number of total elements. By definition, the fill is comprised
  * in the interval [0,..,1]. The fill of an undefined matrix is defined to
  * be 0.
  ***************************************************************************/
@@ -140,7 +140,7 @@ GHealpix::GHealpix(const GFitsHDU&amp; hdu) : GSkyProjection()
     // Initialise class members
     init_members();
-    // Read Healpix defintion from FITS table
+    // Read Healpix definition from FITS table
     read(hdu);
     // Return
@@ -251,7 +251,7 @@ GHealpix* GHealpix::clone(void) const
 /***********************************************************************//**
- * @brief Read Healpix definiton from FITS header
+ * @brief Read Healpix definition from FITS header
  *
  * @param[in] hdu FITS HDU.
  *
@@ -309,7 +309,7 @@ void GHealpix::read(const GFitsHDU&amp; hdu)
 /***********************************************************************//**
- * @brief Write Healpix definiton into FITS HDU
+ * @brief Write Healpix definition into FITS HDU
  *
  * @param[in] hdu FITS HDU.
  *
@@ -207,7 +207,7 @@ GWcs&amp; GWcs::operator=(const GWcs&amp; wcs)
  ==========================================================================*/
 /***********************************************************************//**
- * @brief Read WCS definiton from FITS header.
+ * @brief Read WCS definition from FITS header.
  *
  * @param[in] hdu FITS HDU.
  *
@@ -298,7 +298,7 @@ void GWcs::read(const GFitsHDU&amp; hdu)
 /***********************************************************************//**
- * @brief Write WCS definiton into FITS HDU header
+ * @brief Write WCS definition into FITS HDU header
  *
  * @param[in] hdu FITS HDU.
  *
@@ -35,7 +35,7 @@
 /***********************************************************************//**
  * @class GClass
  *
- * @brief [brief descriptor] interface defintion
+ * @brief [brief descriptor] interface definition
  ***************************************************************************/
 class GClass : public GBase {