[WP][DOC] (libstfinv): add templates for end-user usage information

src/libs/libstfinv/.gitignore

@@ -7,7 +7,8 @@
 #
 # source code documentation
 *.doc
-*usage.txt
+*usage.cc
+*usage.h
 #
 # binary executables of programs in test directory
 tooltest

src/libs/libstfinv/Makefile

@@ -120,13 +120,18 @@ CPPFLAGS+=-I$(LOCINCLUDEDIR) $(FLAGS)
 # ------------------------------------------
 
 flist: $(EDITFILES) $(TF_EDIT)
-	echo $(filter-out $(SOURCEFILES),$(EDITFILES)) \
+	echo $(filter-out $(DOCFILES) $(SOURCEFILES) \
+	  $(USAGEFILES),$(EDITFILES)) \
 	  | tr ' ' '\n' | sort > $@
 	echo '----' >> $@
 	echo $(filter-out test%,$(SOURCEFILES)) | tr ' ' '\n' | sort >> $@
 	echo '----' >> $@
+	echo $(USAGEFILES) | tr ' ' '\n' | sort >> $@
+	echo '----' >> $@
 	echo $(filter test%,$(SOURCEFILES)) | tr ' ' '\n' | sort >> $@
 	echo '----' >> $@
+	echo $(DOCFILES) | tr ' ' '\n' | sort >> $@
+	echo '----' >> $@
 	echo $(TF_EDIT) | tr ' ' '\n' | sort >> $@
 
 .PHONY: edit

src/libs/libstfinv/doxygen_implementers.txt

@@ -190,6 +190,12 @@
   Contents of these files will be processed to C++ source code and will be
   provided through help-functions of the software modules.
 
+  *summary_usage.txt files provide a short summary of the implemented approach
+  and a summary of available parameters.
+
+  *description_usage.txt files provide a detailed description of theory of
+  operation and detailed information regarding control parameters.
+
 \par LaTeX files
   In subdirectory doc a set of LaTeX files is created.
   These files may contain extended end-user documentation including relevant

src/libs/libstfinv/stfinv_description_usage.txt

+# source code text file
+# this is <stfinv_description_usage.txt>
+# ----------------------------------------------------------------------------
+# 
+# Copyright (c) 2015 by Thomas Forbriger (BFO Schiltach) 
+# 
+# end-user usage description: C interface
+# 
+#
+# ----
+# 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, see <http://www.gnu.org/licenses/>.
+# ----
+#
+# REVISIONS and CHANGES 
+#    05/10/2015   V1.0   Thomas Forbriger
+# 
+# ============================================================================
+#
+NO YET IMPLEMENTED!
+# ----- END OF stfinv_description_usage.txt ----- 

src/libs/libstfinv/stfinv_summary_usage.txt

+# source code text file
+# this is <stfinv_summary_usage.txt>
+# ----------------------------------------------------------------------------
+# 
+# Copyright (c) 2015 by Thomas Forbriger (BFO Schiltach) 
+# 
+# end-user usage summary: C interface
+# 
+#
+# ----
+# 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, see <http://www.gnu.org/licenses/>.
+# ----
+#
+# REVISIONS and CHANGES 
+#    05/10/2015   V1.0   Thomas Forbriger
+# 
+# ============================================================================
+#
+NO YET IMPLEMENTED!
+# ----- END OF stfinv_summary_usage.txt ----- 

src/libs/libstfinv/stfinvany_description_usage.txt

+# source code text file
+# this is <stfinvany_description_usage.txt>
+# ----------------------------------------------------------------------------
+# 
+# Copyright (c) 2015 by Thomas Forbriger (BFO Schiltach) 
+# 
+# end-user usage description: C++ interface
+# 
+#
+# ----
+# 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, see <http://www.gnu.org/licenses/>.
+# ----
+#
+# REVISIONS and CHANGES 
+#    05/10/2015   V1.0   Thomas Forbriger
+# 
+# ============================================================================
+#
+NO YET IMPLEMENTED!
+# ----- END OF stfinvany_description_usage.txt ----- 

src/libs/libstfinv/stfinvany_summary_usage.txt

+# source code text file
+# this is <stfinvany_summary_usage.txt>
+# ----------------------------------------------------------------------------
+# 
+# Copyright (c) 2015 by Thomas Forbriger (BFO Schiltach) 
+# 
+# end-user usage summary: C++ interface
+# 
+#
+# ----
+# 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, see <http://www.gnu.org/licenses/>.
+# ----
+#
+# REVISIONS and CHANGES 
+#    05/10/2015   V1.0   Thomas Forbriger
+# 
+# ============================================================================
+#
+NO YET IMPLEMENTED!
+# ----- END OF stfinvany_summary_usage.txt ----- 

