From 882482d4b27f1e95549ccda179680975044e02d8 Mon Sep 17 00:00:00 2001
From: "Joachim Wuttke (o)" <j.wuttke@fz-juelich.de>
Date: Thu, 18 Dec 2014 12:14:27 +0100
Subject: [PATCH] more cleanup/doxygen

---
 pub/lib/calc.cpp     |  1 +
 pub/lib/coord.cpp    |  9 +--------
 pub/lib/coord.hpp    |  2 --
 pub/lib/func.hpp     |  6 ++++++
 pub/lib/list.cpp     |  4 ++--
 pub/lib/list.hpp     |  3 +--
 pub/lib/opr.cpp      |  6 ++++--
 pub/lib/opr.hpp      |  2 +-
 pub/lib/plot.cpp     | 16 ++++++++++------
 pub/lib/plot.hpp     |  4 ++--
 pub/lib/special.cpp  |  2 +-
 pub/lib/special.hpp  |  2 +-
 pub/lib/toplevel.hpp |  2 ++
 13 files changed, 32 insertions(+), 27 deletions(-)

diff --git a/pub/lib/calc.cpp b/pub/lib/calc.cpp
index 3aa7da7a..c75c999b 100644
--- a/pub/lib/calc.cpp
+++ b/pub/lib/calc.cpp
@@ -7,6 +7,7 @@
 //! \file  calc.cpp
 //! \brief NCalc::Calculator: the command-line pocket calculator.
 
+
 #include <memory>
 #include <string>
 #include <vector>
diff --git a/pub/lib/coord.cpp b/pub/lib/coord.cpp
index e13a1e5b..378d3eb0 100644
--- a/pub/lib/coord.cpp
+++ b/pub/lib/coord.cpp
@@ -7,6 +7,7 @@
 //! \file  coord.cpp
 //! \brief Coordinates CCoord, numeric parameters CParam.
 
+
 #include <cstring>
 #include <iostream>
 
@@ -128,13 +129,6 @@ string CCoord::str_ps() const // two blanks instead of one, and no unit ""
     return name + ( unit!="" ? ("  (" + unit + ")") : "");
 }
 
-//! Format for saving in a01 format.
-
-string CCoord::to_a01() const
-{
-    return name + "\t" + unit;
-}
-
 //! Parse old a01 format.
 
 string CCoord::load_a01(string in)
@@ -167,4 +161,3 @@ ostream& operator<< (ostream &s, CCoord C)
 {
     return s << C.str_std();
 }
-
diff --git a/pub/lib/coord.hpp b/pub/lib/coord.hpp
index e0854b3b..6560e239 100644
--- a/pub/lib/coord.hpp
+++ b/pub/lib/coord.hpp
@@ -58,5 +58,3 @@ class CParam {
     CParam( string _name, string _unit="", double _val=0, double _dval=0 ) :
         Co( CCoord(_name, _unit) ), val(_val), dval(_dval) {}
 };
-
-
diff --git a/pub/lib/func.hpp b/pub/lib/func.hpp
index 884e2b2f..d75acefb 100644
--- a/pub/lib/func.hpp
+++ b/pub/lib/func.hpp
@@ -35,6 +35,8 @@ class CFunc {
     void register_me() const;
 };
 
+//! Wrapping a function with 1 argument.
+
 class CFunc1 : public CFunc {
  public:
     func_f1 f1;
@@ -44,6 +46,8 @@ class CFunc1 : public CFunc {
     class CCoord coord( class CCoord *co ) const;
 };
 
+//! Wrapping a function with 2 arguments.
+
 class CFunc2 : public CFunc {
  public:
     func_f2 f2;
@@ -53,6 +57,8 @@ class CFunc2 : public CFunc {
     class CCoord coord( class CCoord *co1, class CCoord *co2 ) const;
 };
 
+//! Wrapping a function with 3 arguments.
+
 class CFunc3 : public CFunc {
  public:
     func_f3 f3;
diff --git a/pub/lib/list.cpp b/pub/lib/list.cpp
index 973e8a86..8e8bacd1 100644
--- a/pub/lib/list.cpp
+++ b/pub/lib/list.cpp
@@ -5,7 +5,8 @@
 //***************************************************************************//
 
 //! \file  list.cpp
-//! \brief index collection CList
+//! \brief index collection CList.
+
 
 #include <algorithm>
 
@@ -290,4 +291,3 @@ int CList::parseListvalue( string inp, int which )
             + S(inf) + "," + S((int)sup) + ")";
     return val;
 }
-
diff --git a/pub/lib/list.hpp b/pub/lib/list.hpp
index aebe498f..6ed62dd1 100644
--- a/pub/lib/list.hpp
+++ b/pub/lib/list.hpp
@@ -5,7 +5,7 @@
 //***************************************************************************//
 
 //! \file  list.hpp
-//! \brief index collection CList
+//! \brief index collection CList.
 
 //! An index collection (a sequence of non-negative integers).
 
@@ -80,4 +80,3 @@ private:
 
     string sel2text() const;
 };
-
diff --git a/pub/lib/opr.cpp b/pub/lib/opr.cpp
index 3ef3e56a..6d3b5b92 100644
--- a/pub/lib/opr.cpp
+++ b/pub/lib/opr.cpp
@@ -5,7 +5,8 @@
 //***************************************************************************//
 
 //! \file  opr.cpp
-//! \brief NOperate, NIntOld: functional operations
+//! \brief NOperate: functional operations.
+
 
 #include <iostream>
 #include <boost/format.hpp>
@@ -25,10 +26,12 @@
 
 using boost::format;
 
+
 //***************************************************************************//
 //* operate via generic expressions                                         *//
 //***************************************************************************//
 
+
 //! Display data. Use boolean expression to display only a subset of the data.
 
 void NOperate::show( const string& subcmd ) 
@@ -451,4 +454,3 @@ void NOperate::Functional( const string& subcmd )
         NOlm::mem_store( fout, fiter.k() );
     }
 }
