Se documenta con doxygen lo que faltaba.

[z.facultad/75.06/emufs.git] / emufs / external_sort / mergepool.h

diff --git a/emufs/external_sort/mergepool.h b/emufs/external_sort/mergepool.h
index 43503f0fc2c23f5ec801cc84358dbe1fb282cee8..d571dd31e3922cb2cd7a8c8b7751051ffde4489a 100644 (file)
--- a/emufs/external_sort/mergepool.h
+++ b/emufs/external_sort/mergepool.h
@@ -42,24 +42,49 @@
 #include "mergefile.h"
 #include <stdlib.h>
 
+/** <em>Pool</em> de archivos temporales para hacer un ordenamiento externo.
+ *  La forma de uso general es, de forma similar al MERGEFILE,
+ *  \ref mergepool_add_file "crear un archivo temporal" ,
+ *  \ref mergepool_append_data "agregarle datos" (repitiendo el proceso varias
+ *  veces creando un lote de archivos temporales) y finalmente ir
+ *  \ref mergepool_pop_min "obteniendo el mínimo valor del lote" hasta que no
+ *  haya más datos.
+ *  \warning Una vez obtenido un dato con mergepool_pop_min() no se pueden
+ *           agregar más archivos temporales ni datos al lote.
+ */
 typedef struct
 {
-       MERGEFILE**            pool;
-       size_t                 size;
-       size_t                 reg_size;
-       CMP_FUNC               cmp;
-       enum { INPUT, OUTPUT } mode;
+       MERGEFILE**            pool; /**< Arreglo de archivos temporales. */
+       size_t                 size; /**< Cantidad de archivos que tiene el lote. */
+       size_t                 reg_size; /**< Tamaño del tipo de dato que guarda. */
+       CMP_FUNC               cmp; /**< Función de comparación. */
+       enum { INPUT, OUTPUT } mode; /**< Modo. */
 }
 MERGEPOOL;
 
+/** Crea un nuevo lote de archivos temporales para ordenamiento externo. */
 MERGEPOOL* mergepool_new(size_t reg_size, CMP_FUNC cmp);
 
+/** Libera un lote de archivos temporales para ordenamiento externo. */
 void mergepool_delete(MERGEPOOL* mp);
 
+/** Agrega un nuevo archivo temporal al lote.
+ *  \return puntero al nuevo archivo temporal o 0 si hubo error.
+ */
 MERGEFILE* mergepool_add_file(MERGEPOOL* mp);
 
+/** Agrega un nuevo dato al lote que se almacena en el último archivo creado.
+ *  \pre mergepool_add_file() fue ejecutada (es decir, hay al menos un archivo
+ *       temporal en el lote.
+ *  \return 0 si hubo error.
+ */
 int mergepool_append_data(MERGEPOOL* mp, void* data);
 
+/** Obtiene el mínimo dato en el lote, sácandolo de éste.
+ *  \post No se pueden ingresar más archivos o datos al lote.
+ *  \return 0 si hubo error, si no, un puntero al mínimo dato del lote que debe
+ *          ser liberado después de usado.
+ */
 void* mergepool_pop_min(MERGEPOOL* mp);
 
 #endif /* _EXTSORT_MERGEPOOL_H_ */