Updating documentation, cleaning includes, updating report

5 files changed, 189 insertions, 81 deletions

diff --git a/include/gui/button.h b/include/gui/button.h
index 41008c1..b5908cb 100644
--- a/include/gui/button.h
+++ b/include/gui/button.h
@@ -5,7 +5,6 @@
  * Buttons handling
  */
 
-#include <stdbool.h>
 #include "component.h"
 
 /**
@@ -24,67 +23,108 @@ typedef struct {
 } Button;
 
 /**
- * Function: button_init
- * Initializes the button.
+ * Function: button_create
+ * Allocates and initializes the button.
  *
  * Parameters:
- *  *button - pointer to the input button
  *  text - label for the button
  *  sizeInterligne - parameter to initialize padding inside the button
  *  x_pos - position of the button on x axis
  *  y_pos - position of the button on y axis
  *  clickHandler - pointer of function that will be loaded inside our button to perform its purpose
+ *
+ * Returns:
+ *  A pointer of Button
  */
-void button_init(Button *button, const char *text, int sizeInterligne, int x_pos, int y_pos, ClickHandler clickHandler);
+Button *
+button_create(const char *text, int sizeInterligne, int x_pos, int y_pos, ClickHandler clickHandler);
 
 /**
- * Function: button_print
- * Prints the button.
+ * Function: button_destroy
+ * Frees the resources for the Button
  *
  * Parameters:
- *  *parameterSelf - pointer to the button
+ *  *button - pointer to the button
  */
-void button_print(Component *parameterSelf);
+void button_destroy(Button *button);
 
 /**
- * Function: button_click_test
- * Debug function to test if the click is working on the current button.
+ * Function: button_click_add_constraint
+ * Allows to add a constraint point in order on the first picture, then on the second.
  *
  * Parameters:
  *  x - position of the click on x axis
  *  y - position of the click on y axis
  *  *parameterSelf - pointer on the button that is clicked
  */
-void button_click_test(int x, int y, Component *parameterSelf);
-
 void button_click_add_constraint(int x, int y, Component *parameterSelf);
 
+/**
+ * Function: button_click_show_hide
+ * Allows to show and hide the constraint points and triangles.
+ *
+ * Parameters:
+ *  x - position of the click on x axis
+ *  y - position of the click on y axis
+ *  *parameterSelf - pointer on the button that is clicked
+ */
 void button_click_show_hide(int x, int y, Component *parameterSelf);
 
+/**
+ * Function: button_click_exit
+ * Quit the program.
+ *
+ * Parameters:
+ *  x - position of the click on x axis
+ *  y - position of the click on y axis
+ *  *parameterSelf - pointer on the button that is clicked.
+ */
 void button_click_exit(int x, int y, Component *parameterSelf);
 
+/**
+ * Function: button_click_none
+ * Allows the button to do nothing on click.
+ *
+ * Parameters:
+ *  x - position of the click on x axis
+ *  y - position of the click on y axis
+ *  *parameterSelf - pointer on the button that is clicked
+ */
 void button_click_none(int x, int y, Component *parameterSelf);
 
+
+/**
+ * Function: button_click_more_frame
+ * Multiplies by two the number of frames to create when rendering.
+ *
+ * Parameters:
+ *  x - position of the click on x axis
+ *  y - position of the click on y axis
+ *  *parameterSelf - pointer on the button that is clicked
+ */
 void button_click_more_frame(int x, int y, Component *parameterSelf);
 
+/**
+ * Function: button_click_less_frame
+ * Divides by two the number of frames to create when rendering.
+ *
+ * Parameters:
+ *  x - position of the click on x axis
+ *  y - position of the click on y axis
+ *  *parameterSelf - pointer on the button that is clicked
+ */
 void button_click_less_frame(int x, int y, Component *parameterSelf);
 
-void button_click_rendering(int x, int y, Component *parameterSelf);
-
-
 /**
- * Function: button_is_selected
- * Checks if the button is selected or not.
+ * Function: button_click_rendering
+ * Launches the rendering of the morphing
  *
  * Parameters:
- *  x - position in x for the check
- *  y - position in y for the check
- *  *button - pointer to the current button
- *
- * Returns:
- *  A bool from stdbool
+ *  x - position of the click on x axis
+ *  y - position of the click on y axis
+ *  *parameterSelf - pointer on the button that is clicked
  */
+void button_click_rendering(int x, int y, Component *parameterSelf);
 
-bool button_is_selected(int x, int y, Button *button);
 
 #endif
diff --git a/include/gui/component.h b/include/gui/component.h
index 0275d45..9700dfe 100644
--- a/include/gui/component.h
+++ b/include/gui/component.h
@@ -1,5 +1,18 @@
 #ifndef UPEM_C_COMPONENT_H
 #define UPEM_C_COMPONENT_H
+
+/**
+ * Enum: Mode
+ *
+ * WAITING_BUTTON_SHOW - Waits a click on buttons to perform actions and paints the constraint points on the GUI
+ * WAITING_BUTTON_HIDE - Waits a click on buttons to perform actions and does not print the constraint points on the GUI
+ * INSERT_ORIGIN - Waits a click on the origin pictureframe and lock other components
+ * INSERT_TARGET - Waits a click on the target pictureframe and lock other components
+ * PRINTING - Force the application to paint the pictureframes
+ * EXITING - Exits the programme
+ * PRINTING_BUTTONS - paints the buttons
+ * RENDERING - launches the rendering mode
+ */
 typedef enum {
   WAITING_BUTTON_SHOW, WAITING_BUTTON_HIDE, INSERT_ORIGIN, INSERT_TARGET, PRINTING, EXITING, PRINTING_BUTTONS, RENDERING
 } Mode;
diff --git a/include/gui/gui.h b/include/gui/gui.h
index daaf8de..10f59e8 100644
--- a/include/gui/gui.h
+++ b/include/gui/gui.h
@@ -1,11 +1,32 @@
 #ifndef UPEM_MORPHING_GUI
 #define UPEM_MORPHING_GUI
 
-#include <gui/window.h>
+#include "gui/window.h"
+
 /**
  * File: gui.h
  */
 
+
+/**
+ * Struct: GUI
+ * Supports all the parts of the GUI
+ *
+ * Fields:
+ *  *window - pointer to the Window
+ *  *button1 - pointer to the button 1
+ *  *button2 - pointer to the button 2
+ *  *button3 - pointer to the button 3
+ *  *button4 - pointer to the button 4
+ *  *button5 - pointer to the button 5
+ *  *button6 - pointer to the button 6
+ *  *button7 - pointer to the button 7
+ *  *pictureFrame1 - pointer to the picture frame 1
+ *  *pictureFrame2 - pointer to the picture frame 2
+ *  *canvasSrc - pointer to the canvas 1
+ *  *canvasTrg - pointer to the canvas 2
+ *  *morphing - pointer to the current morphing
+ */
 typedef struct {
   Window *window;
   Button *button1;
@@ -20,20 +41,36 @@ typedef struct {
   Canvas *canvasSrc;
   Canvas *canvasTrg;
   Morphing *morphing;
-  MLV_Keyboard_button keyboardButton;
-  MLV_Keyboard_modifier keyboardModifier;
-  int unicode;
-  int mouse_x;
-  int mouse_y;
 } GUI;
 
+/**
+ * Function: gui_create
+ *
+ *