summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAdam NAILI2017-12-06 21:02:50 +0100
committerAdam NAILI2017-12-06 21:02:50 +0100
commit68672a10cc01c5f0c50aaa5779eab8af33046f43 (patch)
treea0921ed75e74150fae8d2888c83a5313e2db929f
parent0a52cd20ba690303958c29e94ef526442789effa (diff)
downloadmorpher-68672a10cc01c5f0c50aaa5779eab8af33046f43.tar.gz
Update doc on button.h
-rw-r--r--include/gui/button.h20
1 files changed, 20 insertions, 0 deletions
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 @@
3 3
4/** 4/**
5 * File: button.h 5 * File: button.h
6 * Buttons handling
6 */ 7 */
7 8
9/**
10 * Type: Button
11 * Component that can be triggered by click to execute a specific action.
12 */
8typedef struct { 13typedef struct {
9 Component component; 14 Component component;
10} Button; 15} Button;
11 16
17/**
18 * Function: button_init
19 * Initializes the button.
20 *
21 * Parameters:
22 * *button - pointer to the input button
23 * text - label for the button
24 */
12void button_init(Button *button, char *text); 25void button_init(Button *button, char *text);
13 26
27/**
28 * Function: button_free
29 * Frees the resources for the button.
30 *
31 * Parameters:
32 * *button - pointer to the input button
33 */
14void button_free(Button *button); 34void button_free(Button *button);
15 35
16#endif 36#endif