[pktools] 50/375: added doc

[Bas Couwenberg]

This is an automated email from the git hooks/post-receive script.

sebastic-guest pushed a commit to branch upstream-master
in repository pktools.

commit 75eb74353cc2ab1f45223b43e79b49d47a7bb39b
Author: Pieter Kempeneers <kempenep at gmail.com>
Date:   Mon Feb 4 12:49:07 2013 +0100

    added doc
---
 Doxyfile                 |  2 +-
 doc/createappsdox.sh     | 33 +++++++++++++++++++++++++++++++++
 src/apps/Makefile.am     | 12 ++++++++----
 src/apps/pkascii2ogr.cc  |  2 +-
 src/apps/pkdsm2shadow.cc |  2 +-
 src/apps/pkfilter.cc     |  2 +-
 6 files changed, 45 insertions(+), 8 deletions(-)

diff --git a/Doxyfile b/Doxyfile
index 568d39f..66e3662 100644
--- a/Doxyfile
+++ b/Doxyfile
@@ -668,7 +668,7 @@ WARN_LOGFILE           =
 # directories like "/usr/src/myproject". Separate the files or directories
 # with spaces.
 
-INPUT                  =
+INPUT                  = doc
 
 # This tag can be used to specify the character encoding of the source files
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
diff --git a/doc/createappsdox.sh b/doc/createappsdox.sh
new file mode 100755
index 0000000..a125da9
--- /dev/null
+++ b/doc/createappsdox.sh
@@ -0,0 +1,33 @@
+#!/bin/bash
+
+cat > ../doc/header.dox <<EOF
+\section thetool thetool
+theshortdescription
+
+<code>
+thesynopsis
+</code>
+
+ - use either \`-short\` or \`--long\` options (both \`--long=value\` and \`--long value\` are supported)
+ - short option \`-h\` shows basic options only, long option \`--h\` shows all options
+|short|long|type|default|description|
+|-----|----|----|-------|-----------|
+EOF
+
+for file in ../src/apps/pk*.cc;do    
+    THETOOL=$(basename $file .cc)
+    echo ${THETOOL}
+    cat ../doc/header.dox > ../doc/${THETOOL}.dox
+    sed -i "s/thetool/$THETOOL/g" ../doc/${THETOOL}.dox
+    THESHORTDESCRIPTION=$(grep "${THETOOL}.cc: " $file | awk -v FS=':' '{print $2}')
+    sed -i "s/theshortdescription/$THESHORTDESCRIPTION/" ../doc/${THETOOL}.dox
+    THESYNOPSIS="${THETOOL} [OPTIONS]"
+    sed -i "s/thesynopsis/$THESYNOPSIS/" ../doc/${THETOOL}.dox
+    ${THETOOL} --doxygen|sed '$d' >> ../doc/${THETOOL}.dox
+done
+
+for file in ../src/apps/pk*.cc;do
+    THETOOL=$(basename $file .cc)
+    THESHORTDESCRIPTION=$(grep "${THETOOL}.cc: " $file | awk -v FS=':' '{print $2}')
+    echo "- \\ref ${THETOOL} ${THESHORTDESCRIPTION}"; 
+done > ../doc/apps.dox
\ No newline at end of file
diff --git a/src/apps/Makefile.am b/src/apps/Makefile.am
index 5fe6484..02e224d 100644
--- a/src/apps/Makefile.am
+++ b/src/apps/Makefile.am
@@ -5,8 +5,12 @@ LDADD = $(GDAL_LDFLAGS) $(top_builddir)/src/algorithms/libalgorithms.a $(top_bui
 # THE PROGRAMS TO BUILD
 ###############################################################################
 
-# the program to build (the names of the final binaries)
-bin_PROGRAMS = pkinfo pkcrop pkreclass pkgetmask pksetmask pkcreatect pkdumpimg pkdumpogr pksieve pkstat pkstatogr pkegcs pkextract pkfillnodata pkfilter pkdsm2shadow pkmosaic pkndvi pkpolygonize pkascii2img pkdiff pkclassify_svm pkfs_svm pkascii2ogr #pkxcorimg pkgeom
+# the program to build and install (the names of the final binaries)
+bin_PROGRAMS = pkinfo pkcrop pkreclass pkgetmask pksetmask pkcreatect pkdumpimg pkdumpogr pksieve pkstat pkstatogr pkegcs pkextract pkfillnodata pkfilter pkdsm2shadow pkmosaic pkndvi pkpolygonize pkascii2img pkdiff pkclassify_svm pkfs_svm pkascii2ogr
+
+# the program to build but not install (the names of the final binaries)
+noinst_PROGRAMS =  pkxcorimg pkgeom
+
 if USE_FANN
 bin_PROGRAMS += pkclassify_nn pkfs_nn
 pkclassify_nn_SOURCES = $(top_srcdir)/src/algorithms/myfann_cpp.h pkclassify_nn.h pkclassify_nn.cc
@@ -58,6 +62,6 @@ pkfs_svm_SOURCES = $(top_srcdir)/src/algorithms/svm.h $(top_srcdir)/src/algorith
 pkfs_svm_LDADD = $(GSL_LIBS) $(AM_LDFLAGS)
 pkascii2img_SOURCES = pkascii2img.cc
 pkascii2ogr_SOURCES = pkascii2ogr.cc
-#pkxcorimg_SOURCES= pkxcorimg.cc
-#pkgeom_SOURCES = pkgeom.cc
+pkxcorimg_SOURCES= pkxcorimg.cc
+pkgeom_SOURCES = pkgeom.cc
 ###############################################################################
diff --git a/src/apps/pkascii2ogr.cc b/src/apps/pkascii2ogr.cc
index 7d90515..d7b2e3e 100644
--- a/src/apps/pkascii2ogr.cc
+++ b/src/apps/pkascii2ogr.cc
@@ -1,5 +1,5 @@
 /**********************************************************************
-pkascii2ogr.cc: program to create vector (ogr) points polygon) from text file
+pkascii2ogr.cc: program to create vector points or polygons from text file
 Copyright (C) 2008-2012 Pieter Kempeneers
 
 This file is part of pktools
diff --git a/src/apps/pkdsm2shadow.cc b/src/apps/pkdsm2shadow.cc
index ea1d6f4..958f7e7 100644
--- a/src/apps/pkdsm2shadow.cc
+++ b/src/apps/pkdsm2shadow.cc
@@ -1,5 +1,5 @@
 /**********************************************************************
-pkveg2shadow.cc: program to calculate sun shadow based on digital surface model and sun angles)
+pkdsm2shadow.cc: program to calculate sun shadow based on digital surface model and sun angles
 Copyright (C) 2008-2012 Pieter Kempeneers
 
 This file is part of pktools
diff --git a/src/apps/pkfilter.cc b/src/apps/pkfilter.cc
index c8846d5..a229dc3 100644
--- a/src/apps/pkfilter.cc
+++ b/src/apps/pkfilter.cc
@@ -1,5 +1,5 @@
 /**********************************************************************
-pkfilter.cc: program to filter raster images (e.g., median, min/max, morphological filtering)
+pkfilter.cc: program to filter raster images: median, min/max, morphological, filtering
 Copyright (C) 2008-2012 Pieter Kempeneers
 
 This file is part of pktools

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-grass/pktools.git