Browse Source

Ajout documentation

Loquicom 6 years ago
parent
commit
82d480f3d7
3 changed files with 55 additions and 0 deletions
  1. 42 0
      command.h
  2. 9 0
      ipc.h
  3. 4 0
      mysh.h

+ 42 - 0
command.h

@@ -30,12 +30,54 @@ extern char* cmdlist[];
 extern boolean exitsh;
 
 /* --- Fonctions --- */
+/**
+ * Initialise la liste de PID
+ * @param pid_list* La liste de PID
+ */
 void ini_pid_list(pid_list*);
+
+/**
+ * Ajoute un PID dans la liste
+ * @param pid_list* La liste de PID
+ * @param pid_t Le pid
+ * @param int Le numero de job
+ * @return Le noeud crée
+ */
 pid_node* add_pid(pid_list*, pid_t, int);
+
+/**
+ * Cherche un PID dans la liste
+ * @param pid_list* La liste de PID
+ * @param pid_t le PID
+ * @return Le noeud du pid
+ */
 pid_node* search_pid(pid_list*, pid_t);
+
+/**
+ * Supprime un PID de la liste
+ * @param pid_list* La liste de PID
+ * @param pid_node* Le noeud à supprimer
+ */
 void remove_pid(pid_list*, pid_node*);
+
+/**
+ * Vide la liste de PID
+ * @param pid_list* La liste de PID
+ */
 void clean_pid(pid_list*);
+
+/**
+ * Indique si un commande est une commande interne
+ * @param char* La commande
+ * @return Truu : oui / False : non
+ */
 boolean is_internal_cmd(const char*);
+
+/**
+ * Lance une commande intene
+ * @param Commande* La structure de la commande
+ * @return Le statut
+ */
 int launch_internal_command(Command*);
 
 /* --- Commandes --- */

+ 9 - 0
ipc.h

@@ -31,8 +31,17 @@ typedef struct{
 extern ipc_mysh ipc;
 
 /* --- Fonctions --- */
+/**
+ * Création/Récupération SHM et SEM
+ * @param char** Envp pour la création
+ * @return Réussite
+ */
 boolean setup_ipc(char**);
 
+/**
+ * Destruction des SHM et SEM
+ * @return Reussite
+ */
 boolean end_ipc();
 
 /**

+ 4 - 0
mysh.h

@@ -28,6 +28,10 @@ void show_current_dir(const char*, const char*);
  */
 int run(CommandTab, int*);
 
+/**
+ * Gestionnaire de signaux
+ * @param int Le type de singal reçu
+ */
 void handler(int);
 
 #endif /* MYSH_H */