Cambios minimos, no se si entraran en la impresion :(

[z.facultad/75.06/jacu.git] / src / mtf / mtf.h

diff --git a/src/mtf/mtf.h b/src/mtf/mtf.h
index 5b68f686aaf03461fa59a75cf60de5b45b8fbfc6..8f76bed6ed96ff3ceeb9ef65b4b0241eb34bf7d9 100644 (file)
--- a/src/mtf/mtf.h
+++ b/src/mtf/mtf.h
@@ -25,11 +25,34 @@
 #include <stdlib.h>
 #include <string.h>
 
+/** \file
+ *
+ * Implementación del Move To Front
+ *
+ */
+
+/** Aplica el algoritmo MTF a un dato
+ *
+ * \param datos Array de entrada
+ * \param len Tamaño del array de entrada
+ * \param _z Puntero donde se retornará el z
+ * \param z_len Puntero donde se retornará el tamaño de Z
+ * \return El nuevo array luego de aplicar el algotirmo.
+ */
 unsigned char *jacu_mtf(unsigned char *datos, int len, unsigned char **_z, int *z_len);
 
+/** Aplica el algoritmo inverso de MTF
+ *
+ * \param z Vector Z retornado por jacu_mtf
+ * \param pos Vector retornado por jacu_mtf
+ * \param len Tamaño del vector
+ * \param Array de dato original
+ */
 unsigned char *jacu_mtf_inv(unsigned char *z, unsigned char *pos, int len);
 
+/** Busca el vector Z en base a una entrada */
 unsigned char *jacu_buscar_z(unsigned char* datos, int len, int *size);
 
 void print_z(char *z, int len);
+
 #endif