summaryrefslogtreecommitdiffstats
path: root/include/widgets
diff options
context:
space:
mode:
authorQuentin Glidic <sardemff7+git@sardemff7.net>2017-05-30 14:15:13 +0200
committerQuentin Glidic <sardemff7+git@sardemff7.net>2017-05-30 14:15:13 +0200
commit4fbf1b7075670d91ca3a0ba88dd3ea0bd9dba2f0 (patch)
tree1de0ce4f16ca2e77e3ba53ce9bb9ec5efa6113e6 /include/widgets
parent4891bcd7ebe88959e9a3fbe63c1cf13a99290a08 (diff)
widgets: Fix doc
Signed-off-by: Quentin Glidic <sardemff7+git@sardemff7.net>
Diffstat (limited to 'include/widgets')
-rw-r--r--include/widgets/textbox.h1
-rw-r--r--include/widgets/widget-internal.h1
-rw-r--r--include/widgets/widget.h20
3 files changed, 13 insertions, 9 deletions
diff --git a/include/widgets/textbox.h b/include/widgets/textbox.h
index 2209de29..d2d56095 100644
--- a/include/widgets/textbox.h
+++ b/include/widgets/textbox.h
@@ -110,6 +110,7 @@ typedef enum
} TextBoxFontType;
/**
+ * @param type The type of the to be created widget.
* @param name The name of the to be created widget.
* @param flags #TextboxFlags indicating the type of textbox.
* @param tbft #TextBoxFontType current state of textbox.
diff --git a/include/widgets/widget-internal.h b/include/widgets/widget-internal.h
index 0addb2b5..b2b2d3ea 100644
--- a/include/widgets/widget-internal.h
+++ b/include/widgets/widget-internal.h
@@ -99,6 +99,7 @@ struct _widget
/**
* @param widget The widget to initialize.
+ * @param type The type of the widget.
* @param name The name of the widget.
*
* Initializes the widget structure.
diff --git a/include/widgets/widget.h b/include/widgets/widget.h
index bcc45e1d..e7da9f73 100644
--- a/include/widgets/widget.h
+++ b/include/widgets/widget.h
@@ -87,8 +87,8 @@ typedef enum
/**
* @param widget The container widget itself
* @param type The widget type searched for
- * @param x The X coordination of the mouse event relative to @widget
- * @param y The Y coordination of the mouse event relative to @widget
+ * @param x The X coordination of the mouse event relative to @param widget
+ * @param y The Y coordination of the mouse event relative to @param widget
*
* This callback must only iterate over the children of a Widget, and return NULL if none of them is relevant.
*
@@ -99,8 +99,8 @@ typedef widget * ( *widget_find_mouse_target_cb )( widget *widget, WidgetType ty
/**
* @param widget The target widget
* @param action The action value (which enum it is depends on the widget type)
- * @param x The X coordination of the mouse event relative to @widget
- * @param y The Y coordination of the mouse event relative to @widget
+ * @param x The X coordination of the mouse event relative to @param widget
+ * @param y The Y coordination of the mouse event relative to @param widget
* @param user_data The data passed to widget_set_trigger_action_handler()
*
* This callback should handle the action if relevant, and returns whether it did or not.
@@ -217,7 +217,7 @@ int widget_get_x_pos ( widget *widget );
* @param x A pointer to the absolute X coordinates
* @param y A pointer to the absolute Y coordinates
*
- * Will modify @x and @y to make them relative to @widget.
+ * Will modify @param x and @param y to make them relative to @param widget .
*/
void widget_xy_to_relative ( widget *widget, gint *x, gint *y );
@@ -244,6 +244,7 @@ gboolean widget_need_redraw ( widget *wid );
/**
* @param wid The widget handle
+ * @param type The type of the wanted widget
* @param x The x coordinate of the mouse event
* @param y The y coordinate of the mouse event
*
@@ -260,7 +261,7 @@ widget *widget_find_mouse_target ( widget *wid, WidgetType type, gint x, gint y
* @param y A pointer to the y coordinate of the click
*
* Trigger an action on widget.
- * @x and @y are relative to the widget.
+ * @param x and @param y are relative to @param wid .
*
* @returns Whether the action was handled or not
*/
@@ -277,11 +278,12 @@ void widget_set_trigger_action_handler ( widget *wid, widget_trigger_action_cb c
/**
* @param wid The widget handle
- * @param xme The motion notify object.
+ * @param x The x coordinate of the mouse event
+ * @param y The y coordinate of the mouse event
*
* Motion notify.
- * TODO make this like clicked with callback.
- * returns TRUE when handled.
+ *
+ * @returns TRUE when handled.
*/
gboolean widget_motion_notify ( widget *wid, gint x, gint y );