From 68672a10cc01c5f0c50aaa5779eab8af33046f43 Mon Sep 17 00:00:00 2001 From: Adam NAILI Date: Wed, 6 Dec 2017 21:02:50 +0100 Subject: Update doc on button.h --- include/gui/button.h | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/include/gui/button.h b/include/gui/button.h index 62f75a3..4d3bfe5 100644 --- a/include/gui/button.h +++ b/include/gui/button.h @@ -3,14 +3,34 @@ /** * File: button.h + * Buttons handling */ +/** + * Type: Button + * Component that can be triggered by click to execute a specific action. + */ typedef struct { Component component; } Button; +/** + * Function: button_init + * Initializes the button. + * + * Parameters: + * *button - pointer to the input button + * text - label for the button + */ void button_init(Button *button, char *text); +/** + * Function: button_free + * Frees the resources for the button. + * + * Parameters: + * *button - pointer to the input button + */ void button_free(Button *button); #endif -- cgit v1.2.3