Update report

7 files changed, 213 insertions, 145 deletions

diff --git a/report/document.tex b/report/document.tex
index c3ec4d1..405cb08 100644
--- a/report/document.tex
+++ b/report/document.tex
@@ -16,6 +16,8 @@
 
 \input{style/pascience-listings}
 
+\usepackage{hyperref}
+
 
 %%%%%%%%%%%%%%%%%%%%
 %% DOCUMENT
@@ -41,10 +43,6 @@
 
 \cleardoublepage
 
-\input{organization}
-
-\cleardoublepage
-
 \input{packages}
 
 \cleardoublepage
@@ -61,10 +59,10 @@
 \end{appendices}
 
 
-\cleardoublepage
+%\cleardoublepage
 
-\bibliographystyle{unsrt}
-\bibliography{bibliography}
+%\bibliographystyle{unsrt}
+%\bibliography{bibliography}
 
 
 \end{document}
\ No newline at end of file
diff --git a/report/organization.tex b/report/organization.tex
deleted file mode 100644
index 4ca7bc6..0000000
--- a/report/organization.tex
+++ /dev/null
@@ -1,5 +0,0 @@
-\chapter{Work organization}
-
-\section{Schedule}
-
-\section{Task assignments}
diff --git a/report/packages.tex b/report/packages.tex
index dde1d0b..e8bec09 100644
--- a/report/packages.tex
+++ b/report/packages.tex
@@ -5,23 +5,34 @@ were used in this project.
 
 \section{StretchIcon}
 
-StretchIcon enables the resize of the Room illustration according to the
+StretchIcon enabled the resize of the Room illustration according to the
 window's size in the rich Swing GUI, keeping a correct ratio.
 
-\section{Guava}
 
+\section{Guava}
 
-\section{Intrinsic Map}
+Guava, from Google, contains several collections, caching, primitives support,
+concurrency, annotations and string processing utilities.
 
 
+\section{Lombok}
 
-\section{Google Web Toolkit}
+Lombok helped avoiding writing dozens of getters and setters by replacing them
+with shorter annotations.
 
 
+\section{Intrinsic Map}
 
+As Items were already containing there names in a field, HashMap<String, Item>
+were redundant. IntrinsicMap<Item> and the Mappable interface were created to
+avoid this redundance.
 
 
+\section{Google Web Toolkit}
 
+The Google Web Toolkit was used to create the web version of the game.
+It permitted the compilation of Java sources to Javascript code executable
+directly inside a web browser, without requiring the Java Virtual Machine.
 
 
 \section{JSON Simple}
diff --git a/report/progression.tex b/report/progression.tex
index cca0477..cd3f4ec 100644
--- a/report/progression.tex
+++ b/report/progression.tex
@@ -4,48 +4,48 @@
 
 \subsection{printLocationInfo}
 
-e52a34789 - This code duplication has been previously avoided with the
+e52a34789 - Pacien - This code duplication has been previously avoided with the
 printRoomInfo() method.
 It has been renamed to printLocationInfo() to match the exercise.
 
 \subsection{getExit}
 
-53c427ff3 - The exit attributes have been made private and a getter has been
-added.
+53c427ff3 - Pacien - The exit attributes have been made private and a getter has
+been added.
 A switch statement has been used instead of multiple if statements.
 
 \subsection{getExitString}
 
-ca65af2e2 - This method, which returns a String containing the informations
-about the Room's exits, has been added.
+ca65af2e2 - Pacien - This method, which returns a String containing the
+informations about the Room's exits, has been added.
 
 \subsection{HashMap, setExit}
 
-c9d890b9b - Room exits are now stored in an HashMap. The setExits() method has
-been replaced by setExit() which takes advantages of the HashMap.
+c9d890b9b - Pacien - Room exits are now stored in an HashMap. The setExits()
+method has been replaced by setExit() which takes advantages of the HashMap.
 
 \subsection{Vertical direction}
 
-4145a5e8c - The getExitString() method has been modified to be able to
+4145a5e8c - Pacien - The getExitString() method has been modified to be able to
 print the availability of the new exits, used in the stairwell at wing 3. Due
 to the architecture of these rooms, the side exits that were previously settled
 to link them have been kept.
 
 \subsection{keySet ?}
 
-The keySet() method of the class HashMap returns a Set of the keys
+Benoît - The keySet() method of the class HashMap returns a Set of the keys
 associated to values stored in the Map.
 
 \subsection{getExitString ?}
 
-The getExitString() method returns a String listing the Room's exits.
+Benoît - The getExitString() method returns a String listing the Room's exits.
 To achieve that, it iterates through the exits Map's keys, which is a Set of
 String-s, appending each one to the String that it returns.
 
 \subsection{getLongDescription}
 
-e510b08d0 - The Room class now uses the previously explained getExitString()
-method and includes the getLongDescription() method that returns the full description of
+e510b08d0 - Pacien - The Room class now uses the previously explained
+getExitString() method and includes the getLongDescription() method that returns the full description of
 the room.
 
 
@@ -53,12 +53,13 @@ the room.
 
 \subsection{look}
 
-698e3cd25 - The look command, which prints informations about the current Room,
-has been added.
+698e3cd25 - Benoît - The look command, which prints informations about the
+current Room, has been added.
 
 \subsection{eat}
 
-40b9b4816 - The eat command, that just prints a special message, has been added.
+40b9b4816 - Benoît - The eat command, that just prints a special message, has
+been added.
 This command has then been deleted later in the development since it was
 useless in the scenario.
 
@@ -66,77 +67,79 @@ useless in the scenario.
 
 \subsection{showAll, showCommands}
 
-79d33230b - Theses methods have been implemented.
+79d33230b - Pacien - Theses methods have been implemented.
 
 \subsection{Adding commands}
 
-Adding new commands would not require modifying the printHelp() method anymore.
+Benoît - Adding new commands would not require modifying the printHelp() method
+anymore.
 However, adding new commands and related functions would still require editing
 the Game class and its processCommand() method.
 
 \subsection{getCommandList}
 
-5f1d0ada2 - The command list is not printed in the CommandWords class anymore.
+5f1d0ada2 - Benoît - The command list is not printed in the CommandWords class
+anymore.
 Instead, this class returns a String, forwarded by the Parser class, that is
 then printed in the Game class.
 
 \subsection{Comparison with reference}
 
-590a932e5 - The printLocationInfo() method, used only twice, has been trimmed
-and has been replaced by a call to the getLongDescription() method of the Room
+590a932e5 - Pacien - The printLocationInfo() method, used only twice, has been
+trimmed and has been replaced by a call to the getLongDescription() method of the Room
 class.
 
-f84606424 - A missing getter for the Room description has been added.
+f84606424 - Benoît - A missing getter for the Room description has been added.
 
-0c5793abf - The loop building the command list String has been modified to use
-an Iterator.
+0c5793abf - Benoît - The loop building the command list String has been modified
+to use an Iterator.
 
 \subsection{StringBuilder}