souidi/SAE21_2022
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Ajout de la documentation

Browse Source
This commit is contained in:
Lyanis SOUIDI 2023-04-28 20:10:44 +02:00
parent 5bd3247003
commit 0edf40fbf5
Signed by: Lyanis SOUIDI
GPG Key ID: 251ADD56CFE6A854
3 changed files with 15 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
.gitignore vendored
View File

@ -1,2 +1,3 @@
out/ /out/
/doc/
*.class *.class

5
Makefile
View File

@ -7,6 +7,7 @@ JVMFLAGS =
SRCDIR = ./src SRCDIR = ./src
OUTDIR = ./out OUTDIR = ./out
DOCDIR = ./doc
OFILES = $(subst src/,out/,$(subst .java,.class,$(shell find $(SRCDIR)/ -name *.java))) OFILES = $(subst src/,out/,$(subst .java,.class,$(shell find $(SRCDIR)/ -name *.java)))
### REGLES ESSENTIELLES ### ### REGLES ESSENTIELLES ###
@ -24,9 +25,13 @@ run : $(OUTDIR)/Main.class
clean : clean :
-rm -rf $(OUTDIR) -rm -rf $(OUTDIR)
-rm -rf $(DOCDIR)
mrproper : clean $(OUTDIR)/Main.class mrproper : clean $(OUTDIR)/Main.class
doc :
javadoc -d $(DOCDIR) $(SRCDIR)/*.java
### BUTS FACTICES ### ### BUTS FACTICES ###
.PHONY : run clean mrproper .PHONY : run clean mrproper

9
README.md
View File

@ -21,7 +21,14 @@ Une fois la [compilation du programme](#compilation) faite, exécuter le program
java -cp out/ Main 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 : - Code :
- Amir Daouadi (@daouadi) - Amir Daouadi (@daouadi)
- Lyanis Souidi (@souidi) - Lyanis Souidi (@souidi)