Merge branch 'master' of https://git-etud.u-pem.fr/upem-c-morphing

Signed-off-by: pacien <pacien.trangirard@pacien.net>

# Conflicts:
#	include/gui/component.h
#	include/gui/gui.h
#	include/gui/pictureframe.h

4 files changed, 21 insertions, 11 deletions

diff --git a/doc/project-report.md b/doc/project-report.md
index 376eda4..f9a95ef 100644
--- a/doc/project-report.md
+++ b/doc/project-report.md
@@ -131,18 +131,19 @@ RBGa vectors from the two base images: each component is square-rooted back to i
 ### GUI
 
 The Graphical User Interface is designed with a modular component-based architecture. That architecture implies an
-Object-Oriented Programming's vision. Thanks to that, the application is very flexible for adding components and
+Object-Oriented Programming's vision that makes the application very flexible for adding components and
 placing them. The components created are groups, buttons, and picture frames that are all based on a common structure
 called Component. Groups federate Components of any type and place them by a margin management.
 
-Thanks to a click handler and a printing function stored inside Components, it is possible to perform the actions on 
+Click handlers and printing functions stored inside Components make possible to perform the actions on 
 click or to paint the component without knowing what is stored inside the group. The group is a component that handles 
 clicks and is able to paint itself by using the click handler and the painter function of the Component contained inside
-its list.  In other words, it delegates to the Components the action to perform. 
+its list. In other words, it delegates to the Components the action to perform. 
 
 It also wraps some libMLV low level functions to create basic application features that can be used to create coherent 
 state for the application and components. The rendering process is done by computing intermediate morphing between each 
-frame combined with a time. By this implementation, the application is not using MLV_Animation.
+frame combined with a time. This implementation replaces the usage of MLV_Animation which implies higher memory usage 
+and lower fluidity due to the needed pre-calculation.
 
 \newpage
 
diff --git a/include/gui/component.h b/include/gui/component.h
index 895e9ba..1a255e2 100644
--- a/include/gui/component.h
+++ b/include/gui/component.h
@@ -3,6 +3,7 @@
 
 /**
  * File: component.h
+ * Components implementation.
  *
  * Author:
  *   Adam NAILI
@@ -24,16 +25,22 @@ typedef enum {
   WAITING_BUTTON_SHOW, WAITING_BUTTON_HIDE, INSERT_ORIGIN, INSERT_TARGET, PRINTING, EXITING, PRINTING_BUTTONS, RENDERING
 } Mode;
 
+/**
+ * Mode is used for application status rotation. It is shared between our components. In OOP, this could have been a
+ * static attribute of the class.
+ **/
 extern Mode mode;
-extern int frame;
-extern char labelFrame[20];
+
 /**
- * File: component.h
- * Windows and components handling.
- *
- * See also:
- *  The famous OS
+ * Components have no access to exterior. They can access only to themselves due to the generic implementation. These
+ * variables are the easiest way to share memory between components.
+ * frame and labelFrame is used to frame management and printing this number of frame on one of the button. Button are
+ * not designed to have a dynamic label, so this implementation is the fastest without breaking the code or creating
+ * another type of components.
  */
+extern int frame;
+extern char labelFrame[20];
+
 struct Component;
 
 /**
diff --git a/include/gui/gui.h b/include/gui/gui.h
index a8b7bd0..1e205ce 100644
--- a/include/gui/gui.h
+++ b/include/gui/gui.h
@@ -3,6 +3,7 @@
 
 /**
  * File: gui.h
+ * Graphical user interface handling
  *
  * Author:
  *   Adam NAILI
diff --git a/include/gui/pictureframe.h b/include/gui/pictureframe.h
index 0432b1c..11eaf90 100644
--- a/include/gui/pictureframe.h
+++ b/include/gui/pictureframe.h
@@ -3,6 +3,7 @@
 
 /**
  * File: pictureframe.h
+ * Pictures handling.
  *
  * Author:
  *   Adam NAILI