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

3 files changed, 16 insertions, 7 deletions

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