Commit 5d5834ad authored by thomas.forbriger's avatar thomas.forbriger

libstfinv [WP][DOC]: rework definition of modules

properly distinguish between groups and namespaces
parent 1ad318ca
......@@ -40,7 +40,7 @@
"STFINV_DEBUG_H V1.0"
/*! \brief produce debug output
* \ingroup debug
* \ingroup group_debug
*
* \param C output will be generated if C == true
* \param N name of function
......@@ -55,14 +55,14 @@
}
/*! \brief report value in a sequence of output operators
* \ingroup debug
* \ingroup group_debug
*
* \param P parameter to dump
*/
#define STFINV_value( P ) #P << "=" << P
/*! \brief report value of expression
* \ingroup debug
* \ingroup group_debug
*
* \param P parameter to dump
*/
......
......@@ -104,7 +104,7 @@ processing are described in the \ref page_help.
/*! \brief Engines implemented in libstfinv
\defgroup engines Engines
\defgroup group_engines Engines
\todo
A detailed description for implementers is still missing
......@@ -116,7 +116,7 @@ processing are described in the \ref page_help.
/*! \brief Tools and utilities used by the libstfinv engines
\defgroup tools Internal tools and utilities
\defgroup group_tools Internal tools and utilities
\todo
A detailed description for implementers is still missing
......@@ -136,4 +136,18 @@ processing are described in the \ref page_help.
\date 04.10.2015
*/
/*======================================================================*/
/*! \brief Debug tools
\defgroup group_debug Debugging module
\todo
Selection of debug statements in most parts of the code is done by bits in
the value of the debug variable. E.g∵ The value 16 (bit 4) selects debugging
of the taper function. This is not yet properly documented.
\date 04.10.2015
*/
// ----- END OF doxygen.txt -----
......@@ -45,12 +45,12 @@
namespace stfinv {
/*! \brief Namespace for internal tools
* \ingroup tools
* \ingroup group_tools
*/
namespace tools {
/*! strip substring
* \ingroup tools
* \ingroup group_tools
*
* Strips off first substring up to given delimiter.
* The string is passed as a reference and will be modified (i.e. the
......@@ -65,14 +65,14 @@ namespace stfinv {
/*----------------------------------------------------------------------*/
/*! \brief A map to store parameters.
* \ingroup tools
* \ingroup group_tools
*/
typedef std::map<std::string,std::string> Tparamap;
/*----------------------------------------------------------------------*/
/*! \brief Create a parameter map from a parameter string
* \ingroup tools
* \ingroup group_tools
*
* \param p parameter string
* \param delimiter delimiter which separates two parameters
......@@ -86,7 +86,7 @@ namespace stfinv {
/*----------------------------------------------------------------------*/
/*! replace comma by whitespace
* \ingroup tools
* \ingroup group_tools
*
* \param s input string
* \return input string with all commas replaced by whitespace
......@@ -96,7 +96,7 @@ namespace stfinv {
/*----------------------------------------------------------------------*/
/*! \brief remove leading and trailing whitespace
* \ingroup tools
* \ingroup group_tools
*
* \param s any string
* \return value a input string with any leading and trailing whitespace
......
......@@ -47,7 +47,7 @@
namespace stfinv {
/*! \brief Fourier domain least squares engine
* \ingroup engines
* \ingroup group_engines
*
* \par Concept behind this engine
* If
......
......@@ -30,7 +30,7 @@
namespace stfinv {
/*! \brief Engine to find a finite, causal source time-history in time domain
* \ingroup engines
* \ingroup group_engines
*
* \par Concept behin this engine
*
......
......@@ -44,7 +44,7 @@
namespace stfinv {
/*! \brief Engine to provide a fixed wavelet
* \ingroup engines
* \ingroup group_engines
*/
class STFEngineFixedWavelet: public stfinv::STFFourierDomainEngine {
public:
......
......@@ -45,7 +45,7 @@
namespace stfinv {
/*! \brief Engine to apply a scalar factor
* \ingroup engines
* \ingroup group_engines
*
* \par Concept behin this engine
* This engine convolves the synthetic data with a discrete delta pulse so
......
......@@ -45,7 +45,7 @@
namespace stfinv {
/*! \brief Normalization engine
* \ingroup engines
* \ingroup group_engines
*
* \par Motivation
* On the down-side of Fourier domain least squares as is implemented
......
/*! \file tools.cc
* \brief tools and utilities (implementation)
*
* \ingroup tools
* \ingroup group_tools
* ----------------------------------------------------------------------------
*
* \author Thomas Forbriger
......
/*! \file tools.h
* \brief tools and utilities (prototypes)
*
* \ingroup tools
* \ingroup group_tools
* ----------------------------------------------------------------------------
*
* \author Thomas Forbriger
......@@ -48,7 +48,7 @@ namespace stfinv {
namespace tools {
/*! \brief function to compare doubles
* \ingroup tools
* \ingroup group_tools
* \param a a double value
* \param b a double value
* \param eps relative residual allowed for \c a and \c b
......@@ -60,7 +60,7 @@ namespace stfinv {
/* ---------------------------------------------------------------------- */
/*! \brief report engine identifier
* \ingroup tools
* \ingroup group_tools
* \param C class to report ID and oneline description
* \param os output stream to send output to
*/
......@@ -78,7 +78,7 @@ namespace stfinv {
/* ---------------------------------------------------------------------- */
/*! \brief report engine identifier with heading
* \ingroup tools
* \ingroup group_tools
* \param C class to report ID and oneline description
* \param os output stream to send output to
*/
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment