diff options
| author | Dave Davenport <qball@gmpclient.org> | 2016-10-15 15:39:08 +0200 |
|---|---|---|
| committer | Dave Davenport <qball@gmpclient.org> | 2016-10-15 15:39:08 +0200 |
| commit | f0981d66972c07127f4bd7b54ab1b9dc7e0a91e9 (patch) | |
| tree | 1122aec0001bc61bacc917767b6377ff233ace07 /include/xcb.h | |
| parent | 9293c8b8ce5580c3be0d29366ca4287a706ee03e (diff) | |
Indenting, comments
Diffstat (limited to 'include/xcb.h')
| -rw-r--r-- | include/xcb.h | 19 |
1 files changed, 18 insertions, 1 deletions
diff --git a/include/xcb.h b/include/xcb.h index 47e235ab..7c41ad86 100644 --- a/include/xcb.h +++ b/include/xcb.h @@ -1,10 +1,27 @@ #ifndef ROFI_XCB_H #define ROFI_XCB_H +/** + * xcb data structure type declaration. + */ typedef struct _xcb_stuff xcb_stuff; +/** + * Global pointer to xcb_stuff instance. + */ extern xcb_stuff *xcb; -xcb_window_t xcb_stuff_get_root_window ( xcb_stuff *xcb ); +/** + * @param xcb the xcb data structure + * + * Get the root window. + * + * @returns the root window. + xcb_window_t xcb_stuff_get_root_window ( xcb_stuff *xcb ); + /** + * @param xcb The xcb data structure. + * + * Disconnect and free all xcb connections and references. + */ void xcb_stuff_wipe ( xcb_stuff *xcb ); #endif |