doxygen headers for all classes.

eliminate CListIter, obsolete since long.

pub/src/axis.h

@@ -5,6 +5,8 @@
 //* http://apps.jcns.fz-juelich.de                                         *//
 //**************************************************************************//
 
+//! One axis of a coordinate system, for use in plotting.
+
 class CAxis {
  public:
     double inf, sup;

pub/src/coord.cpp

@@ -154,5 +154,3 @@ ostream& operator<< (ostream &s, CCoord C)
 {
     return s << C.str();
 }
-
-string strg(const CCoord& C) { return C.str(); };

pub/src/coord.h

@@ -5,6 +5,8 @@
 //* http://apps.jcns.fz-juelich.de                                         *//
 //**************************************************************************//
 
+//! A coordinate, consisting of a name and a unit.
+
 class CCoord {
  public:
     string name, unit;
@@ -29,7 +31,7 @@ class CCoord {
         return !(*this==Co2); };
 };
 
-string strg(const CCoord& C);
+//! A file-wide parameter, consisting of a coordinate and a value.
 
 class CParam {
  public:

pub/src/func.h

@@ -14,7 +14,9 @@ typedef void (*deri_f2) (double&,double&,double,double,double,double);
 typedef void (*deri_f3) (double&,double&,
                          double,double,double,double,double,double);
 
-class CFunc { // public (short) interface => TAKE CARE
+//! A wrapper holding a function, its gradient, its name, and more.
+
+class CFunc {
  public:
     string txt;
     int narg;

pub/src/list.h

@@ -5,26 +5,26 @@
 //* http://apps.jcns.fz-juelich.de                                         *//
 //**************************************************************************//
 
-// A CList is basically a sequence of non-zero integers like 1-3,5,7,11.
-
-// User-supplied input strings, however, may be more complicated:
-// - input must not be ordered;
-// - duplication of items is currently tolerated
-//     (** this is NOT a design feature; it may change in the future **);
-// - an interval can be qualified by a step: '1-100.2' means '1,3,5,...,99';
-// - the last interval may read '101-*': it extends up to sup;
-// - the user selection may just read '*': it extends from inf to sup;
-// where inf and sup are context-dependent lower and upper bound.
-
-// User-supplied bounds play two roles:
-// - they define, how '-*' and '*' are interpreted;
-// - in Ask(), they determine what answers are acceptable.
-// These bounds can be set
-// - by a constructor,
-// - by Ask(),
-// - by evaluate.
-// They are valid until they are overwritten.
-// To reset a CList into a bound-free state, it must be re-constructed.
+//! An index collection (a sequence of non-negative integers).
+
+//! User-supplied input strings, however, may be more complicated:
+//! - input must not be ordered;
+//! - duplication of items is currently tolerated
+//!     (** this is NOT a design feature; it may change in the future **);
+//! - an interval can be qualified by a step: '1-100.2' means '1,3,5,...,99';
+//! - the last interval may read '101-*': it extends up to sup;
+//! - the user selection may just read '*': it extends from inf to sup;
+//! where inf and sup are context-dependent lower and upper bound.
+
+//! User-supplied bounds play two roles:
+//! - they define, how '-*' and '*' are interpreted;
+//! - in Ask(), they determine what answers are acceptable.
+//! These bounds can be set
+//! - by a constructor,
+//! - by Ask(),
+//! - by evaluate.
+//! They are valid until they are overwritten.
+//! To reset a CList into a bound-free state, it must be re-constructed.
 
 class CList {
 private:
@@ -78,21 +78,3 @@ private:
 
     string sel2text() const;
 };	
-
-class ListIter { 
-// OBSOLETE. will be eliminated as soon as ScanBreak is revised
-private:
-    uint i;
-    CList L;
-public:
-    ListIter() { reset(); };
-    ListIter(CList L_in) { reset(L_in); };
-    void reset() { i=0; };
-    void reset(CList L_in) { L = L_in; reset(); };
-    uint operator()(uint *val) {
-        if (i>=L.size()) return 0;
-        *val = L.V[i++];
-        return i;
-    };
-};
-

pub/src/mem.cpp

@@ -99,6 +99,8 @@ namespace NOlm {
 
 namespace NOlm {
 
+    //! Iterate over file selection. Implementation for use in IterateO.
+
     class MyIterate {
     public: // TODO: should become private
         uint iV;

pub/src/rssm.cpp

@@ -25,6 +25,8 @@
 
 using namespace std;
 
+//! All relevant information extracted from one raw-data file from SPHERES.
+
 class CRawfileSpheres {
  public:
     void RdRawYam( ifstream& F_in );

pub/src/zentry.h

@@ -6,7 +6,7 @@
 //**************************************************************************//
 
 
-//! z-entry: virtual base class for spec and curve.
+//! Virtual base class for CCurve and CSpec, holds a z vector and more.
 
 class CZentry {
  public:
@@ -21,7 +21,7 @@ class CZentry {
 };
 
 
-//! curve: parameters and fit outcome.
+//! A CZentry within a curve file, holds parameters and fit outcome.
 
 class CCurve: public CZentry {
  public:
@@ -35,7 +35,7 @@ class CCurve: public CZentry {
 };
 
 
-//! spec: x-y-dy data.
+//! A CZentry within a data file, holds a x-y-dy data set.
 
 class CSpec: public CZentry {
  public: