Commit f9b3c7d5 authored by thomas.forbriger's avatar thomas.forbriger
Browse files

[WP][DOC] (libstfinv): move usage text files

Not only for doxygen it is helpful to keep usage text files in a separate
directory.
parent 2cbe048f
......@@ -62,7 +62,7 @@ SOURCEFILES=$(filter-out %usage.h, $(filter-out %usage.cc, \
# LaTeX formatted documentation
DOCFILES=$(wildcard doc/*.tex doc/Makefile)
# end-user usage information
USAGEFILES=$(wildcard *usage.txt)
USAGEFILES=$(wildcard usage/*usage.txt)
# editional files to be edited
EDITFILES=Makefile $(README) \
$(DOXYTXT) $(DOCFILES) $(USAGEFILES) \
......@@ -84,10 +84,10 @@ $(call CHECKVARS,TF_BROWSER TF_WWWBASEDIR)
# ======================================================================
#
LIBHEADERS=$(filter-out none,$(wildcard *.h)) \
$(patsubst %.txt,%.h,$(USAGEFILES))
$(patsubst usage/%.txt,%.h,$(USAGEFILES))
LIBCCSRC=$(filter-out none,$(wildcard *.cc)) \
$(patsubst %.txt,%.cc,$(USAGEFILES))
$(patsubst usage/%.txt,%.cc,$(USAGEFILES))
LIBCSRC=$(filter-out none,$(wildcard *.c))
......@@ -211,21 +211,22 @@ reinstall:
# Such text files use names with the pattern *usage.txt
# Automatically generated source code is excluded from editing and versioning
#
OBJ=$(patsubst %.cc,%.o,$(SRC) $(patsubst %.txt,%.cc,$(USAGEFILES)))
%usage.cc %usage.h: %usage.txt
%usage.cc %usage.h: usage/%usage.txt
echo "// DO NOT EDIT: this file is automatically derived from $<" \
> $(patsubst %.txt,%.h,$<)
echo "extern char $(patsubst %.txt,%,$<)[];" >> $(patsubst %.txt,%.h,$<)
> $(patsubst usage/%.txt,%.h,$<)
echo "extern char $(patsubst usage/%.txt,%,$<)[];" \
>> $(patsubst usage/%.txt,%.h,$<)
echo "// DO NOT EDIT: this file is automatically derived from $<" \
> $(patsubst %.txt,%.cc,$<)
echo "#include \"$(patsubst %.txt,%.h,$<)\"" >> $(patsubst %.txt,%.cc,$<)
echo "char $(patsubst %.txt,%,$<)[]=" >> $(patsubst %.txt,%.cc,$<)
echo "{" >> $(patsubst %.txt,%.cc,$<)
> $(patsubst usage/%.txt,%.cc,$<)
echo "#include \"$(patsubst usage/%.txt,%.h,$<)\"" \
>> $(patsubst usage/%.txt,%.cc,$<)
echo "char $(patsubst usage/%.txt,%,$<)[]=" \
>> $(patsubst usage/%.txt,%.cc,$<)
echo "{" >> $(patsubst usage/%.txt,%.cc,$<)
cat $< | egrep -v '^#' | sed -e 's/\\/\\\\/g' | sed -e 's/"/\\"/g' \
| sed -e 's/$$/\\n"/' | sed -e 's/^/ "/'\
>> $(patsubst %.txt,%.cc,$<)
echo "};" >> $(patsubst %.txt,%.cc,$<)
include $(patsubst %.txt,%.d,$(USAGEFILES))
>> $(patsubst usage/%.txt,%.cc,$<)
echo "};" >> $(patsubst usage/%.txt,%.cc,$<)
#======================================================================
# documentation part
......
......@@ -97,7 +97,7 @@ EXCLUDE = .svn test_libstfinv
EXCLUDE_SYMLINKS = NO
EXCLUDE_PATTERNS =
EXCLUDE_SYMBOLS =
EXAMPLE_PATH = tests
EXAMPLE_PATH = tests usage
EXAMPLE_PATTERNS =
EXAMPLE_RECURSIVE = NO
IMAGE_PATH =
......
......@@ -106,6 +106,11 @@
weights and use a power of two to speed up the FFT:
\verbatim fdlsq:pow2:exp=1.4 \endverbatim
\section page_eu_sec_texts End-user usage information
\subsection page_eu_subsec_texts_base Detailed description in base class
\verbinclude ./stfinv_description_usage.txt
\verbinclude ./stfinvbase_description_usage.txt
*/
/* ----- END OF doxygen_end_users.txt ----- */
......@@ -179,8 +179,8 @@
implementers.
\par usage text files
Files matching name pattern *usage.txt contain usage documentation
addressing end-users.
Files matching name pattern *usage.txt in subdirectory usage contain usage
documentation addressing end-users.
End-users are not concerned with programming and library API.
They use software, which is linked against libstfinv and apply those
programs to their time series files.
......
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