From 65a19784fa10a1f6514917f70302193e4d155f3d Mon Sep 17 00:00:00 2001
From: yosyo <mmoussou@student.42angouleme.fr>
Date: Tue, 21 May 2024 00:21:51 +0200
Subject: [PATCH] =?UTF-8?q?=E3=80=8C=F0=9F=93=9D=E3=80=8D=20doc(includes):?=
 =?UTF-8?q?=20added=20doc=20for=20env=20func?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 include/execution.h | 63 ++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 62 insertions(+), 1 deletion(-)

diff --git a/include/execution.h b/include/execution.h
index 2a85fb8..b084f28 100644
--- a/include/execution.h
+++ b/include/execution.h
@@ -6,7 +6,7 @@
 /*   By: mmoussou <mmoussou@student.42angouleme.fr  +#+  +:+       +#+        */
 /*                                                +#+#+#+#+#+   +#+           */
 /*   Created: 2024/04/29 13:20:22 by mmoussou          #+#    #+#             */
-/*   Updated: 2024/05/20 10:57:33 by mmoussou         ###   ########.fr       */
+/*   Updated: 2024/05/21 00:20:49 by mmoussou         ###   ########.fr       */
 /*                                                                            */
 /* ************************************************************************** */
 
@@ -22,15 +22,76 @@ typedef struct s_env
 	struct s_env	*next;
 }	t_env;
 
+/**
+ * @brief				spawn a heredoc
+ *
+ * @param delimiter		a string representing the delimiter of the heredoc
+ *
+ * @return (int)		fd of a file containing the user's input, or -1 on error
+ */
 int		ft_heredoc(char *delimiter);
 
+/**
+ * @brief				function to fill an env struct from an array
+ *
+ * @param env_d			env values as an array
+ * @param env			pointer to the env struct we will fill
+ *
+ * @return (int)		0 if everything goes well, 1 on error
+ */
 int		env_init(char **env_d, t_env *env);
+
+/**
+ * @brief				DEBUG FUNC : print the actual state of the env struct
+ *
+ * @param env			the env struct that will be printed
+ *
+ * @return (void)
+ */
 void	env_print(t_env *env);
+
+/**
+ * @brief				get an array from the env struct
+ *
+ * @param env			the env struct you want to convert
+ *
+ * @return (char **)	the array, or NULL on error
+ */
 char	**env_get(t_env *env);
+
+/**
+ * @brief				append content at the end of an env variable
+ *
+ * @param name			name of the variable that will be changed
+ * @param content		content that will be append
+ * @param env			the env struct that will be affected
+ *
+ * @return (int)		0 if everything goes well, -1 on error
+ */
 int		env_append(char *name, char *content, t_env *env);
+
+/**
+ * @brief				replace the content of an env variable
+ *
+ * @param name			name of the variable that will be changed
+ * @param content		content that you want to add
+ * @param env			the env struct that will be affected
+ *
+ * @return (int)		0 if everything goes well, -1 on error
+ */
 int		env_edit(char *name, char *content, t_env *env);
+
+/**
+ * @brief				delete an entry in the env struct
+ *
+ * @param name			name of the variable that will be deleted
+ * @param env			the env struct that will be affected
+ *
+ * @return (int)		0 if everything goes well, -1 on error
+ */
 int		env_delete(char *name, t_env *env);
 
+// theses are literally the linked-list functions but for env
 void	ft_envadd_back(t_env **env, t_env *new);
 void	ft_envadd_front(t_env **lst, t_env *new);
 void	ft_envclear(t_env **lst, void (*del)(void *));