Commit 4b56e6a1 authored by thomas.forbriger's avatar thomas.forbriger
Browse files

[WP][DOC] (ticket10tsio): provide stocktaking in the documentation

This is a legacy commit from before 2015-03-01.
It may be incomplete as well as inconsistent.
See COPYING.legacy and README.history for details.

just started to find out, what is waiting here...
parent 615b5c6c
......@@ -53,9 +53,15 @@ CXXFLAGS+=$(FLAGS)
LDFLAGS+=-L$(LOCLIBDIR) $(TF_LINK_REGEXX)
CPPFLAGS+=-I$(LOCINCLUDEDIR) $(FLAGS) $(REGEXXFLAG)
flist: Makefile doxydoc.cfg COPYING README $(DOXYTXT) \
$(HEADERS) $(SRC) $(TF_EDIT)
echo $^ | tr ' ' '\n' | sort > $@
CODEFILES=$(HEADERS) $(SRC)
OTHERFILES=Makefile doxydoc.cfg COPYING README $(DOXYTXT)
flist: $(CODEFILES) $(OTHERFILES) $(TF_EDIT)
echo $(OTHERFILES) | tr ' ' '\n' | sort > $@
echo '----' >> $@
echo $(CODEFILES) | tr ' ' '\n' | sort >> $@
echo '----' >> $@
echo $(filter-out $(CODEFILES) $(OTHERFILES),$^) \
| tr ' ' '\n' | sort >> $@
.PHONY: edit
edit: flist; vim $<
......
......@@ -30,11 +30,13 @@
* REVISIONS and CHANGES
* - 18/07/2005 V1.0 Thomas Forbriger
* - 31/10/2007 V1.1 support trace index
* - 29/01/2014 (thof) move file from tsxx to tsioxx;
* adjust namespaces and documentation
*
* ============================================================================
*/
#define TSIOXX_SFFHEADERS_CC_VERSION \
"TSIOXX_SFFHEADERS_CC V1.1"
"TSIOXX_SFFHEADERS_CC 2014-01-29"
#define TSIOXX_SFFHEADERS_CC_CVSID \
"$Id$"
......
/*! \file sffheaders.h
* \brief provide full sffheaders (prototypes)
* \ingroup group_sffts
*
* ----------------------------------------------------------------------------
*
......@@ -25,6 +26,7 @@
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*
* ----
*
* REVISIONS and CHANGES
......@@ -32,6 +34,8 @@
* - 29/06/2006 V1.1 added constructors
* - 31/10/2007 V1.2 support trace index
* - 13/11/2012 V1.3 support libdatrwxx output functions
* - 29/01/2014 (thof) move file from tsxx to tsioxx;
* adjust namespaces and documentation
*
* ============================================================================
*/
......@@ -40,7 +44,7 @@
#ifndef TSIOXX_SFFHEADERS_H_VERSION
#define TSIOXX_SFFHEADERS_H_VERSION \
"TSIOXX_SFFHEADERS_H V1.3"
"TSIOXX_SFFHEADERS_H 2014-01-29"
#define TSIOXX_SFFHEADERS_H_CVSID \
"$Id$"
......@@ -52,13 +56,38 @@
#include<sffostream.h>
#include<vector>
/*! \brief SFF Timeseries I/O.
*
* \defgroup group_sffts SFF Timeseries I/O
*
* Input and output
*/
/*! \brief Interface to libdatrwxx
*
* \defgroup subgroup_datrwxx Interface to libdatrwxx
* \ingroup group_sffts
*
* Input and output
*/
/*! \brief Interface to libsffxx
*
* \defgroup subgroup_sffxx Interface to libsffxx
* \ingroup group_sffts
*
* Input and output
*/
namespace tsio {
/*! \brief some really SFF specific compounds and functions
*/
namespace sff {
//! hold information for a complete SFF file header
/*! hold information for a complete SFF file header
* \ingroup group_sffts
*/
class FileHeader {
public:
FileHeader(): Mhasfree(false), Mhassrce(false) { }
......@@ -79,7 +108,9 @@ namespace tsio {
/*----------------------------------------------------------------------*/
//! hold information for a complete SFF trace header
/*! hold information for a complete SFF trace header
* \ingroup group_sffts
*/
class TraceHeader {
public:
TraceHeader(): Mhasfree(false), Mhasinfo(false) { }
......@@ -103,7 +134,9 @@ namespace tsio {
/*----------------------------------------------------------------------*/
//! hold a full SFF trace and provide conversion
/*! hold a full SFF trace and provide conversion
* \ingroup group_sffts
*/
template<class C>
class SFFTimeSeries:
public ts::TimeSeries<C,ts::sff::TraceHeader> {
......@@ -131,7 +164,9 @@ namespace tsio {
/*----------------------------------------------------------------------*/
//! hold SFF traces with full header information
/*! hold SFF traces with full header information
* \ingroup group_sffts
*/
template<class C>
class TraceVector: public std::vector<SFFTimeSeries<C> > {
public:
......@@ -141,7 +176,9 @@ namespace tsio {
/*----------------------------------------------------------------------*/
//! hold all information contained in an SFF data file
/*! hold all information contained in an SFF data file
* \ingroup group_sffts
*/
template<class C>
struct File: public TraceVector<C> {
public:
......@@ -172,6 +209,10 @@ namespace tsio {
/*======================================================================*/
// libdatrwxx output operators
/*! \addtogroup group_sffts
* @{
*/
inline
datrw::odatstream& operator<<(datrw::odatstream& os,
......@@ -262,7 +303,15 @@ namespace tsio {
return os;
}
/*!
* @}
*/
/*----------------------------------------------------------------------*/
/*! \addtogroup subgroup_sffxx
* @{
*/
/*! \note
* The compiler cannot distinguish between this definition and the
......@@ -306,6 +355,10 @@ namespace tsio {
const File<C>& f)
{ return(os << f.fileheader << TraceVector<C>(f)); }
/*!
* @}
*/
/*======================================================================*/
// member functions
......
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