docs(list): moving the actual documentation on the header
- The documentation on the header allow u to see on the files where the header is inclued
This commit is contained in:
parent
52b85d2dc6
commit
3cadabea0a
10 changed files with 74 additions and 66 deletions
|
|
@ -6,7 +6,7 @@
|
||||||
/* By: rparodi <rparodi@student.42.fr> +#+ +:+ +#+ */
|
/* By: rparodi <rparodi@student.42.fr> +#+ +:+ +#+ */
|
||||||
/* +#+#+#+#+#+ +#+ */
|
/* +#+#+#+#+#+ +#+ */
|
||||||
/* Created: 2024/10/31 15:00:12 by rparodi #+# #+# */
|
/* Created: 2024/10/31 15:00:12 by rparodi #+# #+# */
|
||||||
/* Updated: 2025/09/01 16:34:41 by rparodi ### ########.fr */
|
/* Updated: 2025/09/05 16:24:23 by rparodi ### ########.fr */
|
||||||
/* */
|
/* */
|
||||||
/* ************************************************************************** */
|
/* ************************************************************************** */
|
||||||
|
|
||||||
|
|
@ -19,14 +19,78 @@ typedef struct s_list
|
||||||
struct s_list *next;
|
struct s_list *next;
|
||||||
} t_list;
|
} t_list;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @brief Give the size of the chained list
|
||||||
|
*
|
||||||
|
* @param lst the chained list
|
||||||
|
* @return the size of the list
|
||||||
|
*/
|
||||||
int ft_lstsize(t_list *lst);
|
int ft_lstsize(t_list *lst);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @brief Found the last element of the chained list
|
||||||
|
*
|
||||||
|
* @param lst the chained list
|
||||||
|
* @return the last element of the chained list
|
||||||
|
*/
|
||||||
t_list *ft_lstlast(t_list *lst);
|
t_list *ft_lstlast(t_list *lst);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @brief Create an other list from an old one with a function on all element
|
||||||
|
*
|
||||||
|
* @param lst the chained list
|
||||||
|
* @param f the function to function to iterate
|
||||||
|
* @param del The function to delete the old list
|
||||||
|
* @return The list edited by the function given by f
|
||||||
|
*/
|
||||||
t_list *ft_lstmap(t_list *lst, void *(*f)(void *), void (*del)(void *));
|
t_list *ft_lstmap(t_list *lst, void *(*f)(void *), void (*del)(void *));
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @brief Allocate a new list with the first element
|
||||||
|
*
|
||||||
|
* @param content the element to give on first element
|
||||||
|
* @return the new list
|
||||||
|
*/
|
||||||
t_list *ft_lstnew(void *content);
|
t_list *ft_lstnew(void *content);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @brief Add the list new to the back of chained list of lst
|
||||||
|
*
|
||||||
|
* @param lst first element of the list
|
||||||
|
* @param new The element to add at the end
|
||||||
|
*/
|
||||||
void ft_lstadd_back(t_list **lst, t_list *new);
|
void ft_lstadd_back(t_list **lst, t_list *new);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @brief Add the list new to the front of chained list of lst
|
||||||
|
*
|
||||||
|
* @param lst first element of the list
|
||||||
|
* @param new The element to add at the start
|
||||||
|
*/
|
||||||
void ft_lstadd_front(t_list **lst, t_list *new);
|
void ft_lstadd_front(t_list **lst, t_list *new);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @brief Clear the all list with the function
|
||||||
|
*
|
||||||
|
* @param lst the start of the chained list
|
||||||
|
* @param del the function to clear the list
|
||||||
|
*/
|
||||||
void ft_lstclear(t_list **lst, void (*del)(void *));
|
void ft_lstclear(t_list **lst, void (*del)(void *));
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @brief Clear the element of the list with the function
|
||||||
|
*
|
||||||
|
* @param lst the element of the list to be clear
|
||||||
|
* @param del the function to clear the list
|
||||||
|
*/
|
||||||
void ft_lstdelone(t_list *lst, void (*del)(void *));
|
void ft_lstdelone(t_list *lst, void (*del)(void *));
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @brief Apply the fstunction given in arguments at all the element of the list
|
||||||
|
*
|
||||||
|
* @param lst the chained list
|
||||||
|
* @param f the pointer to function
|
||||||
|
*/
|
||||||
void ft_lstiter(t_list *lst, void (*f)(void *));
|
void ft_lstiter(t_list *lst, void (*f)(void *));
|
||||||
|
|
||||||
#endif
|
#endif
|
||||||
|
|
|
||||||
|
|
@ -6,19 +6,13 @@
|
||||||
/* By: rparodi <marvin@42.fr> +#+ +:+ +#+ */
|
/* By: rparodi <marvin@42.fr> +#+ +:+ +#+ */
|
||||||
/* +#+#+#+#+#+ +#+ */
|
/* +#+#+#+#+#+ +#+ */
|
||||||
/* Created: 2023/11/12 11:39:56 by rparodi #+# #+# */
|
/* Created: 2023/11/12 11:39:56 by rparodi #+# #+# */
|
||||||
/* Updated: 2025/09/01 16:35:17 by rparodi ### ########.fr */
|
/* Updated: 2025/09/05 16:14:04 by rparodi ### ########.fr */
|
||||||
/* */
|
/* */
|
||||||
/* ************************************************************************** */
|
/* ************************************************************************** */
|
||||||
|
|
||||||
#include "list.h"
|
#include "list.h"
|
||||||
#include <unistd.h>
|
#include <unistd.h>
|
||||||
|
|
||||||
/**
|
|
||||||
* @brief Add the list new to the back of chained list of lst
|
|
||||||
*
|
|
||||||
* @param lst first element of the list
|
|
||||||
* @param new The element to add at the end
|
|
||||||
*/
|
|
||||||
void ft_lstadd_back(t_list **lst, t_list *new)
|
void ft_lstadd_back(t_list **lst, t_list *new)
|
||||||
{
|
{
|
||||||
t_list *tempo;
|
t_list *tempo;
|
||||||
|
|
|
||||||
|
|
@ -6,19 +6,13 @@
|
||||||
/* By: rparodi <marvin@42.fr> +#+ +:+ +#+ */
|
/* By: rparodi <marvin@42.fr> +#+ +:+ +#+ */
|
||||||
/* +#+#+#+#+#+ +#+ */
|
/* +#+#+#+#+#+ +#+ */
|
||||||
/* Created: 2023/11/12 11:40:16 by rparodi #+# #+# */
|
/* Created: 2023/11/12 11:40:16 by rparodi #+# #+# */
|
||||||
/* Updated: 2025/09/01 16:35:45 by rparodi ### ########.fr */
|
/* Updated: 2025/09/05 16:14:05 by rparodi ### ########.fr */
|
||||||
/* */
|
/* */
|
||||||
/* ************************************************************************** */
|
/* ************************************************************************** */
|
||||||
|
|
||||||
#include "list.h"
|
#include "list.h"
|
||||||
#include <unistd.h>
|
#include <unistd.h>
|
||||||
|
|
||||||
/**
|
|
||||||
* @brief Add the list new to the front of chained list of lst
|
|
||||||
*
|
|
||||||
* @param lst first element of the list
|
|
||||||
* @param new The element to add at the start
|
|
||||||
*/
|
|
||||||
void ft_lstadd_front(t_list **lst, t_list *new)
|
void ft_lstadd_front(t_list **lst, t_list *new)
|
||||||
{
|
{
|
||||||
if (*lst == NULL)
|
if (*lst == NULL)
|
||||||
|
|
|
||||||
|
|
@ -6,18 +6,12 @@
|
||||||
/* By: rparodi <marvin@42.fr> +#+ +:+ +#+ */
|
/* By: rparodi <marvin@42.fr> +#+ +:+ +#+ */
|
||||||
/* +#+#+#+#+#+ +#+ */
|
/* +#+#+#+#+#+ +#+ */
|
||||||
/* Created: 2023/11/12 11:40:37 by rparodi #+# #+# */
|
/* Created: 2023/11/12 11:40:37 by rparodi #+# #+# */
|
||||||
/* Updated: 2025/09/01 16:33:31 by rparodi ### ########.fr */
|
/* Updated: 2025/09/05 16:14:05 by rparodi ### ########.fr */
|
||||||
/* */
|
/* */
|
||||||
/* ************************************************************************** */
|
/* ************************************************************************** */
|
||||||
|
|
||||||
#include "list.h"
|
#include "list.h"
|
||||||
|
|
||||||
/**
|
|
||||||
* @brief Clear the all list with the function
|
|
||||||
*
|
|
||||||
* @param lst the start of the chained list
|
|
||||||
* @param del the function to clear the list
|
|
||||||
*/
|
|
||||||
void ft_lstclear(t_list **lst, void (*del)(void *))
|
void ft_lstclear(t_list **lst, void (*del)(void *))
|
||||||
{
|
{
|
||||||
t_list *tempo;
|
t_list *tempo;
|
||||||
|
|
|
||||||
|
|
@ -6,19 +6,13 @@
|
||||||
/* By: rparodi <marvin@42.fr> +#+ +:+ +#+ */
|
/* By: rparodi <marvin@42.fr> +#+ +:+ +#+ */
|
||||||
/* +#+#+#+#+#+ +#+ */
|
/* +#+#+#+#+#+ +#+ */
|
||||||
/* Created: 2023/11/12 11:42:11 by rparodi #+# #+# */
|
/* Created: 2023/11/12 11:42:11 by rparodi #+# #+# */
|
||||||
/* Updated: 2025/09/01 16:36:07 by rparodi ### ########.fr */
|
/* Updated: 2025/09/05 16:14:05 by rparodi ### ########.fr */
|
||||||
/* */
|
/* */
|
||||||
/* ************************************************************************** */
|
/* ************************************************************************** */
|
||||||
|
|
||||||
#include "list.h"
|
#include "list.h"
|
||||||
#include <stdlib.h>
|
#include <stdlib.h>
|
||||||
|
|
||||||
/**
|
|
||||||
* @brief Clear the element of the list with the function
|
|
||||||
*
|
|
||||||
* @param lst the element of the list to be clear
|
|
||||||
* @param del the function to clear the list
|
|
||||||
*/
|
|
||||||
void ft_lstdelone(t_list *lst, void (*del)(void *))
|
void ft_lstdelone(t_list *lst, void (*del)(void *))
|
||||||
{
|
{
|
||||||
del(lst->content);
|
del(lst->content);
|
||||||
|
|
|
||||||
|
|
@ -6,19 +6,13 @@
|
||||||
/* By: rparodi <marvin@42.fr> +#+ +:+ +#+ */
|
/* By: rparodi <marvin@42.fr> +#+ +:+ +#+ */
|
||||||
/* +#+#+#+#+#+ +#+ */
|
/* +#+#+#+#+#+ +#+ */
|
||||||
/* Created: 2023/11/12 11:42:24 by rparodi #+# #+# */
|
/* Created: 2023/11/12 11:42:24 by rparodi #+# #+# */
|
||||||
/* Updated: 2025/09/01 16:35:17 by rparodi ### ########.fr */
|
/* Updated: 2025/09/05 16:14:05 by rparodi ### ########.fr */
|
||||||
/* */
|
/* */
|
||||||
/* ************************************************************************** */
|
/* ************************************************************************** */
|
||||||
|
|
||||||
#include "list.h"
|
#include "list.h"
|
||||||
#include <unistd.h>
|
#include <unistd.h>
|
||||||
|
|
||||||
/**
|
|
||||||
* @brief Apply the fstunction given in arguments at all the element of the list
|
|
||||||
*
|
|
||||||
* @param lst the chained list
|
|
||||||
* @param f the pointer to function
|
|
||||||
*/
|
|
||||||
void ft_lstiter(t_list *lst, void (*f)(void *))
|
void ft_lstiter(t_list *lst, void (*f)(void *))
|
||||||
{
|
{
|
||||||
while (lst != NULL)
|
while (lst != NULL)
|
||||||
|
|
|
||||||
|
|
@ -6,19 +6,13 @@
|
||||||
/* By: rparodi <marvin@42.fr> +#+ +:+ +#+ */
|
/* By: rparodi <marvin@42.fr> +#+ +:+ +#+ */
|
||||||
/* +#+#+#+#+#+ +#+ */
|
/* +#+#+#+#+#+ +#+ */
|
||||||
/* Created: 2023/11/12 11:42:54 by rparodi #+# #+# */
|
/* Created: 2023/11/12 11:42:54 by rparodi #+# #+# */
|
||||||
/* Updated: 2025/09/01 16:36:47 by rparodi ### ########.fr */
|
/* Updated: 2025/09/05 16:14:04 by rparodi ### ########.fr */
|
||||||
/* */
|
/* */
|
||||||
/* ************************************************************************** */
|
/* ************************************************************************** */
|
||||||
|
|
||||||
#include "list.h"
|
#include "list.h"
|
||||||
#include <unistd.h>
|
#include <unistd.h>
|
||||||
|
|
||||||
/**
|
|
||||||
* @brief Found the last element of the chained list
|
|
||||||
*
|
|
||||||
* @param lst the chained list
|
|
||||||
* @return the last element of the chained list
|
|
||||||
*/
|
|
||||||
t_list *ft_lstlast(t_list *lst)
|
t_list *ft_lstlast(t_list *lst)
|
||||||
{
|
{
|
||||||
if (lst == NULL)
|
if (lst == NULL)
|
||||||
|
|
|
||||||
|
|
@ -6,21 +6,13 @@
|
||||||
/* By: rparodi <marvin@42.fr> +#+ +:+ +#+ */
|
/* By: rparodi <marvin@42.fr> +#+ +:+ +#+ */
|
||||||
/* +#+#+#+#+#+ +#+ */
|
/* +#+#+#+#+#+ +#+ */
|
||||||
/* Created: 2023/11/12 11:43:28 by rparodi #+# #+# */
|
/* Created: 2023/11/12 11:43:28 by rparodi #+# #+# */
|
||||||
/* Updated: 2025/09/01 16:37:46 by rparodi ### ########.fr */
|
/* Updated: 2025/09/05 16:14:05 by rparodi ### ########.fr */
|
||||||
/* */
|
/* */
|
||||||
/* ************************************************************************** */
|
/* ************************************************************************** */
|
||||||
|
|
||||||
#include "list.h"
|
#include "list.h"
|
||||||
#include <unistd.h>
|
#include <unistd.h>
|
||||||
|
|
||||||
/**
|
|
||||||
* @brief Create an other list from an old one with a function on all element
|
|
||||||
*
|
|
||||||
* @param lst the chained list
|
|
||||||
* @param f the function to function to iterate
|
|
||||||
* @param del The function to delete the old list
|
|
||||||
* @return
|
|
||||||
*/
|
|
||||||
t_list *ft_lstmap(t_list *lst, void *(*f)(void *), void (*del)(void *))
|
t_list *ft_lstmap(t_list *lst, void *(*f)(void *), void (*del)(void *))
|
||||||
{
|
{
|
||||||
t_list *tempo;
|
t_list *tempo;
|
||||||
|
|
|
||||||
|
|
@ -6,19 +6,13 @@
|
||||||
/* By: rparodi <marvin@42.fr> +#+ +:+ +#+ */
|
/* By: rparodi <marvin@42.fr> +#+ +:+ +#+ */
|
||||||
/* +#+#+#+#+#+ +#+ */
|
/* +#+#+#+#+#+ +#+ */
|
||||||
/* Created: 2023/11/12 11:44:02 by rparodi #+# #+# */
|
/* Created: 2023/11/12 11:44:02 by rparodi #+# #+# */
|
||||||
/* Updated: 2025/09/01 16:39:00 by rparodi ### ########.fr */
|
/* Updated: 2025/09/05 16:14:05 by rparodi ### ########.fr */
|
||||||
/* */
|
/* */
|
||||||
/* ************************************************************************** */
|
/* ************************************************************************** */
|
||||||
|
|
||||||
#include "list.h"
|
#include "list.h"
|
||||||
#include <stdlib.h>
|
#include <stdlib.h>
|
||||||
|
|
||||||
/**
|
|
||||||
* @brief Allocate a new list with the first element
|
|
||||||
*
|
|
||||||
* @param content the element to give on first element
|
|
||||||
* @return the new list
|
|
||||||
*/
|
|
||||||
t_list *ft_lstnew(void *content)
|
t_list *ft_lstnew(void *content)
|
||||||
{
|
{
|
||||||
t_list *to_return;
|
t_list *to_return;
|
||||||
|
|
|
||||||
|
|
@ -6,19 +6,13 @@
|
||||||
/* By: rparodi <marvin@42.fr> +#+ +:+ +#+ */
|
/* By: rparodi <marvin@42.fr> +#+ +:+ +#+ */
|
||||||
/* +#+#+#+#+#+ +#+ */
|
/* +#+#+#+#+#+ +#+ */
|
||||||
/* Created: 2023/11/12 11:44:24 by rparodi #+# #+# */
|
/* Created: 2023/11/12 11:44:24 by rparodi #+# #+# */
|
||||||
/* Updated: 2025/09/01 16:39:28 by rparodi ### ########.fr */
|
/* Updated: 2025/09/05 16:14:04 by rparodi ### ########.fr */
|
||||||
/* */
|
/* */
|
||||||
/* ************************************************************************** */
|
/* ************************************************************************** */
|
||||||
|
|
||||||
#include "list.h"
|
#include "list.h"
|
||||||
#include <unistd.h>
|
#include <unistd.h>
|
||||||
|
|
||||||
/**
|
|
||||||
* @brief Give the size of the chained list
|
|
||||||
*
|
|
||||||
* @param lst the chained list
|
|
||||||
* @return the size of the list
|
|
||||||
*/
|
|
||||||
int ft_lstsize(t_list *lst)
|
int ft_lstsize(t_list *lst)
|
||||||
{
|
{
|
||||||
int count;
|
int count;
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue