1
0
Fork 0
mirror of https://github.com/davatorium/rofi.git synced 2024-11-25 13:55:34 -05:00

Fix errors in doxygen comments

This commit is contained in:
Dave Davenport 2017-01-01 18:40:49 +01:00
parent ccf3f23d9b
commit 47aa7c4900
6 changed files with 12 additions and 8 deletions

View file

@ -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.
*

View file

@ -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

View file

@ -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.
*/

View file

@ -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 );

View file

@ -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
*/

View file

@ -66,6 +66,7 @@
#include "xcb.h"
/**
* @param state The handle to the view
* @param qr Indicate if queue_redraw should be called on changes.
*
* Update the state of the view. This involves filter state.
*/