Updating documentation, cleaning includes, updating report

1 files changed, 65 insertions, 25 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