Added documentation for ht and lst

9 files changed, 68 insertions, 52 deletions

diff --git a/src/ht/ft_htdelone.c b/src/ht/ft_htdelone.c
index e3bb355..3672b23 100644
--- a/src/ht/ft_htdelone.c
+++ b/src/ht/ft_htdelone.c
@@ -13,13 +13,17 @@
 #include "libft.h"
 #include "libft_ht.h"
 
-/*
-** Delete one hash table entry at `key`.
+/**
+** \brief      Delete one hash table entry
+** \param key  Key of entry to delete
+** \param del  Function to destroy the entry
+** \warning    The del function HAS to free the key
+** \note       Do nothing if their is to entry which correspond to key
 */
 
-void	ft_htdelone(t_ftht *ht, char *key, void (*del)(t_ftht_content*))
+void	ft_htdelone(t_ftht *ht, char *key, void (*del)(t_ftht_entry*))
 {
-	ft_lstremove_if(ht->entries + ft_hthash(ht, key),
+	ft_lstremove_if(ht->buckets + ft_hthash(ht, key),
 					ft_inter_htkey_cmp, key,
 					(void (*)(void*))del);
 }
diff --git a/src/ht/ft_htdestroy.c b/src/ht/ft_htdestroy.c
index a788a78..ef4b257 100644
--- a/src/ht/ft_htdestroy.c
+++ b/src/ht/ft_htdestroy.c
@@ -13,17 +13,18 @@
 #include "libft.h"
 #include "libft_ht.h"
 
-/*
-** Destroy an hash table.
-** The `del` function is used to destroy each key/value pair
+/**
+** \brief      Destroy an hash table.
+** \param del  Function to delete each entry
+** \warning    The del function HAS to free the key
 */
 
-void	ft_htdestroy(t_ftht *ht, void (*del)(t_ftht_content*))
+void	ft_htdestroy(t_ftht *ht, void (*del)(t_ftht_entry*))
 {
 	if (ht == NULL)
 		return ;
 	while (ht->size-- > 0)
-		ft_lstclear(ht->entries + ht->size, (void (*)(void*))del);
-	free(ht->entries);
+		ft_lstdestroy(ht->buckets + ht->size, (void (*)(void*))del);
+	free(ht->buckets);
 	free(ht);
 }
diff --git a/src/ht/ft_htcontent_new.c b/src/ht/ft_htentry_new.c
index 7dd4f20..03c0980 100644
--- a/src/ht/ft_htcontent_new.c
+++ b/src/ht/ft_htentry_new.c
@@ -1,7 +1,7 @@
 /* ************************************************************************** */
 /*                                                                            */
 /*                                                        :::      ::::::::   */
-/*   ft_htcontent_new.c                                 :+:      :+:    :+:   */
+/*   ft_htentry_new.c                                   :+:      :+:    :+:   */
 /*                                                    +:+ +:+         +:+     */
 /*   By: cacharle <marvin@42.fr>                    +#+  +:+       +#+        */
 /*                                                +#+#+#+#+#+   +#+           */
@@ -13,19 +13,19 @@
 #include "libft.h"
 #include "libft_ht.h"
 
-/*
-** Create a new hash table key/value pair.
-** `key` is always duplicated.
-** Return a pointer to the created content or NULL is an allocation failed.
+/**
+** \brief      Create a new hash table key/value pair.
+** \param key  Hash entry string key (always duplicated)
+** \return     Content or NULL if an allocation failed.
 */
 
-t_ftht_content	*ft_htcontent_new(char *key, void *value)
+t_ftht_entry	*ft_htentry_new(char *key, void *value)
 {
-	t_ftht_content	*content;
+	t_ftht_entry	*content;
 
 	if (key == NULL)
 		return (NULL);
-	if ((content = (t_ftht_content*)malloc(sizeof(t_ftht_content))) == NULL)
+	if ((content = (t_ftht_entry*)malloc(sizeof(t_ftht_entry))) == NULL)
 		return (NULL);
 	if ((content->key = ft_strdup(key)) == NULL)
 	{
diff --git a/src/ht/ft_htget.c b/src/ht/ft_htget.c
index 94a4164..6b5df48 100644
--- a/src/ht/ft_htget.c
+++ b/src/ht/ft_htget.c
@@ -13,9 +13,11 @@
 #include "libft.h"
 #include "libft_ht.h"
 
-/*
-** Retrieve a value with associated key.
-** Returns NULL if there is no value at `key`.
+/**
+** \brief      Retrieve a value with a key
+** \param ht   Hash table where key is searched
+** \param key  Searched key
+** \return     Value void pointer at key or NULL if not found
 */
 
 void	*ft_htget(t_ftht *ht, char *key)
@@ -27,8 +29,8 @@ void	*ft_htget(t_ftht *ht, char *key)
 	if (ht == NULL || key == NULL)
 		return (NULL);
 	digest = ft_hthash(ht, key);
-	found = ft_lstlfind(ht->entries[digest], ft_inter_htkey_cmp, key);
+	found = ft_lstlfind(ht->buckets[digest], ft_inter_htkey_cmp, key);
 	if (found == NULL)
 		return (NULL);
-	return (((t_ftht_content*)found->content)->value);
+	return (((t_ftht_entry*)found->data)->value);
 }
diff --git a/src/ht/ft_hthash.c b/src/ht/ft_hthash.c
index ba922e7..2670e31 100644
--- a/src/ht/ft_hthash.c
+++ b/src/ht/ft_hthash.c
@@ -12,8 +12,11 @@
 
 #include "libft_ht.h"
 
-/*
-** Hash a string according to the size of the hash table.
+/**
+** \brief      Hash a string
+** \param ht   So that the index is in the hash table bound
+** \param key  String to hash
+** \return     Hash
 */
 
 // maybe use a less efficient but understandable function
diff --git a/src/ht/ft_htiter.c b/src/ht/ft_htiter.c
index 5473412..e5ab2eb 100644
--- a/src/ht/ft_htiter.c
+++ b/src/ht/ft_htiter.c
@@ -1,17 +1,19 @@
 #include "libft_ht.h"
 
-/*
-** Iterate function `f` over every pair in `ht`.
+/**
+** \brief Iterate over entry of hash table
+** \param ht  Iterated hash table
+** \param f   Function applied to each entry
 */
 
-void	ft_htiter(t_ftht *ht, void (*f)(t_ftht_content*))
+void	ft_htiter(t_ftht *ht, void (*f)(t_ftht_entry*))
 {
 	size_t	i;
 
 	i = 0;
 	while (i < ht->size)
 	{
-		ft_lstiter(ht->entries[i], (void (*)(void*))f);
+		ft_lstiter(ht->buckets[i], (void (*)(void*))f);
 		i++;
 	}
 }
diff --git a/src/ht/ft_htnew.c b/src/ht/ft_htnew.c
index 465eabf..e28b544 100644
--- a/src/ht/ft_htnew.c
+++ b/src/ht/ft_htnew.c
@@ -13,10 +13,10 @@
 #include "libft.h"
 #include "libft_ht.h"
 
-/*
-** Create a new hash table.
-** `size` is the size of the underlying array of linked list (buckets)
-** Return NULL is an allocation failed.
+/**
+** \brief       Create a new hash table.
+** \param size  Size of the underlying array of linked list (buckets)
+** \return      Created hash table or NULL is an allocation failed
 */
 
 t_ftht	*ft_htnew(t_ftsize size)
@@ -27,8 +27,8 @@ t_ftht	*ft_htnew(t_ftsize size)
 		return (NULL);
 	if ((ht = (t_ftht*)malloc(sizeof(t_ftht))) == NULL)
 		return (NULL);
-	ht->entries = (t_ftht_entry*)ft_calloc(size, sizeof(t_ftht_entry));
-	if (ht->entries == NULL)
+	ht->buckets = (t_ftht_bucket*)ft_calloc(size, sizeof(t_ftht_entry));
+	if (ht->buckets == NULL)
 	{
 		free(ht);
 		return (NULL);
diff --git a/src/ht/ft_htset.c b/src/ht/ft_htset.c
index 0755889..9738c14 100644
--- a/src/ht/ft_htset.c
+++ b/src/ht/ft_htset.c
@@ -13,39 +13,43 @@
 #include "libft.h"
 #include "libft_ht.h"
 
-/*
-** Create/Update a entry in an hash table.
-** If `key` already exist in `ht`, updates only the list element content.
-** else create a new list node in addition the list content.
-** Return a pointer to the created entry, NULL if an allocation failed.
+/**
+** \brief        Create/Update a entry in hash table.
+** \note         If `key` already exist in `ht`, only updates the list node content.
+**               Else create a new list node in addition the list content.
+** \param ht     Hash table where the entry is modified
+** \param key    Key of the new entry
+** \param value  Value of the new entry
+** \param del    Destroy function in case the entry is modified.
+** \return       Pointer to the created entry, NULL if an allocation failed.
 */
 
-t_ftht_content	*ft_htset(t_ftht *ht, char *key, void *value,
-							void (*del)(t_ftht_content*))
+t_ftht_entry	*ft_htset(t_ftht *ht, char *key, void *value,
+							void (*del)(t_ftht_entry*))
 {
 	t_ftht_digest	digest;
-	t_ftht_content	*content;
-	t_ftht_entry	entry;
+	t_ftht_entry	*content;
+	t_ftht_bucket	bucket;
 	t_ftlst			*tmp;
 
 	if (ht == NULL || key == NULL)
 		return (NULL);
-	if ((content = ft_htcontent_new(key, value)) == NULL)
+	if ((content = ft_htentry_new(key, value)) == NULL)
 		return (NULL);
 	digest = ft_hthash(ht, key);
-	tmp = ft_lstlfind(ht->entries[digest], ft_inter_htkey_cmp, key);
+	tmp = ft_lstlfind(ht->buckets[digest], ft_inter_htkey_cmp, key);
 	if (tmp != NULL)
 	{
 		if (del != NULL)
-			del(tmp->content);
-		tmp->content = content;
-		return ((t_ftht_content*)tmp->content);
+			del(tmp->data);
+		tmp->data = content;
+		return ((t_ftht_entry*)tmp->data);
 	}
-	if ((entry = ft_lstnew(content)) == NULL)
+	if ((bucket = ft_lstnew(content)) == NULL)
 	{
 		del(content);
 		return (NULL);
 	}
-	ft_lstadd_front(ht->entries + digest, entry);
+	ft_lstpush_front(ht->buckets + digest, bucket);
 	return (content);
 }
diff --git a/src/ht/ft_inter_htkey_cmp.c b/src/ht/ft_inter_htkey_cmp.c
index 397177e..e8a0375 100644
--- a/src/ht/ft_inter_htkey_cmp.c
+++ b/src/ht/ft_inter_htkey_cmp.c
@@ -21,5 +21,5 @@ int	ft_inter_htkey_cmp(const void *ref_key, const void *content)
 {
 	if (ref_key == NULL || content == NULL)
 		return (-1);
-	return (ft_strcmp((char*)ref_key, ((t_ftht_content*)content)->key));
+	return (ft_strcmp((char*)ref_key, ((t_ftht_entry*)content)->key));
 }