Commit c6cc22b0 authored by thomas.forbriger's avatar thomas.forbriger Committed by thomas.forbriger
Browse files

new README for doxygen documentation; added GPL phrase

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.


SVN Path:     http://gpitrsvn.gpi.uni-karlsruhe.de/repos/TFSoftware/trunk
SVN Revision: 3793
SVN UUID:     67feda4a-a26e-11df-9d6e-31afc202ad0c
parent 902fbc54
......@@ -105,7 +105,7 @@ CXXFLAGS+=-fPIC -Wall $(FLAGS)
LDFLAGS+=-L$(LOCLIBDIR)
CPPFLAGS+=-I$(LOCINCLUDEDIR) $(FLAGS)
flist: Makefile $(wildcard *.h *.cc *.cfg)
flist: Makefile $(wildcard *.h *.cc *.cfg) README
echo $^ | tr ' ' '\n' | sort > $@
.PHONY: edit
......@@ -207,7 +207,7 @@ DOXYWWWPATH=$(TF_WWWBASEDIR)/libtsxx
doxyclean: ;/bin/rm -rfv $(DOXYWWWPATH)
DOXYSRC=$(LIBSRC) $(HEADERS)
DOXYSRC=$(LIBSRC) $(HEADERS) README
# create doxygen intermediate configuration
PWD=$(shell env pwd)
......
/*! \file README.cc
* \brief C++ time series modules (implementation)
*
* ----------------------------------------------------------------------------
*
* $Id$
* \author Thomas Forbriger
* \date 13/03/2011
*
* C++ time series modules (implementation)
*
* Copyright (c) 2011 by Thomas Forbriger (BFO Schiltach)
*
* ----
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* 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
* - 13/03/2011 V1.0 Thomas Forbriger
*
* ============================================================================
*/
/*! \mainpage
*
* \author Thomas Forbriger
* \date $Date: 2008-12-03 15:05:35 $
* \since 2003
* \version $Id$
*
* This library provides modules for time series analysis.
* In particular this are functions that also need seismic trace header data
* (like the sampling interval) additional to the time series samples
* themselves.
* Provided are recursive filters (i.e. an interface to seife), FIR decimating
* filters, interpolation filters, tapers, containers for time series data
* together with header data, and more.
*/
/* ----- END OF README.cc ----- */
......@@ -10,6 +10,23 @@
* create a random series (implementation)
*
* Copyright (c) 2006 by Thomas Forbriger (BFO Schiltach)
*
* ----
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* 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
* - 27/06/2006 V1.0 Thomas Forbriger
......
......@@ -10,6 +10,23 @@
* create a random series (prototypes)
*
* Copyright (c) 2006 by Thomas Forbriger (BFO Schiltach)
*
* ----
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* 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
* - 27/06/2006 V1.0 Thomas Forbriger
......
......@@ -50,22 +50,6 @@
#include<aff/series.h>
#include<sffostream.h>
/*! \mainpage
*
* \author Thomas Forbriger
* \date $Date: 2008-12-03 15:05:35 $
* \since 2003
* \version $Id$
*
* This library provides modules for time series analysis.
* In particular this are functions that also need seismic trace header data
* (like the sampling interval) additional to the time series samples
* themselves.
* Provided are recursive filters (i.e. an interface to seife), FIR decimating
* filters, interpolation filters, tapers, containers for time series data
* together with header data, and more.
*/
/*! \brief All stuff in this library will be placed within namespace ts
*/
namespace ts {
......
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