-#ifndef __FSTREAMS_H
-#define __FSTREAMS_H
-
-#include <com.h>
-
-#ifdef __cplusplus
-extern "C" {
-#endif
-
-fstreams_t
-fstreams_new(int capacity, fn_finalize_t fn_finalize);
-
-int
-fstreams_exclude(fstreams_t fstreams, excludes_t excludes);
-
-int
-fstreams_contains(fstreams_t fstreams, fstream_t fstream);
-
-int
-fstreams_add(fstreams_t fstreams, fstream_t fstream);
-
-int
-fstreams_free(void** fstreamsptr);
-
-int
-fstreams_get_size(fstreams_t fstreams);
-
-int
-fstreams_is_empty(fstreams_t fstreams);
-
-int
-fstreams_contains(fstreams_t fstreams, fstream_t fstream);
-
-int
-fstreams_load(fstreams_t fstreams);
-
-
-
-#ifdef __cplusplus
-}
-#endif
-
-
-#endif /* !__FSTREAMS_H */
+/*\r
+ * include/fstreams.h - type representing a vector of file streams.\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 fstreams type.\r
+ *\r
+ */\r
+#ifndef __FSTREAMS_H\r
+#define __FSTREAMS_H\r
+\r
+#include <com.h>\r
+\r
+#ifdef __cplusplus\r
+extern "C" {\r
+#endif\r
+\r
+/*! \brief fstreams_new - create a new fstreams.\r
+ *\r
+ * \param directory The directory of the tesh file.\r
+ * \param name The name of the tesh file.\r
+ *\r
+ * \return If successful the function returns the newly created\r
+ * unit. Otherwise the function returns NULL and sets the\r
+ * global variable errno with the appropiate error code.\r
+ * remarks:\r
+ * If the parameter directory is NULL, the parameter name\r
+ * must be `stdin`.\r
+ *\r
+ * errors :\r
+ * [EINVAL] if one of the parameters is invalid.\r
+ * [ENOMEM] if the system has not enough space to allocate\r
+ * the file stream.\r
+ */\r
+fstreams_t\r
+fstreams_new(int capacity, void_f_pvoid_t fn_finalize);\r
+\r
+int\r
+fstreams_exclude(fstreams_t fstreams, excludes_t excludes);\r
+\r
+int \r
+fstreams_contains(fstreams_t fstreams, fstream_t fstream);\r
+\r
+int\r
+fstreams_add(fstreams_t fstreams, fstream_t fstream);\r
+\r
+int\r
+fstreams_free(void** fstreamsptr);\r
+\r
+int\r
+fstreams_get_size(fstreams_t fstreams);\r
+\r
+int\r
+fstreams_is_empty(fstreams_t fstreams);\r
+\r
+int \r
+fstreams_contains(fstreams_t fstreams, fstream_t fstream);\r
+\r
+int\r
+fstreams_load(fstreams_t fstreams);\r
+\r
+\r
+\r
+#ifdef __cplusplus\r
+}\r
+#endif\r
+\r
+\r
+#endif /* !__FSTREAMS_H */\r
