Improve names of sample Makefile's variables

[software/mutest.git] / sample / sum_test.c

diff --git a/sample/sum_test.c b/sample/sum_test.c
index 7ef32e89a7c5bcdc050ae680de7b8c9d916221ac..505f814ffe5c3f73df7935aa5baa2ff458a509db 100644 (file)
--- a/sample/sum_test.c
+++ b/sample/sum_test.c
@@ -1,7 +1,20 @@
-
-/* see factorial_test.c for more complete examples, this file is mostly to show
- * how to have multiple test suites, test suite initialization and
- * termination, and a test suite that succeed. */
+/*
+ * This file is part of mutest, a simple micro unit testing framework for C.
+ *
+ * mutest was written by Leandro Lucarella <llucax@gmail.com> and is released
+ * under the BOLA license, please see the LICENSE file or visit:
+ * http://blitiri.com.ar/p/bola/
+ *
+ * This is the sum module test suite. It shows how to have multiple test
+ * suites, test suite initialization and termination, and a test suite that
+ * succeed. Each (public) function starting with mu_init will be picked up by
+ * mkmutest as an initialization function and executed unless one fails
+ * (returns != 0) Functions starting with mu_term will be used as termination
+ * functions, called after all test cases were executed. Functions starting
+ * with mu_test will be used as test cases.
+ *
+ * Please, read the README file for more details.
+ */
 
 #include "sum.h"
 #include <stdlib.h> /* malloc(), free() */