Arreglo el problema de nico

[z.facultad/75.06/emufs.git] / emufs / idx.h

diff --git a/emufs/idx.h b/emufs/idx.h
index cd2c3e3ec8a008a2cbe0e65dce4701ac24458d0d..4d40895ca49d31abfea5c489ea6905f48ed0e619 100644 (file)
--- a/emufs/idx.h
+++ b/emufs/idx.h
@@ -44,22 +44,37 @@
 
 #define EMUFS_IDX_EXT ".idx"
 
+/** Estructura que define el archivo .idx
+  *\param id_reg ID del registro.
+  *\param location Numero de bloque.
+  */
 typedef struct emufs_idx_t {
        EMUFS_REG_ID id_reg;
        EMUFS_BLOCK_ID location;
 } EMUFS_IDX;
 
+
+/** Abre el archivo */
 FILE* emufs_idx_abrir(EMUFS*, const char*);
 
+/** Crea el archivo vacio */
 int emufs_idx_crear(EMUFS*);
 
+/** Devuelve el mayor id libre para un nuevo registro  */
 EMUFS_REG_ID emufs_idx_buscar_mayor_id_libre(EMUFS*, int*);
 
-EMUFS_BLOCK_ID emufs_idx_buscar_registro(EMUFS*, EMUFS_REG_ID);
+/** Busca el bloque al que pertenece el id \c reg_id */
+EMUFS_BLOCK_ID emufs_idx_buscar_registro(EMUFS*, EMUFS_REG_ID reg_id);
 
-int emufs_idx_agregar(EMUFS*, EMUFS_BLOCK_ID, EMUFS_REG_ID);
+/** Agrega un nuevo registro EMUFS_IDX al archivo .idx si no existe
+  * el id \c reg_id, si existe coloca en el campo location el valor 
+  * indicado en \c block_id
+  */
+int emufs_idx_agregar(EMUFS*, EMUFS_BLOCK_ID block_id, EMUFS_REG_ID reg_id);
 
-int emufs_idx_borrar(EMUFS*, EMUFS_REG_ID);
+/** Coloca el valor -1 en el campo location, del registro que contenga el 
+  * id \c reg_id, para indicar que ese id no existe */
+int emufs_idx_borrar(EMUFS*, EMUFS_REG_ID reg_id);
 
 /** Retorna un array con los Ids validos del archivo IDX
  *
@@ -69,10 +84,13 @@ int emufs_idx_borrar(EMUFS*, EMUFS_REG_ID);
  */
 EMUFS_REG_ID *emufs_idx_get(EMUFS *emu, EMUFS_REG_ID *cant);
 
+/** Devuelve un nuevo id valido para un nuevo registro */
 EMUFS_REG_ID emufs_idx_get_new_id(EMUFS*, int*);
 
+/** Retorna 0 si \c ID existe */
 int emufs_idx_existe_id(EMUFS *emu, int ID);
 
+/** Acutaliza el valor de \c bloque segun \c ID */
 int emufs_idx_actualizar(EMUFS *emu, int ID, EMUFS_BLOCK_ID bloque);
 
 /** Obtiene el tamaño del archivo de índice. */