From 0edf40fbf541356d0745f51058f6acf2ef73a38a Mon Sep 17 00:00:00 2001
From: Lyanis Souidi <code@lyanis.sh>
Date: Fri, 28 Apr 2023 20:10:44 +0200
Subject: [PATCH] Ajout de la documentation

---
 .gitignore | 3 ++-
 Makefile   | 5 +++++
 README.md  | 9 ++++++++-
 3 files changed, 15 insertions(+), 2 deletions(-)

diff --git a/.gitignore b/.gitignore
index 326b36e..ccc3572 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,2 +1,3 @@
-out/
+/out/
+/doc/
 *.class
\ No newline at end of file
diff --git a/Makefile b/Makefile
index d05d12f..e48f2d5 100644
--- a/Makefile
+++ b/Makefile
@@ -7,6 +7,7 @@ JVMFLAGS =
 
 SRCDIR = ./src
 OUTDIR = ./out
+DOCDIR = ./doc
 OFILES = $(subst src/,out/,$(subst .java,.class,$(shell find $(SRCDIR)/ -name *.java)))
 
 ### REGLES ESSENTIELLES ###
@@ -24,9 +25,13 @@ run : $(OUTDIR)/Main.class
 
 clean :
 	-rm -rf $(OUTDIR)
+	-rm -rf $(DOCDIR)
 
 mrproper : clean $(OUTDIR)/Main.class
 
+doc :
+	javadoc -d $(DOCDIR) $(SRCDIR)/*.java
+
 ### BUTS FACTICES ###
 
 .PHONY : run clean mrproper
diff --git a/README.md b/README.md
index 9d7bbe7..7cc5631 100644
--- a/README.md
+++ b/README.md
@@ -21,7 +21,14 @@ Une fois la [compilation du programme](#compilation) faite, exécuter le program
 java -cp out/ Main
 ```
 
-# Crédits
+## Documentation
+La documentation du programme est généré à l'aide de JavaDoc. Elle est disponible dans le dossier `doc/` et peut être consultée en ouvrant le fichier `index.html` dans un navigateur web.
+Utilisez la commande suivante pour générer la documentation :
+```bash
+make doc
+```
+
+## Crédits
 -   Code :
     - Amir Daouadi (@daouadi)
     - Lyanis Souidi (@souidi)
\ No newline at end of file