Ajout de la documentation
This commit is contained in:
parent
5bd3247003
commit
0edf40fbf5
3
.gitignore
vendored
3
.gitignore
vendored
@ -1,2 +1,3 @@
|
|||||||
out/
|
/out/
|
||||||
|
/doc/
|
||||||
*.class
|
*.class
|
5
Makefile
5
Makefile
@ -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
|
||||||
|
@ -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)
|
Loading…
Reference in New Issue
Block a user