From d56670cd3457df811ace708c7c52ddb46c7e52e6 Mon Sep 17 00:00:00 2001
From: rick <rick@gnous.eu>
Date: Tue, 16 Feb 2021 17:26:48 +0100
Subject: [PATCH] Ajout doc & modification nom biblio

---
 src/include/mylib.h                      |  5 ----
 src/{include/mylib.c => parser/parser.c} | 38 +++++++++++++++---------
 src/parser/parser.h                      | 17 +++++++++++
 src/shell1.c                             |  2 +-
 src/shell2.c                             |  2 +-
 src/shellOpt.c                           |  2 +-
 6 files changed, 44 insertions(+), 22 deletions(-)
 delete mode 100644 src/include/mylib.h
 rename src/{include/mylib.c => parser/parser.c} (59%)
 create mode 100644 src/parser/parser.h

diff --git a/src/include/mylib.h b/src/include/mylib.h
deleted file mode 100644
index 1d11177..0000000
--- a/src/include/mylib.h
+++ /dev/null
@@ -1,5 +0,0 @@
-#define MAX_LENGTH 200
-
-void get_input(char *user_input);
-void parse_char(char *args[], char find);
-void tok_space(char *args,char  *commands[]);
diff --git a/src/include/mylib.c b/src/parser/parser.c
similarity index 59%
rename from src/include/mylib.c
rename to src/parser/parser.c
index 0cf1235..f11e089 100644
--- a/src/include/mylib.c
+++ b/src/parser/parser.c
@@ -1,13 +1,18 @@
+/**
+ * @file parser.c
+ * @author rick <rick@gnous.eu>
+ * @date 2021
+ */
+
+#include "parser.h"
+
 #include <stdio.h>
 #include <stdlib.h>
 #include <string.h>
 
-#include "mylib.h"
-
 /**
- * @brief Permet de récupérer la commande de l’utilisateur
- *
- * @param user_input entrée de l’utilisateur, contiendrat la commande à exécuter
+ * get_input(): Permet de récupérer la saisie de l’utilisateur
+ * @user_input: string où sera enregistrée l’entrée de l’utilisateur
  */
 void get_input(char *user_input)
 {
@@ -25,12 +30,12 @@ void get_input(char *user_input)
 }
 
 /**
- * @brief récupère l’entrée de l’utilisateur et la découpe
- * selon le caractère passé en paramètre
+ * parse_char(): Récupère l’entrée de l’utilisateur avant de la parser
+ * @args: Tableau de string
+ * @find: caractère utilisé pour parser
  *
- * @param args Tableau de string qui sera modifié avec
- * les arguments de la commande
- * @param find Le caractère à utiliser pour découper la chaine
+ * Récupère l’entrée de l’utilisateur avant de la parser avec le caractère
+ * find. Chaque string sera mise dans une case de args.
  */
 void parse_char(char *args[], char find)
 {
@@ -56,10 +61,15 @@ void parse_char(char *args[], char find)
   free(user_input);
 }
 
-/*
- * @brief parse la chaine orig avec les espaces et la met dans le tableau dest
- * */
-void tok_space(char *orig, char* dest[])
+/**
+ * tok_space(): Découpe la chaine orig et met chaque mot dans le tableau dest
+ * @orig: chaine à découper
+ * @dest: tableau de string où sera stocker les mots
+ *
+ * La chaine de caractères orig est découper avec les espaces et chaques
+ * mots sont mis dans le tableau dest.
+ */
+void tok_space(char *orig, char *dest[])
 {
   char find = ' ';
 
diff --git a/src/parser/parser.h b/src/parser/parser.h
new file mode 100644
index 0000000..078d64b
--- /dev/null
+++ b/src/parser/parser.h
@@ -0,0 +1,17 @@
+/**
+ * @file parser.h
+ * @author rick <rick@gnous.eu>
+ * @date 2021
+ * Bibliothèque pour le shell rishtik
+ */
+
+#ifndef _PARSER_H_
+#   define _PARSER_H_
+
+#define MAX_LENGTH 200 /* taille maximum des tableaux utilisés */
+
+void get_input(char *user_input);
+void parse_char(char *args[], char find);
+void tok_space(char *args,char  *commands[]);
+
+#endif
diff --git a/src/shell1.c b/src/shell1.c
index 51cc4f4..02768e1 100644
--- a/src/shell1.c
+++ b/src/shell1.c
@@ -4,7 +4,7 @@
 #include <unistd.h>
 #include <sys/wait.h>
 
-#include "mylib.h"
+#include "parser.h"
 
 int main()
 {
diff --git a/src/shell2.c b/src/shell2.c
index 859acb6..abeffa9 100644
--- a/src/shell2.c
+++ b/src/shell2.c
@@ -4,7 +4,7 @@
 #include <unistd.h>
 #include <sys/wait.h>
 
-#include "mylib.h"
+#include "parser.h"
 
 int main()
 {
diff --git a/src/shellOpt.c b/src/shellOpt.c
index 16af409..bc46eab 100644
--- a/src/shellOpt.c
+++ b/src/shellOpt.c
@@ -4,7 +4,7 @@
 #include <unistd.h>
 #include <sys/wait.h>
 
-#include "mylib.h"
+#include "parser.h"
 
 
 int main()