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

renamed all README files with doxygen source code in doxygen.txt

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: 5191
SVN UUID:     67feda4a-a26e-11df-9d6e-31afc202ad0c
parent cbd65482
......@@ -133,6 +133,11 @@ LIBSRC+=$(wildcard $(addsuffix *.cc,$(SUBDIRS)))
TESTHEADERS=$(wildcard tests/*.h)
TESTSRC=$(wildcard tests/*.cc)
# whereever we find a README, we will use it
README=$(shell find . -name README)
# the frame of doxygen documentation is palced in text files
DOXYTXT=$(shell find . -name doxygen\*.txt)
INCINSTALLPATH=$(LOCINCLUDEDIR)/datrwxx
LIBINSTALLPATH=$(LOCLIBDIR)
......@@ -164,7 +169,7 @@ CPPFLAGS+=-I$(LOCINCLUDEDIR) $(FLAGS)
MAINSRC=$(addsuffix .cc,libdatrwxxinfo)
EDITFILES=$(MAINSRC) Makefile README $(wildcard *.cfg contrib/*.h) COPYING
EDITFILES=$(MAINSRC) Makefile $(README) $(wildcard *.cfg contrib/*.h) COPYING $(DOXYTXT)
EDITALL=$(EDITFILES) $(LIBHEADERS) $(LIBSRC) $(TESTSRC) $(EDITFILES)
EDITFORMATHEADERS=$(filter $(patsubst %/,%.h,$(SUBDIRS)),$(LIBHEADERS))
EDITROOT=$(filter-out $(EDITFORMATHEADERS),$(wildcard *.cc *.h))
......@@ -298,7 +303,7 @@ DOXYWWWPATH=$(TF_WWWBASEDIR)/libdatrwxx
doxyclean: ;/bin/rm -rfv $(DOXYWWWPATH) doxydoc.xxx
DOXYSRC=$(LIBSRC) $(LIBHEADERS) README $(TESTSRC) $(MAINSRC)
DOXYSRC=$(LIBSRC) $(LIBHEADERS) $(DOXYTXT) $(TESTSRC) $(MAINSRC)
PWD=$(shell env pwd)
# create doxygen intermediate configuration
......
......@@ -89,8 +89,7 @@ WARN_LOGFILE =
#---------------------------------------------------------------------------
INPUT = ./
INPUT_ENCODING = UTF-8
FILE_PATTERNS = README \
README.changelog \
FILE_PATTERNS = doxygen*.txt \
*.h \
*.cc
RECURSIVE = YES
......
/*! \file libdatrwxx/README
/*! \file libdatrwxx/doxygen.txt
* \brief DATRW++ library: reading seismic data (libdatrwxx)
*
* ----------------------------------------------------------------------------
......@@ -34,7 +34,7 @@
* - 20/10/2010 V1.1 added a description of library behaviour.
* - 22/11/2010 V2.0 call it version 2.0 after joining libdatwritexx
* - 07/09/2011 V2.1 added notes regarding format modifiers
*
* - 18/07/2013 V2.2 renamed file
* ============================================================================
*/
......@@ -921,4 +921,4 @@ They will only be implemented upon a users request.
*/
// ----- END OF README -----
// ----- END OF doxygen.txt ----
......@@ -60,7 +60,11 @@ HEADERS=$(wildcard *.h)
CCSRC=$(wildcard *.cc)
FSRC=$(wildcard *.f)
LIBSRC=$(CCSRC) $(filter fapid_%,$(FSRC))
README=README
# whereever we find a README, we will use it
README=$(shell find . -name README)
# the frame of doxygen documentation is palced in text files
DOXYTXT=$(shell find . -name doxygen\*.txt)
FLAGS += $(MYFLAGS) -fPIC
FFLAGS += -ff2c -Wall -ffixed-line-length-0 -fno-backslash $(FLAGS)
......@@ -71,7 +75,7 @@ CPPFLAGS+=-I$(LOCINCLUDEDIR) $(FLAGS)
#----------------------------------------------------------------------
flist: Makefile $(HEADERS) $(README) $(LIBSRC) doxydoc.cfg $(FSRC)
flist: Makefile $(HEADERS) $(README) $(LIBSRC) doxydoc.cfg $(FSRC) $(DOXYDOC)
echo $^ | tr ' ' '\n' | sort | uniq > $@
.PHONY: edit
......@@ -197,7 +201,7 @@ DOXYWWWPATH=$(TF_WWWBASEDIR)/libfapidxx
doxyclean: ;/bin/rm -rfv $(DOXYWWWPATH) doxydoc.xxx
DOXYSRC=$(README) $(HEADERS) $(LIBSRC)
DOXYSRC=$(DOXYTXT) $(HEADERS) $(LIBSRC)
# create doxygen intermediate configuration
PWD=$(shell env pwd)
......
......@@ -91,7 +91,7 @@ INPUT =
INPUT_ENCODING = UTF-8
FILE_PATTERNS = *.cc *.f \
*.h \
README
doxygen*.txt
RECURSIVE = YES
EXCLUDE =
EXCLUDE_SYMLINKS = NO
......
/*! \file README
/*! \file libfapidxx/doxygen.txt
* \brief documentation for fapi (prototypes)
*
* ----------------------------------------------------------------------------
......@@ -29,7 +29,7 @@
*
* REVISIONS and CHANGES
* - 17/11/2010 V1.0 Thomas Forbriger
*
* - 18/07/2013 V1.1 tmetz (renamed file)
* ============================================================================
*/
......@@ -199,4 +199,4 @@ P> fprog
* \sa sff_PrepWid2(), sff_prepwid2__(), fapidxx::WID2container
*/
/* ----- END OF README ----- */
/* ----- END OF doxygen.txt ----- */
......@@ -105,7 +105,8 @@ $(LOCLIBDIR)/%: install-include %
#----------------------------------------------------------------------
flist: Makefile $(wildcard *.f *.inc *.h *.cc *.c README *.cfg) COPYING
flist: Makefile $(wildcard *.f *.inc *.h *.cc *.c README *.cfg) COPYING \
$(DOXYTXT)
echo $^ | tr ' ' '\n' | sort > $@
.PHONY: edit
......@@ -218,6 +219,8 @@ SRC=fcommand.cc filters.cc polesnzeroes.cc fftwaff.cc error.cc fftwaffar.cc
TESTS=$(wildcard tests/*.cc)
# whereever we find a README, we will use it
README=$(shell find . -name README)
# the frame of doxygen documentation is palced in text files
DOXYTXT=$(shell find . -name doxygen\*.txt)
# place where we will copy header files
INCINSTALLPATH=$(LOCINCLUDEDIR)/fourier
......@@ -363,7 +366,7 @@ DOXYWWWPATH=$(TF_WWWBASEDIR)/libfourier
doxyclean: ;/bin/rm -rfv $(DOXYWWWPATH) doxydoc.xxx
DOXYSRC=$(README) $(HEADERS) $(SRC)
DOXYSRC=$(DOXYTXT) $(HEADERS) $(SRC)
# create doxygen intermediate configuration
PWD=$(shell env pwd)
......
......@@ -89,8 +89,7 @@ WARN_LOGFILE =
#---------------------------------------------------------------------------
INPUT = ./
INPUT_ENCODING = UTF-8
FILE_PATTERNS = README \
README.changelog \
FILE_PATTERNS = doxygen*.txt \
*.h *.f \
*.cc
RECURSIVE = YES
......
/*! \file libfourier/README
/*! \file libfourier/doxygen.txt
* \brief C++ library to operate on Fourier transforms (libfourierxx)
*
* ----------------------------------------------------------------------------
......@@ -27,7 +27,7 @@
*
* REVISIONS and CHANGES
* - 02/10/2007 V1.0 Thomas Forbriger (started README)
*
* - 18/07/2013 V1.1 tmetz (renamed file)
* ============================================================================
*/
......@@ -131,4 +131,4 @@ Further stuff will be collected in this library in the future.
*
*/
// ----- END OF README -----
// ----- END OF doxygen.txt -----
......@@ -89,6 +89,15 @@ CHECKVARS=$(foreach var,$(1),$(call CHECKVAR,$(var)))
$(call CHECKVARS,LOCINCLUDEDIR LOCLIBDIR LOCBINDIR)
$(call CHECKVARS,TF_BROWSER TF_WWWBASEDIR)
#----------------------------------------------------------------------
# whereever we find a README, we will use it
README=$(shell find . -name README)
# the frame of doxygen documentation is palced in text files
DOXYTXT=$(shell find . -name doxygen\*.txt)
#----------------------------------------------------------------------
FLAGS=
......@@ -97,7 +106,7 @@ CXXFLAGS+=-Wall $(FLAGS)
LDFLAGS+=-L$(LOCLIBDIR)
CPPFLAGS+=-I$(LOCINCLUDEDIR) $(FLAGS)
flist: Makefile README $(wildcard *.h *.cc *.cfg) $(TF_EDIT)
flist: Makefile $(README) $(wildcard *.h *.cc *.cfg) $(TF_EDIT) $(DOXYTXT)
echo $^ | tr ' ' '\n' | sort > $@
.PHONY: edit
......@@ -173,7 +182,7 @@ DOXYWWWPATH=$(TF_WWWBASEDIR)/libgsexx
doxyclean: ;/bin/rm -rfv $(DOXYWWWPATH) doxydoc.xxx
DOXYSRC=README $(LIBSRC) $(INCSRC) gsexx_tests.cc gsexx_write_example.cc
DOXYSRC=$(DOXYTXT) $(LIBSRC) $(INCSRC) gsexx_tests.cc gsexx_write_example.cc
# create doxygen intermediate configuration
PWD=$(shell env pwd)
......
......@@ -89,8 +89,7 @@ WARN_LOGFILE =
#---------------------------------------------------------------------------
INPUT = ./
INPUT_ENCODING = UTF-8
FILE_PATTERNS = README \
README.changelog \
FILE_PATTERNS = doxygen*.txt \
*.h \
*.cc
RECURSIVE = YES
......
/*! \file README
/*! \file libgsexx/doxygen.txt
\brief GSE++ library (documentation)
----------------------------------------------------------------------------
......@@ -19,7 +19,7 @@ In this file you will find general information in Doxygen format.
REVISIONS and CHANGES
- 16/03/2002 V1.0 Thomas Forbriger
- 18/07/2013 V1.1 tmetz (renamed file)
============================================================================
*/
......@@ -231,4 +231,4 @@ Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
\todo
Integer overflow could be checked in the class that applies differences.
*/
/* ----- END OF README ----- */
/* ----- END OF doxygen.txt ----- */
......@@ -64,6 +64,11 @@ LIBSRC=$(wildcard *.cc)
TESTSRC=$(wildcard tests/*.cc)
# whereever we find a README, we will use it
README=$(shell find . -name README)
# the frame of doxygen documentation is palced in text files
DOXYTXT=$(shell find . -name doxygen\*.txt)
INCINSTALLPATH=$(LOCINCLUDEDIR)/serialxx
# name of headers with comments stripped off
......@@ -92,7 +97,7 @@ CXXFLAGS=-Wall $(FLAGS)
LDFLAGS=-L$(LOCLIBDIR)
CPPFLAGS=-I$(LOCINCLUDEDIR) $(FLAGS)
flist: Makefile $(wildcard *.cfg) $(HEADERS) $(LIBSRC) README $(TESTSRC)
flist: Makefile $(wildcard *.cfg) $(HEADERS) $(LIBSRC)$(READM)E $(TESTSRC) $(DOXYTXT)
echo $^ | tr ' ' '\n' | sort > $@
.PHONY: edit
......@@ -196,7 +201,7 @@ DOXYWWWPATH=$(TF_WWWBASEDIR)/libserialxx
doxyclean: ;/bin/rm -rfv $(DOXYWWWPATH) doxydoc.xxx
DOXYSRC=$(LIBSRC) $(HEADERS) README
DOXYSRC=$(LIBSRC) $(HEADERS) $(DOXYTXT)
# create doxygen intermediate configuration
PWD=$(shell env pwd)
......
......@@ -89,8 +89,7 @@ WARN_LOGFILE =
#---------------------------------------------------------------------------
INPUT = ./
INPUT_ENCODING = UTF-8
FILE_PATTERNS = README \
README.changelog \
FILE_PATTERNS = doxygen*.txt \
*.h \
*.cc
RECURSIVE = YES
......
/*! \file libserialxx/README
/*! \file libserialxx/doxygen.txt
* \brief SERIAL++ library: simple access to serial ports
*
* ----------------------------------------------------------------------------
......@@ -15,7 +15,7 @@
*
* REVISIONS and CHANGES
* - 06/12/2002 V1.0 Thomas Forbriger (copied from libdatreadxx)
*
* - 18/07/2013 V1.1 tmetz (renamed file)
* ============================================================================
*/
......@@ -52,4 +52,4 @@ $Id$
*/
// ----- END OF README -----
// ----- END OF doxygen.txt -----
......@@ -100,13 +100,19 @@ CHECKVARS=$(foreach var,$(1),$(call CHECKVAR,$(var)))
$(call CHECKVARS,LOCINCLUDEDIR LOCLIBDIR LOCBINDIR)
$(call CHECKVARS,TF_BROWSER TF_WWWBASEDIR)
# whereever we find a README, we will use it
README=$(shell find . -name README)
# the frame of doxygen documentation is palced in text files
DOXYTXT=$(shell find . -name doxygen\*.txt)
FLAGS=
FLAGS+=-fPIC $(MYFLAGS)
CXXFLAGS+=-Wall $(FLAGS)
LDFLAGS+=-L$(LOCLIBDIR)
CPPFLAGS+=-I$(LOCINCLUDEDIR) $(FLAGS)
flist: Makefile README $(wildcard *.h *.cc *.cfg) $(TF_EDIT)
flist: Makefile $(READM)E $(wildcard *.h *.cc *.cfg) $(TF_EDIT) $(DOXYTXT)
echo $^ | tr ' ' '\n' | sort > $@
.PHONY: edit
......@@ -199,7 +205,7 @@ DOXYWWWPATH=$(TF_WWWBASEDIR)/libsffxx
doxyclean: ;/bin/rm -rfv $(DOXYWWWPATH) doxydoc.xxx
DOXYSRC=README $(LIBSRC) $(INCSRC) sfftest.cc
DOXYSRC=$(DOXYTXT) $(LIBSRC) $(INCSRC) sfftest.cc
# create doxygen intermediate configuration
PWD=$(shell env pwd)
......
......@@ -89,8 +89,7 @@ WARN_LOGFILE =
#---------------------------------------------------------------------------
INPUT = ./
INPUT_ENCODING = UTF-8
FILE_PATTERNS = README \
README.changelog \
FILE_PATTERNS = doxygen*.txt \
*.h \
*.cc
RECURSIVE = YES
......
/*! \file README
/*! \file libsfxx/doxygen.txt
* \brief documentation for libsffxx.a
*
* ----------------------------------------------------------------------------
......@@ -29,10 +29,10 @@
*
* REVISIONS and CHANGES
* - 25/12/2003 V1.0 Thomas Forbriger
*
* - 18/07/2013 V1.1 tmetz (renamed file)
* ============================================================================
*/
doxygen*.txt \
/*! \mainpage
The library is designed to provide a tool for SFF (Stuttgart File Format)
......@@ -89,7 +89,7 @@ You will need an updated version (2.00 or higher) of \c libstuff or \c libsff
\subsection libgsexx
You must link against libgsexx.a
doxygen*.txt \
The GSE2 layer of the library relies on the code provided by libgsexx.
The header sffxx.h includes gsexx.h
......@@ -362,7 +362,7 @@ The SFF was invented in 1996.
be kept at a single place in the computer system.
The general structure of the file format is a header block
followed by one or more data blocks. Within the header and
followed by doxygen*.txt \one or more data blocks. Within the header and
the data blocks optional blocks containing additional
information are allowed. Each data block is structured as
described by the GSE2.0 format. The data are compressed
......@@ -708,4 +708,4 @@ The SFF was invented in 1996.
*/
/* ----- END OF README ----- */
/* ----- END OF doxygen.txt ----- */
......@@ -80,6 +80,12 @@ INSTHEADER=$(addprefix $(INCINSTALLPATH)/,$(notdir $(LIBHEADERS)))
EMPTYPRINT=1
#EMPTYPRINT=0
# whereever we find a README, we will use it
README=$(shell find . -name README)
# the frame of doxygen documentation is palced in text files
DOXYTXT=$(shell find . -name doxygen\*.txt)
# define this to be cat in case you do not have remcmmnt available
ifndef TF_REMCMMNT
TF_REMCMMNT=cat
......@@ -96,7 +102,8 @@ CXXFLAGS+=-Wall $(FLAGS)
LDFLAGS+=-L$(LOCLIBDIR)
CPPFLAGS+=-I$(LOCINCLUDEDIR) $(FLAGS)
EDITFILES=Makefile README \
EDITFILES=Makefile $(README) \
$(DOXYTXT) \
$(wildcard *.cfg *.h *.cc *.c tests/*.cc tests/*.c tests/*.inp) \
test_libstfinv/README \
$(wildcard test*/src/*.c) \
......@@ -222,7 +229,7 @@ onlinehelp.xxx: onlinehelp
echo '\endverbatim' >> $@
echo '*/' >> $@
DOXYSRC=$(LIBCCSRC) $(LIBCSRC) $(LIBHEADERS) README $(TESTCCSRC) $(TESTCSRC) \
DOXYSRC=$(DOXYTXT) $(LIBCCSRC) $(LIBCSRC) $(LIBHEADERS) $(TESTCCSRC) $(TESTCSRC) \
onlinehelp.xxx Makefile
PWD=$(shell env pwd)
......
......@@ -89,7 +89,7 @@ WARN_LOGFILE =
#---------------------------------------------------------------------------
INPUT = ./
INPUT_ENCODING = UTF-8
FILE_PATTERNS = README onlinehelp.xxx \
FILE_PATTERNS = doxygen*.txt onlinehelp.xxx \
*.h \
*.cc
RECURSIVE = YES
......
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