* Documento un poco

diff --git a/emufs/indices.h b/emufs/indices.h
index 7e3d70af42581bcc6b4eea3936c07994616b4bcc..9d40d51d66d0c75c2a2828713db3496b5f878131 100644 (file)
--- a/emufs/indices.h
+++ b/emufs/indices.h
@@ -9,20 +9,27 @@
 
 typedef struct _emu_fs_t EMUFS;
 
-typedef enum {IND_B, IND_B_ASC} INDICE_TIPO;
+/** Tipos de Indices conocidos */
+typedef enum {
+       IND_B, /**< Utilizacion de Arboles B */
+       IND_B_ASC /**< Utilizacion de Arboles B* */
+} INDICE_TIPO;
 
+/** Tipos de datos soportados para las claves */
 typedef enum {IDX_FLOAT, IDX_INT} INDICE_TIPO_DATO;
 
+/** Clave de indice */
 typedef union _data_ {
        float f_clave;
        int i_clave;
 } CLAVE;
 
+/** Manejo de Indices independiente */
 typedef struct _indices_h_ {
-       INDICE_TIPO tipo;
-       INDICE_TIPO_DATO tipo_dato;
-       int offset;
-       unsigned int tam_bloque; /* debe ser multiplo de 512! */
+       INDICE_TIPO tipo;             /**< Tipo de indice */
+       INDICE_TIPO_DATO tipo_dato;   /**< Tipo de dato a manejar */
+       int offset;                   /**< Offset desde el inicio del dato hasta el lugar donde esta la clave */
+       unsigned int tam_bloque;      /**< Tamaño del bloque (nodo). Deber set multiplo de 512! */
 
        /** Agrega la clave k de posicion location en el 
         * indice de forma ordenada
@@ -35,19 +42,44 @@ typedef struct _indices_h_ {
         */
        int (*existe_entrada)(struct _indices_h_ *idx, CLAVE k);
 
-       char *nombre; /* nombre de busqueda */
-       char *filename; /* nombre del archivo indice */
+       char *nombre;   /**< Nombre único de busqueda del indice */
+       char *filename; /**< nombre del archivo de indice */
 
-       struct _indices_h_ *sig;
+       struct _indices_h_ *sig; /**< Siguiente indice */
 } INDICE;
 
+/** Crea un nuevo indice
+ *
+ *  \param emu EMUFS a quien pertenece
+ *  \param nombre Nombre del indice
+ *  \param tipo Tipo de indice
+ *  \param tipo_dato Tipo de dato de la clave
+ *  \param offset Desplazamiento de la clave dentro del dato
+ *  \param tam_bloque Tamaño del bloque (nodo) del arbol
+ */
 INDICE *emufs_indice_crear(EMUFS *emu, char *nombre, INDICE_TIPO tipo, INDICE_TIPO_DATO tipo_dato, unsigned int offset, unsigned tam_bloque);
+
+/** Destruye un indice
+ *
+ *  \todo hacer/revisar
+ */
 void emufs_indice_destruir(EMUFS *emu, INDICE *i);
-void emufs_indice_agregar(INDICE *primero, char *data, int ubicacion);
 
-CLAVE emufs_indice_obtenet_clave(INDICE *idx, char *data);
+/** Agrega una clave en los indices
+ * 
+ *  Agrega la clave en todos los indice, dependiendo de su tipo
+ *  de dato, tipo de arboo, offset, etc
+ *
+ *  \param primer Primer indice a agregar
+ *  \param data Array de datos desde donde tomar las claves
+ *  \param ubicacion Dato a guardar asociado a la clave
+ */
+void emufs_indice_agregar(INDICE *primero, char *data, int ubicacion);
 
+/** Compara 2 claves de la forma c1 < c2 */
 int emufs_indice_es_menor(INDICE *idx, CLAVE c1, CLAVE c2);
+
+/** Compara 2 claves de la forma c1 == c2 */
 int emufs_indice_es_igual(INDICE *idx, CLAVE c1, CLAVE c2);
 #endif