From 82c3a91ebd2e13cf259cbb9a68c6d6183b06b604 Mon Sep 17 00:00:00 2001
From: piernov <piernov@piernov.org>
Date: Tue, 10 May 2016 23:09:02 +0200
Subject: Update Rapport final

---
 doc/Rapport final.tex | 20 +++++++++++++++++---
 1 file changed, 17 insertions(+), 3 deletions(-)

(limited to 'doc/Rapport final.tex')

diff --git a/doc/Rapport final.tex b/doc/Rapport final.tex
index 2163892..66d7d7b 100644
--- a/doc/Rapport final.tex	
+++ b/doc/Rapport final.tex	
@@ -80,8 +80,17 @@ Le site web a été nommé CraftMine, et est disponible à l'adresse \url{https:
   Développée en majorité comme prévu. C'est principalement un travail de recherche pour comprendre comment structuer correctement le code HTML de manière à ce que la bibliothèque CSS Bootstrap applique correctement les styles.
   
 \subsection{Ce qui n'a pas été fait}
-  Utilisation des objets du magasin.
-  Empêcher le joueur de récupérer l'or de la mine lorqsu'il est dans le donjon
+Et qui sera peut être fait plus tard:
+\begin{itemize}
+  \item Ajouter des objets
+  \item Ajuster les coûts des objets et les statistiques des personnages.
+  \item Rédiger de la documentation complète.
+  \item Quelques bugs sur la gestion des objets.
+  \item Utiliser des icônes plus jolies (en SVG).
+  \item Choix et nombre aléatoire des monstres dans le donjon.
+  \item Et plus encore...
+\end{itemize}
+
   
 \section{Répartition du travail}
   Les fonctionnalités liées à la mine et à l'enregistrement/chargement de la partie ainsi que l'interface utilisateur ont été développées par Pierre-Emmanuel, qui avait aussi entamé le développement du magasin.\\
@@ -89,7 +98,7 @@ Le site web a été nommé CraftMine, et est disponible à l'adresse \url{https:
   Le développement s'est fait grâce à l'outil Git, dont le dépôt est consultable à l'adresse \url{http://git.piernov.org/candybox/}. Alexandre a développé les fonctionnalités qui lui avaient été attribuées sur sa branche alexichi, tandis que Pierre-Emmanuel développer les différentes fonctionnalités en parallèle sur sa branche et les branches feat/ correspondantes. Il s'occupait aussi de la fusion des branches pour mettre en commun sur la branche master le code développé séparément.
   
 \section{Organisation du code}
-  Les fonctions développées en PHP sont généralement concises et découpées de manière logique. En Javascript en revanche, du fait de la génération de code HTML, des traitement plus lourds et des fonctions moins intuitives, le code est moins clair et plus long.
+  Les fonctions développées en PHP sont généralement concises et découpées de manière logique. En Javascript en revanche, du fait de la génération de code HTML, des traitements plus lourds et des fonctions moins intuitives, le code est moins clair et plus long.
   
   \subsection{Javascript}
   Les différentes fonctions Javascript viennent modifier et compléter le contenu de la page dynamiquement. Les scripts ont été séparés dans différents fichiers correspondant chacun à un aspect de l'application. Ainsi les fichiers suivant ont été créés:
@@ -163,6 +172,11 @@ La liste des objets du magasin au format XML.
 \subsubsection{data/monsters.xml}
 La liste des monstres du donjon au format XML.
 
+\subsection{Documentation}
+\paragraph{phpDocumentor} Le code source PHP a été commenté à l'aide de la syntaxe PHPDoc, et une documentation au format HTML a été générée (dans le répertoire doc/phpdoc).
+
+\paragraph{JSDoc} Nous aurions aimé utiliser JSDoc, à l'image de PHPDoc, pour documenter le code Javascript, mais par manque de temps cela n'a pas été fait.
+
 \section{Choix techniques}
 \subsection{Javascript}
 Nous avons utilisé des fonctionnalités plutôt récentes en Javascript comme l'objet classList pour ajouter/supprimer une classe en Javascript, utilisé dans notre cas pour changer l'apparence de l'onglet actif. XMLHttpRequest2 a aussi été utilisé pour le téléversement des fichiers de sauvegarde. De ce fait, les navigateurs ancien ou avec une prise en charge limitée du Javascript ne pourront pas faire fonctionner correctement le site web. Ces navigateurs sont entre autres Internet Explorer version 9 et antérieures, ou Opera Mini. Le site web a été développé sous Firefox, et testé sous Chromium.\\
-- 
cgit v1.2.3-70-g09d2