src/libs/libstfinv/stfinvbase_description_usage.txt

+# source code text file
+# this is <stfinvbase_description_usage.txt>
+# ----------------------------------------------------------------------------
+# 
+# Copyright (c) 2015 by Thomas Forbriger (BFO Schiltach) 
+# 
+# end-user usage description: base engine
+# 
+#
+# ----
+# 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, see <http://www.gnu.org/licenses/>.
+
+# ----
+#
+# REVISIONS and CHANGES 
+#    05/10/2015   V1.0   Thomas Forbriger
+# 
+# ============================================================================
+#
+NO YET IMPLEMENTED!
+# ----- END OF stfinvbase_description_usage.txt ----- 

src/libs/libstfinv/stfinvbase_summary_usage.txt

+# source code text file
+# this is <stfinvbase_summary_usage.txt>
+# ----------------------------------------------------------------------------
+# 
+# Copyright (c) 2015 by Thomas Forbriger (BFO Schiltach) 
+# 
+# end-user usage summary: base engine
+# 
+#
+# ----
+# 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, see <http://www.gnu.org/licenses/>.
+# ----
+#
+# REVISIONS and CHANGES 
+#    05/10/2015   V1.0   Thomas Forbriger
+# 
+# ============================================================================
+#
+NO YET IMPLEMENTED!
+# ----- END OF stfinvbase_summary_usage.txt ----- 

src/libs/libstfinv/stfinvfdleastsquares_description_usage.txt

+# source code text file
+# this is <stfinvfdleastsquares_description_usage.txt>
+# ----------------------------------------------------------------------------
+# 
+# Copyright (c) 2015 by Thomas Forbriger (BFO Schiltach) 
+# 
+# end-user usage description: Fourier domain least squares engine
+# 
+#
+# ----
+# 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, see <http://www.gnu.org/licenses/>.
+# ----
+#
+# REVISIONS and CHANGES 
+#    05/10/2015   V1.0   Thomas Forbriger
+# 
+# ============================================================================
+#
+NO YET IMPLEMENTED!
+# ----- END OF stfinvfdleastsquares_description_usage.txt ----- 

src/libs/libstfinv/stfinvfdleastsquares_summary_usage.txt

+# source code text file
+# this is <stfinvfdleastsquares_summary_usage.txt>
+# ----------------------------------------------------------------------------
+# 
+# Copyright (c) 2015 by Thomas Forbriger (BFO Schiltach) 
+# 
+# end-user usage summary: Fourier domain least squares engine
+# 
+#
+# ----
+# 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, see <http://www.gnu.org/licenses/>.
+# ----
+#
+# REVISIONS and CHANGES 
+#    05/10/2015   V1.0   Thomas Forbriger
+# 
+# ============================================================================
+#
+NO YET IMPLEMENTED!
+# ----- END OF stfinvfdleastsquares_summary_usage.txt ----- 

src/libs/libstfinv/stfinvfinitecausal_description_usage.txt

+# source code text file
+# this is <stfinvfinitecausal_description_usage.txt>
+# ----------------------------------------------------------------------------
+# 
+# Copyright (c) 2015 by Thomas Forbriger (BFO Schiltach) 
+# 
+# end-user usage description: Finite causal engine
+# 
+#
+# ----
+# 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, see <http://www.gnu.org/licenses/>.
+# ----
+#
+# REVISIONS and CHANGES 
+#    05/10/2015   V1.0   Thomas Forbriger
+# 
+# ============================================================================
+#
+NO YET IMPLEMENTED!
+# ----- END OF stfinvfinitecausal_description_usage.txt ----- 

src/libs/libstfinv/stfinvfinitecausal_summary_usage.txt

+# source code text file
+# this is <stfinvfinitecausal_summary_usage.txt>
+# ----------------------------------------------------------------------------
+# 
+# Copyright (c) 2015 by Thomas Forbriger (BFO Schiltach) 
+# 
+# end-user usage summary: Finite causal engine
+# 
+#
+# ----
+# 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, see <http://www.gnu.org/licenses/>.
+# ----
+#
+# REVISIONS and CHANGES 
+#    05/10/2015   V1.0   Thomas Forbriger
+# 
+# ============================================================================
+#
+NO YET IMPLEMENTED!
+# ----- END OF stfinvfinitecausal_summary_usage.txt ----- 

src/libs/libstfinv/stfinvfixedstf_description_usage.txt

