Przeglądaj źródła

:bulb: Ajout documentation encodeur

Arthur Brandao 6 lat temu
rodzic
commit
0b38ef537f
2 zmienionych plików z 74 dodań i 0 usunięć
  1. 65 0
      Serveur/json.h
  2. 9 0
      Serveur/json_encoder.c

+ 65 - 0
Serveur/json.h

@@ -146,15 +146,80 @@ void clean_json_parser(JsonParser*);
 
 //Json Encoder
 
+/**
+ * Initialise le JsonEncoder
+ * @param JsonEncoder* Le JsonEncoder à initialiser
+ */
 void ini_encoder(JsonEncoder*);
+
+/**
+ * Ajoute une valeur au JSON
+ * @param JsonEncoder* La structure pour encoder
+ * @param char* La chaine à ajouter (sous la forme "key": val)
+ */
 void add_value(JsonEncoder*, char*);
+
+/**
+ * Ajoute un string au JSON
+ * @param JsonEncoder* La structure pour encoder
+ * @param char* La clef pour acceder à la valeur
+ * @param char* La valeur
+ */
 void add_string(JsonEncoder*, char*, char*);
+
+/**
+ * Ajoute un nombre au JSON
+ * @param JsonEncoder* La structure pour encoder
+ * @param char* La clef pour acceder à la valeur
+ * @param double La valeur
+ * @param int Le nombre de chiffre après la virgule
+ */
 void add_number(JsonEncoder*, char*, double, int);
+
+/**
+ * Ajoute un entier au JSON
+ * @param JsonEncoder* La structure pour encoder
+ * @param char* La clef pour acceder à la valeur
+ * @param int La valeur
+ */
 void add_integer(JsonEncoder*, char*, int);
+
+/**
+ * Ajoute un boolean au JSON
+ * @param JsonEncoder* La structure pour encoder
+ * @param char* La clef pour acceder à la valeur
+ * @param boolean La valeur
+ */
 void add_boolean(JsonEncoder*, char*, boolean);
+
+/**
+ * Ajoute un tableau au JSON
+ * @param JsonEncoder* La structure pour encoder
+ * @param char* La clef pour acceder à la valeur
+ * @param char* La valeur
+ */
 void add_array(JsonEncoder*, char*, char*);
+
+/**
+ * Ajoute un objet JSON au JSON
+ * @param JsonEncoder* La structure pour encoder
+ * @param char* La clef pour acceder à la valeur
+ * @param JsonEncoder La valeur
+ */
 void add_object(JsonEncoder*, char*, JsonEncoder);
+
+/**
+ * Transforma en chaine de caractère au format JSON
+ * @param JsonEncoder* La structure pour encoder
+ * @return char* La chaine au format JSON
+ */
 char* json_encode(JsonEncoder*);
+
+/**
+ * Supprime les données du JsonEncoder
+ * Après cette méthode la structure peut directement être réutilisée
+ * @param JsonEncoder* La structure à supprimer
+ */
 void clean_json_encoder(JsonEncoder*);
 
 #endif /* JSON_H */

+ 9 - 0
Serveur/json_encoder.c

@@ -11,6 +11,11 @@
 
 /* --- Fonctions privée --- */
 
+/**
+ * Ajout un noeud au JsonEncoder
+ * @param JsonEncoder* La structure pour encoder 
+ * @param char* La chaine à mettre dans le noeud
+ */
 void add_node(JsonEncoder* this, char* str){
     //Création node
     JsonNode* node;
@@ -31,6 +36,10 @@ void add_node(JsonEncoder* this, char* str){
     node->next = NULL;
 }
 
+/**
+ * Supprimme un noeud
+ * @param JsonNode* Le noeud à supprimer
+ */
 void delete_node(JsonNode* node){
     free(node->str);
 }