include/: tidy up header files

This commit is contained in:
Johan Malm 2020-08-07 20:21:14 +01:00
parent 2d6921039d
commit 649437e336
7 changed files with 17 additions and 5 deletions

View file

@ -17,14 +17,14 @@ struct buf {
int len;
};
/*
/**
* buf_init - allocate NULL-terminated C string buffer
* @s - buffer
* Note: use free(s->buf) to free it.
*/
void buf_init(struct buf *s);
/*
/**
* buf_add - add data to C string buffer
* @s - buffer
* @data - data to be added

View file

@ -1,7 +1,7 @@
#ifndef __LABWC_BUG_ON_H
#define __LABWC_BUG_ON_H
/*
/**
* BUG_ON - assert() without abort()
* @condition - expression to be evaluated
*/

View file

@ -1,7 +1,7 @@
#ifndef __LABWC_FONT_H
#define __LABWC_FONT_H
/*
/**
* font_height - get font vertical extents
* @font_description: string describing font, for example 'sans 10'
*/

View file

@ -13,6 +13,10 @@ struct keybind {
struct wl_list link;
};
/**
* keybind_add - parse keybind and add to linked list
* @keybind: key combination
*/
struct keybind *keybind_add(const char *keybind);
#endif /* __LABWC_KEYBIND_H */

View file

@ -149,7 +149,6 @@ void view_init_position(struct view *view);
struct wlr_box view_get_surface_geometry(struct view *view);
struct wlr_box view_geometry(struct view *view);
void view_resize(struct view *view, struct wlr_box geo);
bool view_want_deco(struct view *view);
void view_focus(struct view *view);
struct view *view_front_toplevel(struct server *server);
struct view *next_toplevel(struct view *current);

View file

@ -1,6 +1,10 @@
#ifndef __LABWC_THEME_DIR_H
#define __LABWC_THEME_DIR_H
/**
* theme_dir - find theme directory containing theme @theme_name
* @theme_name: theme to search for
*/
char *theme_dir(const char *theme_name);
#endif /* __LABWC_THEME_DIR_H */

View file

@ -21,6 +21,11 @@ struct theme {
extern struct theme theme;
/**
* theme_read - read theme into global theme struct
* @theme_name: theme-name in <theme-dir>/<theme-name>/openbox-3/themerc
* Note <theme-dir> is obtained in theme-dir.c
*/
void theme_read(const char *theme_name);
#endif /* __LABWC_THEME_H */