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

"A note to header files" moved/added to Readme files

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: 5219
SVN UUID:     67feda4a-a26e-11df-9d6e-31afc202ad0c
parent 3ef61e94
......@@ -24,19 +24,6 @@
# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
# ----
#
# A note on header files:
# We extensively comment class declarations within the header files. The
# reduce compilation time when using the library code, comments will be
# stripped from the header files that are exportet. These stripped versions
# are placed in the source code path with name *.h.strip and will be linked to
# INCINSTALLPATH with name *.h.
#
# Although comment stripping could be done by perl with an elaborate regular
# expression, we prefer the remcmmnt command by Jari Laaksonen. You can find
# the code at
# http://www.eti.pg.gda.pl/KATEDRY/kecs/lab-cpp/snippets/
# If it is not available to you, you should set TF_REMCMMNT=cat (see below)
#
# Please have a look at the README file coming along with the source code in
# this directory for further notes regarding provided functionality,
# prerequisites and installation.
......
......@@ -30,6 +30,20 @@ Installation
You will find the installed library header files in $(LOCINCLUDEDIR)/aff
A note on header files:
----------------------
We extensively comment class declarations within the header files. The
reduce compilation time when using the library code, comments will be
stripped from the header files that are exportet. These stripped versions
are placed in the source code path with name *.h.strip and will be linked to
INCINSTALLPATH with name *.h.
Although comment stripping could be done by perl with an elaborate regular
expression, we prefer the remcmmnt command by Jari Laaksonen. You can find
the code at
http://www.eti.pg.gda.pl/KATEDRY/kecs/lab-cpp/snippets/
If it is not available to you, you should set TF_REMCMMNT=cat in the Makefile.
Detailed documentation is provided through doxygen source code. See target
doxydoc in the Makefile.
......
......@@ -39,7 +39,19 @@ doxygen is required to produce the source code documentation
For test code and examples libtfxx is required in addition.
----
A note on header files:
----------------------
We extensively comment class declarations within the header files. The
reduce compilation time when using the library code, comments will be
stripped from the header files that are exportet. These stripped versions
are placed in the source code path with name *.h.strip and will be linked to
INCINSTALLPATH with name *.h.
Although comment stripping could be done by perl with an elaborate regular
expression, we prefer the remcmmnt command by Jari Laaksonen. You can find
the code at
http://www.eti.pg.gda.pl/KATEDRY/kecs/lab-cpp/snippets/
If it is not available to you, you should set TF_REMCMMNT=cat in the Makefile.
Detailed documentation is provided through doxygen source code. See target
......
......@@ -141,21 +141,6 @@ libfourier.a: $(LIBOBS)
$(AR) rcv $@ $^
$(RANLIB) $@
# ============================================================================
#
# A note on header files:
# We extensively comment class declarations within the header files. The
# reduce compilation time when using the library code, comments will be
# stripped from the header files that are exportet. These stripped versions
# are placed in the source code path with name *.h.strip and will be linked to
# INCINSTALLPATH with name *.h.
#
# Although comment stripping could be done by perl with an elaborate regular
# expression, we prefer the remcmmnt command by Jari Laaksonen. You can find
# the code at
# http://www.eti.pg.gda.pl/KATEDRY/kecs/lab-cpp/snippets/
# If it is not available to you, you should set TF_REMCMMNT=cat (see below)
#
# ============================================================================
# files
# -----
......
......@@ -37,6 +37,19 @@ Installation
make all installs headers, binary libraries and documentation
A note on header files:
----------------------
We extensively comment class declarations within the header files. The
reduce compilation time when using the library code, comments will be
stripped from the header files that are exportet. These stripped versions
are placed in the source code path with name *.h.strip and will be linked to
INCINSTALLPATH with name *.h.
Although comment stripping could be done by perl with an elaborate regular
expression, we prefer the remcmmnt command by Jari Laaksonen. You can find
the code at
http://www.eti.pg.gda.pl/KATEDRY/kecs/lab-cpp/snippets/
If it is not available to you, you should set TF_REMCMMNT=cat in the Makefile.
Detailed documentation is provided through libfourier.doc (fortran code)
......
......@@ -9,6 +9,21 @@ This library provides a C++ interface to LAPACK. It uses libaff arrays to
store matrix data. The library builds a framework to be extended in the
future with further interface functions to LAPACK.
A note on header files:
----------------------
We extensively comment class declarations within the header files. The
reduce compilation time when using the library code, comments will be
stripped from the header files that are exportet. These stripped versions
are placed in the source code path with name *.h.strip and will be linked to
INCINSTALLPATH with name *.h.
Although comment stripping could be done by perl with an elaborate regular
expression, we prefer the remcmmnt command by Jari Laaksonen. You can find
the code at
http://www.eti.pg.gda.pl/KATEDRY/kecs/lab-cpp/snippets/
If it is not available to you, you should set TF_REMCMMNT=cat in the Makefile.
Detailed documentation is provided through doxygen source code. See target
doxydoc in the Makefile.
......
......@@ -8,6 +8,20 @@ $Id$
This provides a C++ interface to the FORTRAN PGPLOT library. It is based on
the C-interface (cpgplot.h) coming with the library.
A note on header files:
----------------------
We extensively comment class declarations within the header files. The
reduce compilation time when using the library code, comments will be
stripped from the header files that are exportet. These stripped versions
are placed in the source code path with name *.h.strip and will be linked to
INCINSTALLPATH with name *.h.
Although comment stripping could be done by perl with an elaborate regular
expression, we prefer the remcmmnt command by Jari Laaksonen. You can find
the code at
http://www.eti.pg.gda.pl/KATEDRY/kecs/lab-cpp/snippets/
If it is not available to you, you should set TF_REMCMMNT=cat in the Makefile.
Detailed documentation is provided through doxygen source code. See target
doxydoc in the Makefile.
......
......@@ -23,6 +23,20 @@ rheological models.
make all installs headers, binary libraries and documentation
A note on header files:
----------------------
We extensively comment class declarations within the header files. The
reduce compilation time when using the library code, comments will be
stripped from the header files that are exportet. These stripped versions
are placed in the source code path with name *.h.strip and will be linked to
INCINSTALLPATH with name *.h.
Although comment stripping could be done by perl with an elaborate regular
expression, we prefer the remcmmnt command by Jari Laaksonen. You can find
the code at
http://www.eti.pg.gda.pl/KATEDRY/kecs/lab-cpp/snippets/
If it is not available to you, you should set TF_REMCMMNT=cat in the Makefile.
Detailed documentation is provided through libfourier.doc (fortran code)
and doxygen source code. See target doxydoc in the Makefile.
......
......@@ -14,6 +14,21 @@ The main interface is the SerialPort class.
It supports opening of a serial port, port parameter configuration, and
reading and writing from and to the port.
A note on header files:
----------------------
We extensively comment class declarations within the header files. The
reduce compilation time when using the library code, comments will be
stripped from the header files that are exportet. These stripped versions
are placed in the source code path with name *.h.strip and will be linked to
INCINSTALLPATH with name *.h.
Although comment stripping could be done by perl with an elaborate regular
expression, we prefer the remcmmnt command by Jari Laaksonen. You can find
the code at
http://www.eti.pg.gda.pl/KATEDRY/kecs/lab-cpp/snippets/
If it is not available to you, you should set TF_REMCMMNT=cat in the Makefile.
Detailed documentation is provided through doxygen source code. See target
doxydoc in the Makefile.
......
......@@ -16,6 +16,21 @@ The synthetic waveforms are convolved with this filter
wavelet and the convolved
synthetics as well as the wavelet itself are returned to the user.
A note on header files:
----------------------
We extensively comment class declarations within the header files. The
reduce compilation time when using the library code, comments will be
stripped from the header files that are exportet. These stripped versions
are placed in the source code path with name *.h.strip and will be linked to
INCINSTALLPATH with name *.h.
Although comment stripping could be done by perl with an elaborate regular
expression, we prefer the remcmmnt command by Jari Laaksonen. You can find
the code at
http://www.eti.pg.gda.pl/KATEDRY/kecs/lab-cpp/snippets/
If it is not available to you, you should set TF_REMCMMNT=cat in the Makefile.
Detailed documentation is provided through doxygen source code. See target
doxydoc in the Makefile.
......
......@@ -25,19 +25,6 @@
# TF++, Miscellaneous classes and modules in C++
# ==============================================
#
# A note on header files:
# We extensively comment class declarations within the header files. The
# reduce compilation time when using the library code, comments will be
# stripped from the header files that are exportet. These stripped versions
# are placed in the source code path with name *.h.strip and will be linked to
# INCINSTALLPATH with name *.h.
#
# Although comment stripping could be done by perl with an elaborate regular
# expression, we prefer the remcmmnt command by Jari Laaksonen. You can find
# the code at
# http://www.eti.pg.gda.pl/KATEDRY/kecs/lab-cpp/snippets/
# If it is not available to you, you should set TF_REMCMMNT=cat (see below)
#
# Please have a look at the README file coming along with the source code in
# this directory for further notes regarding provided functionality,
# prerequisites and installation.
......
......@@ -48,6 +48,21 @@ Tests and examples are provided in subdirectory tests
The source code itself depends only on common system libraries and the STL.
A note on header files:
----------------------
We extensively comment class declarations within the header files. The
reduce compilation time when using the library code, comments will be
stripped from the header files that are exportet. These stripped versions
are placed in the source code path with name *.h.strip and will be linked to
INCINSTALLPATH with name *.h.
Although comment stripping could be done by perl with an elaborate regular
expression, we prefer the remcmmnt command by Jari Laaksonen. You can find
the code at
http://www.eti.pg.gda.pl/KATEDRY/kecs/lab-cpp/snippets/
If it is not available to you, you should set TF_REMCMMNT=cat in the Makefile.
Detailed documentation is provided through doxygen source code. See target
doxydoc in the Makefile.
......
......@@ -23,8 +23,6 @@
# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
# ----
#
# This is a base library. It depends only on common system libraries.
#
# Please have a look at the README file coming along with the source code in
# this directory for further notes regarding provided functionality,
# prerequisites and installation.
......
......@@ -53,6 +53,7 @@ be written to subdirectories of ${TF_WWWBASEDIR}..
Prerequisites
-------------
This is a base library. It depends only on common system libraries.
To compile the code, current versions of a C, a C++, and a Fortran compiler
are required as well as GNU make and doxygen (for documentation files).
......
......@@ -31,6 +31,20 @@ make all installs headers, binary libraries and documentation
Other libraries that are required to compile libtsxx:
libaff, libtfxx, libgsexx, libtime, libdatrwxx, libsffxx, libcseife
A note on header files:
----------------------
We extensively comment class declarations within the header files. The
reduce compilation time when using the library code, comments will be
stripped from the header files that are exportet. These stripped versions
are placed in the source code path with name *.h.strip and will be linked to
INCINSTALLPATH with name *.h.
Although comment stripping could be done by perl with an elaborate regular
expression, we prefer the remcmmnt command by Jari Laaksonen. You can find
the code at
http://www.eti.pg.gda.pl/KATEDRY/kecs/lab-cpp/snippets/
If it is not available to you, you should set TF_REMCMMNT=cat in the Makefile.
Detailed documentation is provided through doxygen source code. See target
doxydoc in the Makefile.
......
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