comente un poco los .h

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

diff --git a/emufs/tipo1.h b/emufs/tipo1.h
index 00e63d5a82457891a4f0ca182b1f7426107a72ec..7a7c21f8d2b30482404acaa2249bcc15f21a3d2f 100644 (file)
--- a/emufs/tipo1.h
+++ b/emufs/tipo1.h
@@ -40,27 +40,28 @@
 
 #include "emufs.h"
 
+/** Inicializa un EMUFS para poder ser utilizada como un archivo tipo1. */
 int emufs_tipo1_inicializar(EMUFS*);
 
-/** Lee el registro \param id_reg y lo almacena en \param ptr */
+/** Lee el registro \c reg_id y devolviendo su contenido. */
 void* emufs_tipo1_leer_registro(EMUFS*, EMUFS_REG_ID, EMUFS_REG_SIZE*, int*);
 
-/** Lee el bloque \param num_bloque y lo almacena en \param ptr */
-void* emufs_tipo1_leer_bloque(EMUFS*, EMUFS_BLOCK_ID, int*);
-
-/** Graba el registro apuntado por \param ptr en el archivo */
+/** Graba un registro en el archivo. */
 EMUFS_REG_ID emufs_tipo1_grabar_registro(EMUFS*, void*, EMUFS_REG_SIZE, int*);
 
-/** Graba el bloque apuntado por \param ptr en el archivo */
-EMUFS_BLOCK_ID emufs_tipo1_grabar_bloque(EMUFS*, void*, EMUFS_BLOCK_ID, int*);
+/** Borra un registro de del archivo. */
+int emufs_tipo1_borrar_registro(EMUFS*, EMUFS_REG_ID);
+
+/** Método para modificar un registro. */
+EMUFS_REG_ID emufs_tipo1_modificar_registro(EMUFS *emu, EMUFS_REG_ID, void*, EMUFS_REG_SIZE, int*);
 
-int emufs_tipo1_buscar_registro(EMUFS*, EMUFS_REG_ID);
+/** Método para leer un registro con todo su bloque asociado. */
+void* emufs_tipo1_leer_registro_raw(EMUFS *emu, EMUFS_REG_ID id, EMUFS_REG_SIZE *size, int *pos);
 
-int emufs_tipo1_borrar_registro(EMUFS*, EMUFS_REG_ID, EMUFS_REG_SIZE);
+/** Obtiene estádisticas del archivo */
+EMUFS_Estadisticas emufs_tipo1_leer_estadisticas(EMUFS*);
 
-/*
-int emufs_tipo1_buscar_lugar(EMUFS *emu, EMUFS_REG_SIZE tam_reg,
-               EMUFS_FREE *free_space);
-*/
+/** Método para compactar el archivo reorganizándolo físicamente */
+void emufs_tipo1_compactar(EMUFS*);
 
 #endif /* _EMUFS_TIPO1_H_ */