-#ifndef __RUNNER_H
-#define __RUNNER_H
-
-#include <com.h>
-
-#ifdef __cplusplus
-extern "C" {
-#endif
-
-int
-runner_init(int want_check_syntax, int timeout, fstreams_t fstreams);
-
-void
-runner_destroy(void);
-
-void
-runner_run(void);
-
-void
-runner_display_status(void);
-
-void
-runner_interrupt(void);
-
-
-#ifdef __cplusplus
-}
-#endif
-
-
-#endif /* !__RUNNER_H */
+/*\r
+ * include/runner.h - type representing the tesh runner .\r
+ *\r
+ * Copyright 2008,2009 Martin Quinson, Malek Cherier All right reserved. \r
+ *\r
+ * This program is free software; you can redistribute it and/or modify it \r
+ * under the terms of the license (GNU LGPL) which comes with this package.\r
+ *\r
+ * Purpose:\r
+ * This file contains all the declarations of the functions related with\r
+ * the tesh runner type.\r
+ *\r
+ */\r
+ \r
+#ifndef __RUNNER_H \r
+#define __RUNNER_H\r
+\r
+#include <com.h>\r
+\r
+#ifdef __cplusplus\r
+extern "C" {\r
+#endif\r
+\r
+/*! \brief runner_init - initialize the tesh runner.\r
+ *\r
+ * \param check_syntax_flag If 1, the runner check the syntax of all the tesh files before running.\r
+ * \param timeout The time alloted to the run of all the units (if -1 no time alloted).\r
+ * \param fstreams A fstreams object containing the file streams representing the tesh files to run.\r
+ *\r
+ * \return If successful the function returns 0. Otherwise the function returns -1 and sets\r
+ * the global variable errno with the appropiate error code.\r
+ *\r
+ * errors :\r
+ * [EALREADY] if the runner is already initialized.\r
+ * [ENOMEM] if the system has not enough space to initialize the runner.\r
+ * [ESYNTAX] if the parameter check_syntax_flag is 1 and a syntax error is detected.\r
+ */ \r
+int\r
+runner_init(/*int check_syntax_flag, */int timeout, fstreams_t fstreams);\r
+\r
+/*! \brief runner_run - run the tesh files.\r
+ */ \r
+void\r
+runner_run(void);\r
+\r
+/*! \brief runner_destroy - destroy the runner (release all the resources allocated by the runner)\r
+ */\r
+void\r
+runner_destroy(void);\r
+\r
+/*! \brief runner_summarize - display the summary of the execution of all the tests of the tesh files.\r
+ */\r
+void\r
+runner_summarize(void);\r
+\r
+/*! \brief runner_interrupt - interrupt all the units of the run.\r
+ */\r
+void\r
+runner_interrupt(void);\r
+\r
+int\r
+runner_is_timedout(void);\r
+\r
+\r
+#ifdef __cplusplus\r
+}\r
+#endif\r
+\r
+\r
+#endif /* !__RUNNER_H */\r