-
diff --git a/pub/lib/opr.hpp b/pub/lib/opr.hpp
index 00b9ba1c..6f66c110 100644
--- a/pub/lib/opr.hpp
+++ b/pub/lib/opr.hpp
@@ -5,7 +5,7 @@
 //***************************************************************************//
 
 //! \file  opr.hpp
-//! \brief NOperate, NIntOld: functional operations
+//! \brief NOperate: functional operations.
 
 //! Functional operations.
 
diff --git a/pub/lib/plot.cpp b/pub/lib/plot.cpp
index aeee6122..4e3aeae1 100644
--- a/pub/lib/plot.cpp
+++ b/pub/lib/plot.cpp
@@ -5,7 +5,8 @@
 //***************************************************************************//
 
 //! \file  plot.cpp
-//! \brief NPlot: plot data and curves
+//! \brief NPlot: plot data and curves.
+
 
 #include <iostream>
 #include <vector>
@@ -23,10 +24,12 @@
 #include "plot.hpp"
 #include "curve.hpp"
 
+
 //**************************************************************************//
 //*  Subroutines: determine data ranges                                    *//
 //**************************************************************************//
 
+
 //! Loop over selected data files to determine x range.
 
 void determine_Xrange( CPlot* plot, CList* JSel )
@@ -59,6 +62,7 @@ void determine_Xrange( CPlot* plot, CList* JSel )
     plot->X.setRoundedLimits( inf, sup );
 }
 
+
 //! Loop over selected files to determine y range for current x range.
 
 void determine_Yrange( CPlot* plot, CList* JSel )
@@ -103,6 +107,7 @@ void determine_Yrange( CPlot* plot, CList* JSel )
 //*  Subroutines: plot one scan                                            *//
 //**************************************************************************//
 
+
 //! Plot scan j of data file fd; return number of points plotted.
 
 int plot_data( CPlot* plot, POld fd, int k, int j, int pstyle )
@@ -172,6 +177,7 @@ int plot_data( CPlot* plot, POld fd, int k, int j, int pstyle )
     return np;
 }
 
+
 //! Plot scan j of convolved curve file fc; return number of points plotted.
 
 int plot_curve_convolved( CPlot* plot, POlc fc, int k, int j, int cstyle )
@@ -231,8 +237,8 @@ int plot_curve_to_grid( CPlot* plot, POlc fc, int k, int j, int cstyle )
     return xp.size();
 }
 
-//! Plot scan j of non-convolved curve file fc on equidistant grid;
-//! return number of points plotted.
+
+//! Plot scan j of non-convolved curve file fc on equidistant grid; return number of points plotted.
 
 int plot_curve_equidist( CPlot* plot, POlc fc, int k, int j, int cstyle )
 {
@@ -255,8 +261,7 @@ int plot_curve_equidist( CPlot* plot, POlc fc, int k, int j, int cstyle )
     return xp.size();
 }
 
-//! Plot scan j of non-convolved curve file fc, refining the grid where
-//! necessary; return number of points plotted.
+//! Plot scan j of non-convolved curve file fc, refining the grid where necessary; return number of points plotted.
 
 int plot_curve_refine( CPlot* plot, POlc fc, int k, int j, int cstyle )
 {
@@ -513,4 +518,3 @@ void NPlot::Plot( class CPlot *plot, bool add, const string& mode )
     }
     plot->showSpecs();
 }
-
diff --git a/pub/lib/plot.hpp b/pub/lib/plot.hpp
index b6a9baa8..1fe52e76 100644
--- a/pub/lib/plot.hpp
+++ b/pub/lib/plot.hpp
@@ -5,11 +5,11 @@
 //***************************************************************************//
 
 //! \file  plot.hpp
-//! \brief NPlot: plot data and curves
+//! \brief NPlot: plot data and curves.
+
 
 //! Plot data and curves.
 
 namespace NPlot {
     void Plot( class CPlot *plot, bool add, const string& mode="ask" );
 }
-
diff --git a/pub/lib/special.cpp b/pub/lib/special.cpp
index bfdfec91..7315677a 100644
--- a/pub/lib/special.cpp
+++ b/pub/lib/special.cpp
@@ -7,6 +7,7 @@
 //! \file  special.cpp
 //! \brief NSpecial: this and that, written ad hoc.
 
+
 #include <iostream>
 #include <fftw3.h>
 #include <string>
@@ -114,4 +115,3 @@ void NSpecial::Test()
     }
     NOlm::mem_store( fout );
 }
-
diff --git a/pub/lib/special.hpp b/pub/lib/special.hpp
index 7b52c224..c8b7dcbe 100644
--- a/pub/lib/special.hpp
+++ b/pub/lib/special.hpp
@@ -7,6 +7,7 @@
 //! \file  special.hpp
 //! \brief NSpecial: this and that, written ad hoc.
 
+
 //  What falls out of use goes to ../../arch/one-time-routines/
 
 //! This and that, written ad hoc.
@@ -15,4 +16,3 @@ namespace NSpecial {
     void FourierCosine();
     void Test();
 }
-
diff --git a/pub/lib/toplevel.hpp b/pub/lib/toplevel.hpp
index 60489fbc..3a7f0583 100644
--- a/pub/lib/toplevel.hpp
+++ b/pub/lib/toplevel.hpp
@@ -9,6 +9,8 @@
 
 #include <time.h>
 
+//! Execution context.
+
 class CFrida {
  public:
     CFrida();
-- 
GitLab