+# source code text file
+# this is <stfinvfixedstf_description_usage.txt>
+# ----------------------------------------------------------------------------
+# 
+# Copyright (c) 2015 by Thomas Forbriger (BFO Schiltach) 
+# 
+# end-user usage description: Engine to provide a fixed wavelet
+# 
+#
+# ----
+# 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, see <http://www.gnu.org/licenses/>.
+# ----
+#
+# REVISIONS and CHANGES 
+#    05/10/2015   V1.0   Thomas Forbriger
+# 
+# ============================================================================
+#
+NO YET IMPLEMENTED!
+# ----- END OF stfinvfixedstf_description_usage.txt ----- 

src/libs/libstfinv/stfinvfixedstf_summary_usage.txt

+# source code text file
+# this is <stfinvfixedstf_summary_usage.txt>
+# ----------------------------------------------------------------------------
+# 
+# Copyright (c) 2015 by Thomas Forbriger (BFO Schiltach) 
+# 
+# end-user usage summary: Engine to provide a fixed wavelet
+# 
+#
+# ----
+# 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, see <http://www.gnu.org/licenses/>.
+# ----
+#
+# REVISIONS and CHANGES 
+#    05/10/2015   V1.0   Thomas Forbriger
+# 
+# ============================================================================
+#
+NO YET IMPLEMENTED!
+# ----- END OF stfinvfixedstf_summary_usage.txt ----- 

src/libs/libstfinv/stfinvfourier_description_usage.txt

+# source code text file
+# this is <stfinvfourier_description_usage.txt>
+# ----------------------------------------------------------------------------
+# 
+# Copyright (c) 2015 by Thomas Forbriger (BFO Schiltach) 
+# 
+# end-user usage description: Fourier domain base engine
+# 
+#
+# ----
+# 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, see <http://www.gnu.org/licenses/>.
+# ----
+#
+# REVISIONS and CHANGES 
+#    05/10/2015   V1.0   Thomas Forbriger
+# 
+# ============================================================================
+#
+NO YET IMPLEMENTED!
+# ----- END OF stfinvfourier_description_usage.txt ----- 

src/libs/libstfinv/stfinvfourier_summary_usage.txt

+# source code text file
+# this is <stfinvfourier_summary_usage.txt>
+# ----------------------------------------------------------------------------
+# 
+# Copyright (c) 2015 by Thomas Forbriger (BFO Schiltach) 
+# 
+# end-user usage summary: Fourier domain base engine
+# 
+#
+# ----
+# 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, see <http://www.gnu.org/licenses/>.
+# ----
+#
+# REVISIONS and CHANGES 
+#    05/10/2015   V1.0   Thomas Forbriger
+# 
+# ============================================================================
+#
+NO YET IMPLEMENTED!
+# ----- END OF stfinvfourier_summary_usage.txt ----- 

src/libs/libstfinv/stfinvidentity_description_usage.txt

+# source code text file
+# this is <stfinvidentity_description_usage.txt>
+# ----------------------------------------------------------------------------
+# 
+# Copyright (c) 2015 by Thomas Forbriger (BFO Schiltach) 
+# 
+# end-user usage description: Engine to apply a scalar factor
+# 
+#
+# ----
+# 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, see <http://www.gnu.org/licenses/>.
+# ----
+#
+# REVISIONS and CHANGES 
+#    05/10/2015   V1.0   Thomas Forbriger
+# 
+# ============================================================================
+#
+NO YET IMPLEMENTED!
+# ----- END OF stfinvidentity_description_usage.txt ----- 

src/libs/libstfinv/stfinvidentity_summary_usage.txt

+# source code text file
+# this is <stfinvidentity_summary_usage.txt>
+# ----------------------------------------------------------------------------
+# 
+# Copyright (c) 2015 by Thomas Forbriger (BFO Schiltach) 
+# 
+# end-user usage summary: Engine to apply a scalar factor
+# 
+#
+# ----
+# 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, see <http://www.gnu.org/licenses/>.
+# ----
+#
+# REVISIONS and CHANGES 
+#    05/10/2015   V1.0   Thomas Forbriger
+# 
+# ============================================================================
+#
+NO YET IMPLEMENTED!
+# ----- END OF stfinvidentity_summary_usage.txt ----- 

src/libs/libstfinv/stfinvnormalize_description_usage.txt

+# source code text file
+# this is <stfinvnormalize_description_usage.txt>
+# ----------------------------------------------------------------------------
+# 
+# Copyright (c) 2015 by Thomas Forbriger (BFO Schiltach) 
+# 
+# end-user usage description: Fourier expansion normalization engine
+# 
+#
+# ----
+# 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, see <http://www.gnu.org/licenses/>.
+# ----
+#
+# REVISIONS and CHANGES 
+#    05/10/2015   V1.0   Thomas Forbriger
+# 
+# ============================================================================
+#
+NO YET IMPLEMENTED!
+# ----- END OF stfinvnormalize_description_usage.txt -----