Doxygen entries and license clarification for templates
authorMyungJoo Ham <myungjoo.ham@samsung.com>
Thu, 1 Nov 2018 01:01:03 +0000 (10:01 +0900)
committerMyungJoo Ham <myungjoo.ham@samsung.com>
Thu, 1 Nov 2018 01:01:03 +0000 (10:01 +0900)
- Added doxygen entries for template runTest.sh
- Clarified licenses for template runTest.sh: users may designate any.

Signed-off-by: MyungJoo Ham <myungjoo.ham@samsung.com>
ssat.sh

diff --git a/ssat.sh b/ssat.sh
index e597b7c..5f59574 100755 (executable)
--- a/ssat.sh
+++ b/ssat.sh
@@ -7,6 +7,9 @@
 # @brief This executes test groups and reports aggregated test results.
 # @exit 0 if all PASSED. Positive if some FAILED.
 # @dependency sed
+# @dependency date
+# @dependency cmp
+# @todo Separate GStreamer related functions as plugins
 #
 # If there is no arguments specified, this will search for all "runTest.sh" in
 # the subdirectory of this file and regard them as the test groups.
@@ -23,7 +26,12 @@ TESTCASE="runTest.sh"
 
 #
 SILENT=1
+date=`date +"%b %d %Y"`
 
+##
+# Note that the generated template has no license.
+# The SSAT user may put their own license for the generated files.
+# I hereby grant the right to relicense the generated files.
 function createTemplate {
        if [[ -f "runTest.sh" ]]
        then
@@ -32,6 +40,12 @@ function createTemplate {
        fi
 
        echo -e "#!/usr/bin/env bash\n\
+##\n\
+# @file runTest.sh\n\
+# @author MyungJoo Ham <myungjoo.ham@gmail.com>\n\
+# @date ${date}\n\
+# @brief This is a template file for SSAT test cases. You may designate your own license.\n\
+#\n\
 if [[ \"\$SSATAPILOADED\" != \"1\" ]]\n\
 then\n\
        SILENT=0\n\