summaryrefslogtreecommitdiffstats
path: root/include
diff options
context:
space:
mode:
authorDave Davenport <qball@gmpclient.org>2017-01-01 18:40:49 +0100
committerDave Davenport <qball@gmpclient.org>2017-01-01 18:40:49 +0100
commit47aa7c4900375130cba7ab48953d28b294735b88 (patch)
tree8713ba3e35b3963dd9fdf22d47c415403354fe0a /include
parentccf3f23d9b1da3f52c269422c22c4faa4b43eb0a (diff)
Fix errors in doxygen comments
Diffstat (limited to 'include')
-rw-r--r--include/theme.h9
-rw-r--r--include/widgets/listview.h1
-rw-r--r--include/widgets/textbox.h4
-rw-r--r--include/widgets/widget-internal.h4
-rw-r--r--include/widgets/window.h1
5 files changed, 11 insertions, 8 deletions
diff --git a/include/theme.h b/include/theme.h
index 1eaf4718..af6a2f9b 100644
--- a/include/theme.h
+++ b/include/theme.h
@@ -138,7 +138,7 @@ void rofi_theme_property_free ( Property *p );
*
* Free the widget and alll children.
*/
-void rofi_theme_free ( ThemeWidget * );
+void rofi_theme_free ( ThemeWidget *wid );
/**
* @param file filename to parse.
@@ -229,11 +229,10 @@ double rofi_theme_get_double ( const char *wclass, const char *name, const char
* @param name The name class
* @param state The widget current state
* @param property The property to query.
- * @param def The default value.
+ * @param d The drawable to apply color.
*
- * Obtain the color of the widget.
+ * Obtain the color of the widget and applies this to the drawable d.
*
- * @returns The color value of this property for this widget.
*/
void rofi_theme_get_color ( const char *wclass, const char *name, const char *state, const char *property, cairo_t *d);
@@ -242,7 +241,7 @@ void rofi_theme_get_color ( const char *wclass, const char *name, const char *s
* @param name The name class
* @param state The widget current state
* @param property The property to query.
- * @param def The default value.
+ * @param pad The default value.
*
* Obtain the padding of the widget.
*
diff --git a/include/widgets/listview.h b/include/widgets/listview.h
index cdefaa51..b008a28d 100644
--- a/include/widgets/listview.h
+++ b/include/widgets/listview.h
@@ -42,6 +42,7 @@ typedef void ( *listview_update_callback )( textbox *tb, unsigned int entry, voi
typedef void ( *listview_mouse_activated_cb )( listview *, xcb_button_press_event_t *, void * );
/**
+ * @param name The name of the to be created widget.
* @param cb The update callback.
* @param udata The user data to pass to the callback
* @param eh The height of one element
diff --git a/include/widgets/textbox.h b/include/widgets/textbox.h
index 1b6a4152..536bd30e 100644
--- a/include/widgets/textbox.h
+++ b/include/widgets/textbox.h
@@ -86,6 +86,7 @@ typedef enum
} TextBoxFontType;
/**
+ * @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.
* @param text intial text to display.
@@ -227,7 +228,10 @@ void textbox_moveresize ( textbox *tb, int x, int y, int w, int h );
/**
* @param tb Handle to the textbox
+ * @param eh The number of rows to display
+ *
* Get the (estimated) with of a character, can be used to calculate window width.
+ * This includes padding.
*
* @returns the estimated width of a character.
*/
diff --git a/include/widgets/widget-internal.h b/include/widgets/widget-internal.h
index 5151c8b1..fdc45823 100644
--- a/include/widgets/widget-internal.h
+++ b/include/widgets/widget-internal.h
@@ -60,9 +60,9 @@ struct _widget
/**
* @param widget The widget to initialize.
* @param name The name of the widget.
- * @param class The class of the widget.
+ * @param class_name The name of the class of the widget.
*
- * Initializes the @widget structure.
+ * Initializes the widget structure.
*
*/
void widget_init ( widget *widget , const char *name, const char *class_name );
diff --git a/include/widgets/window.h b/include/widgets/window.h
index 3c320d10..cd943ff0 100644
--- a/include/widgets/window.h
+++ b/include/widgets/window.h
@@ -18,7 +18,6 @@ typedef struct _window window;
/**
* @param name The name of the widget.
- * @param type The packing direction of the newly created window.
*
* @returns a newly created window, free with #widget_free
*/