Skip to content

Commit

Permalink
Alineo comments
Browse files Browse the repository at this point in the history
  • Loading branch information
RaniAgus committed Jul 11, 2024
1 parent 0243a1a commit 7a76e31
Show file tree
Hide file tree
Showing 10 changed files with 201 additions and 269 deletions.
21 changes: 11 additions & 10 deletions src/commons/bitarray.h
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,10 @@
#define BIT_CHAR(bit) ((bit) / CHAR_BIT)

/**
* @enum bit_numbering_t
* @brief Define el orden bajo el cual se guardarán los bits a la hora de llenar los bytes.
* @enum bit_numbering_t
* @brief Define el orden bajo el cual se guardarán los bits a la hora de llenar los bytes
* @relates t_bitarray
*
* @note La mayoría de las implementaciones de bitmap usan LSB_FIRST. Si no estás seguro
* de cuál usar, probablemente quieras usar esta.
*/
Expand All @@ -38,7 +39,7 @@

/**
* @struct t_bitarray
* @brief Manipulación de un bloque de memoria a nivel de bits
* @brief Manipulación de un bloque de memoria a nivel de bits
*/
typedef struct {
char *bitarray;
Expand All @@ -50,7 +51,7 @@
* @warning Esta función se encuentra en revisión y probablemente cambie en próximas versiones.
* Usar bitarray_create_with_mode().
*
* @brief Crea y devuelve un puntero a una estructura t_bitarray con formato LSB_FIRST
* @brief Crea y devuelve un puntero a una estructura t_bitarray con formato LSB_FIRST
* @relates t_bitarray
*
* @param bitarray El bloque de memoria que contiene los bits a leer/escribir
Expand All @@ -65,7 +66,7 @@
t_bitarray *bitarray_create(char *bitarray, size_t size) __attribute__((deprecated));

/**
* @brief Crea y devuelve un puntero a una estructura t_bitarray
* @brief Crea y devuelve un puntero a una estructura t_bitarray
* @relates t_bitarray
*
* @param bitarray El bloque de memoria que contiene los bits a leer/escribir
Expand All @@ -80,31 +81,31 @@
t_bitarray *bitarray_create_with_mode(char *bitarray, size_t size, bit_numbering_t mode);

/**
* @brief Devuelve el valor del bit de la posicion indicada
* @brief Devuelve el valor del bit de la posicion indicada
* @relates t_bitarray
*/
bool bitarray_test_bit(t_bitarray*, off_t bit_index);

/**
* @brief Setea el valor del bit de la posicion indicada
* @brief Setea el valor del bit de la posicion indicada
* @relates t_bitarray
*/
void bitarray_set_bit(t_bitarray*, off_t bit_index);

/**
* @brief Limpia el valor del bit de la posicion indicada
* @brief Limpia el valor del bit de la posicion indicada
* @relates t_bitarray
*/
void bitarray_clean_bit(t_bitarray*, off_t bit_index);

/**
* @brief Devuelve la cantidad de bits en el bitarray
* @brief Devuelve la cantidad de bits en el bitarray
* @relates t_bitarray
*/
size_t bitarray_get_max_bit(t_bitarray*);

/**
* @brief Destruye el bit array
* @brief Destruye el bit array
* @relates t_bitarray
*/
void bitarray_destroy(t_bitarray*);
Expand Down
32 changes: 16 additions & 16 deletions src/commons/collections/dictionary.h
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@

/**
* @struct t_dictionary
* @brief Estructura de un diccionario que contiene pares string->puntero
* @brief Estructura de un diccionario que contiene pares string->puntero
*/
typedef struct {
t_hash_element **elements;
Expand All @@ -35,93 +35,93 @@
} t_dictionary;

/**
* @brief Crea el diccionario
* @brief Crea el diccionario
* @relates t_dictionary
*/
t_dictionary *dictionary_create();

/**
* @brief Inserta un nuevo par (key->element) al diccionario, en caso de ya existir la key actualiza el elemento.
* @brief Inserta un nuevo par (key->element) al diccionario, en caso de ya existir la key actualiza el elemento.
* @relates t_dictionary
*
* @warning Tener en cuenta que esto no va a liberar la memoria del `element` original.
*/
void dictionary_put(t_dictionary *, char *key, void *element);

/**
* @brief Obtiene el elemento asociado a la key.
* @brief Obtiene el elemento asociado a la key.
* @relates t_dictionary
*/
void *dictionary_get(t_dictionary *, char *key);

/**
* @brief Remueve un elemento del diccionario y lo retorna.
* @brief Remueve un elemento del diccionario y lo retorna.
* @relates t_dictionary
*/
void *dictionary_remove(t_dictionary *, char *key);

/**
* @brief Remueve un elemento del diccionario y lo destruye.
* @brief Remueve un elemento del diccionario y lo destruye.
* @relates t_dictionary
*/
void dictionary_remove_and_destroy(t_dictionary *, char *, void(*element_destroyer)(void*));

/**
* @brief Aplica closure a todos los elementos del diccionario.
* @brief Aplica closure a todos los elementos del diccionario.
* @relates t_dictionary
*/
void dictionary_iterator(t_dictionary *, void(*closure)(char* key, void* element));

/**
* @brief Quita todos los elementos del diccionario
* @brief Quita todos los elementos del diccionario
* @relates t_dictionary
*/
void dictionary_clean(t_dictionary *);

/**
* @brief Quita todos los elementos del diccionario y los destruye
* @brief Quita todos los elementos del diccionario y los destruye
* @relates t_dictionary
*/
void dictionary_clean_and_destroy_elements(t_dictionary *, void(*element_destroyer)(void*));

/**
* @brief Retorna true si key se encuentra en el diccionario
* @brief Retorna true si key se encuentra en el diccionario
* @relates t_dictionary
*/
bool dictionary_has_key(t_dictionary *, char* key);

/**
* @brief Retorna true si el diccionario está vacío
* @brief Retorna true si el diccionario está vacío
* @relates t_dictionary
*/
bool dictionary_is_empty(t_dictionary *);

/**
* @brief Retorna la cantidad de elementos del diccionario
* @brief Retorna la cantidad de elementos del diccionario
* @relates t_dictionary
*/
int dictionary_size(t_dictionary *);

/**
* @brief Retorna todas las keys en una lista
* @brief Retorna todas las keys en una lista
* @relates t_dictionary
*/
t_list *dictionary_keys(t_dictionary *self);

/**
* @brief Retorna todos los elementos en una lista
* @brief Retorna todos los elementos en una lista
* @relates t_dictionary
*/
t_list *dictionary_elements(t_dictionary *self);

/**
* @brief Destruye el diccionario
* @brief Destruye el diccionario
* @relates t_dictionary
*/
void dictionary_destroy(t_dictionary *);

/**
* @brief Destruye el diccionario y destruye sus elementos
* @brief Destruye el diccionario y destruye sus elementos
* @relates t_dictionary
*/
void dictionary_destroy_and_destroy_elements(t_dictionary *, void(*element_destroyer)(void*));
Expand Down
Loading

0 comments on commit 7a76e31

Please sign in to comment.