Commit 369b4233 authored by thomas.forbriger's avatar thomas.forbriger
Browse files

libdatrwxx [WP][DOC]: replace group ID su by group_su

parent 9c295730
......@@ -70,7 +70,7 @@ namespace datrw {
/*! \brief class to read SeismicUnix data
*
* \ingroup su
* \ingroup group_su
*/
class isustream: public idatstream {
public:
......@@ -95,7 +95,7 @@ namespace datrw {
/*! \brief class to write SU data
*
* \ingroup su
* \ingroup group_su
*/
class osustream: public odatstream {
public:
......
......@@ -79,12 +79,12 @@ namespace datrw {
/*======================================================================*/
/*! some local helpers
* \ingroup su
* \ingroup group_su
*/
namespace helper {
/*! \brief output format modifier for debug output
* \ingroup su
* \ingroup group_su
*/
class MyOutputFormat {
public:
......
......@@ -55,7 +55,7 @@ namespace datrw {
// conversion functions
/*! \brief convert a decimal power to a SeismicUn*x scale value
* \ingroup su
* \ingroup group_su
*
* \param p exponent for the power of ten
* \return corresponding SeismicUn*x scale value like scalco or scalel
......@@ -65,7 +65,7 @@ namespace datrw {
/*----------------------------------------------------------------------*/
/*! \brief convert a SeismicUn*x scale value to a decimal power
* \ingroup su
* \ingroup group_su
*
* \param s SeismicUn*x scale value like scalco or scalel
* \param strict if true: abort if scale does not match original
......@@ -77,7 +77,7 @@ namespace datrw {
/*----------------------------------------------------------------------*/
/*! \brief fix a SeismicUn*x scale value
* \ingroup su
* \ingroup group_su
*
* some code out there produces SU data with scale values understood
* as exponents of ten; SEGY defines the scale value to be taken as
......@@ -94,7 +94,7 @@ namespace datrw {
/*----------------------------------------------------------------------*/
/*! \brief convert scale value to a factor to be applied
* \ingroup su
* \ingroup group_su
*
* \param s SeismicUn*x scale value like scalco or scalel
* \param strict if true: abort if scale does not match original
......@@ -106,7 +106,7 @@ namespace datrw {
/*======================================================================*/
/*! \brief scaled coordinate.
* \ingroup su
* \ingroup group_su
*
* This struct holds one coordinate together with a scale value.
* It provides functions to support appropriate scaling and to explore
......@@ -178,7 +178,7 @@ namespace datrw {
/*----------------------------------------------------------------------*/
/*! \brief full set of coordinates.
* \ingroup su
* \ingroup group_su
*
* This struct holds a full set of coordinates for a SEG-Y trace header.
* It provides functions to read the values from a given trace header and
......
......@@ -46,7 +46,7 @@ namespace datrw {
//@{
/*! \brief Format properties
* \ingroup su
* \ingroup group_su
*/
const bool su::isbinary=true;
const char* const su::streamID="su";
......@@ -89,7 +89,7 @@ namespace datrw {
/*----------------------------------------------------------------------*/
/*! \brief evaluate input stream format modifiers
* \ingroup su
* \ingroup group_su
*/
options::SUHeaderControl inputmodifiers(const std::string& modifier,
const bool& debug)
......@@ -117,7 +117,7 @@ namespace datrw {
/*----------------------------------------------------------------------*/
/*! \brief evaluate output stream format modifiers
* \ingroup su
* \ingroup group_su
*/
options::SUHeaderControl outputmodifiers(const std::string& modifier,
const bool& debug)
......
......@@ -50,12 +50,12 @@ namespace datrw {
namespace su {
/*! \brief subformat definitions
* \ingroup su
* \ingroup group_su
*/
namespace subformat {
/*! \brief key for subformat modifiers
* \ingroup su
* \ingroup group_su
*/
namespace key {
......@@ -79,7 +79,7 @@ namespace datrw {
/*----------------------------------------------------------------------*/
/*! \brief default values for subformat modifiers
* \ingroup su
* \ingroup group_su
*/
namespace def {
......@@ -110,13 +110,13 @@ namespace datrw {
/*======================================================================*/
/*! \brief options to be passed between classes definitions
* \ingroup su
* \ingroup group_su
*/
namespace options {
/*! \brief options to control the way spatial sampling header variables
* are handeled.
* \ingroup su
* \ingroup group_su
* \sa datrw::su::ScalCoo, datrw::su::Coordinates
*/
struct SpatialSampling {
......@@ -143,7 +143,7 @@ namespace datrw {
/*! \brief options to control the way temporal sampling header variables
* are handeled.
* \ingroup su
* \ingroup group_su
* \sa datrw::su::SUheader, \ref sec_su_for_TOAST
*/
struct TemporalSampling {
......@@ -162,7 +162,7 @@ namespace datrw {
/*! \brief options to control the way header variables
* are handeled.
* \ingroup su
* \ingroup group_su
* \sa datrw::su::SUheader
*/
struct SUHeaderControl {
......@@ -175,13 +175,13 @@ namespace datrw {
/*----------------------------------------------------------------------*/
/*! \brief evaluate input stream format modifiers
* \ingroup su
* \ingroup group_su
*/
options::SUHeaderControl inputmodifiers(const std::string& mf,
const bool& debug=false);
/*! \brief evaluate output stream format modifiers
* \ingroup su
* \ingroup group_su
*/
options::SUHeaderControl outputmodifiers(const std::string& mf,
const bool& debug=false);
......
......@@ -59,7 +59,7 @@ namespace datrw {
* Seismic Un*x is available from
* http://www.cwp.mines.edu/cwpcodes/
*
* \defgroup su I/O module for Seismic Uni*x data
* \defgroup group_su I/O module for Seismic Uni*x data
*
* \section sec_su_for_TOAST Special format definition within TOAST
*
......@@ -93,12 +93,12 @@ namespace datrw {
/*! \brief All classes and functions to extract data from Seismic Unix files
*
* \ingroup su
* \ingroup group_su
*/
namespace su {
/*!
* \ingroup su
* \ingroup group_su
*/
class SUReadException: public datrw::Exception
{
......@@ -116,7 +116,7 @@ namespace datrw {
/*----------------------------------------------------------------------*/
/*! \brief C++ class to handle Seismic Un*x header struct
* \ingroup su
* \ingroup group_su
*/
class SUheader {
public:
......
......@@ -34,7 +34,7 @@ namespace datrw {
/*! \brief SEG-Y and SU trace header as taken from segy.h coming with
* SeismicUnix
* \ingroup su
* \ingroup group_su
*
* segy - trace identification header
*
......
Supports Markdown
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