Render PDF documentation with rst2pdf

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

diff --git a/sample/init_fail_test.c b/sample/init_fail_test.c
index c92bd7dce95aec43df9d9da73ac002b0e77ca030..8fe74e38980ac30470fdf69544cfc86845a64232 100644 (file)
--- a/sample/init_fail_test.c
+++ b/sample/init_fail_test.c
@@ -1,11 +1,20 @@
+/*
+ * 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 a dummy test suite that illustrates how a test suite initialization
+ * can fail. 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_test will be used as test cases,
+ * but since an initialization function fails, none will be executed.
+ *
+ * Please, read the README file for more details.
+ */
 
-/* dummy test to illustrate how a test suite initialization could fail */
-
-#ifdef MUTEST_PY
-#include "../py/mutest.h"
-#else
 #include "../mutest.h"
-#endif
 
 static int ret = 0;