Browse Source

Ajout documentation

Loquicom 6 years ago
parent
commit
5ba016ad22
1 changed files with 18 additions and 0 deletions
  1. 18 0
      expreg.h

+ 18 - 0
expreg.h

@@ -22,10 +22,28 @@ typedef struct{
 }expreg;
 
 /* --- Fonctions --- */
+/**
+ * Initialise la structure de gestion du regex
+ * @param expreg* La structure de l'expression reguliere
+ * @param char* La chaine à analyser
+ * @param char* Le regex
+ * @return Reussite
+ */
 boolean ini_expreg(expreg*, char*, char*);
 
+/**
+ * Recupere la prochaine correspondance dans la chaine
+ * @param expreg* La structure de l'expression reguliere
+ * @param int* La position de debut de la correspondance
+ * @param int* La postion de fin de la correspondance
+ * @return La correspondance ou NULL si il n'y en à plus
+ */
 char* get_match_expreg(expreg*, int*, int*);
 
+/**
+ * Vide la structure de l'expression reguliere
+ * @param expreg* La structure de l'expression reguliere
+ */
 void clean_expreg(expreg*);
 
 #endif /* EXPREG_H */