From: Johan Malm <jgm323@gmail.com>
Date: Fri, 7 Aug 2020 19:21:14 +0000 (+0100)
Subject: include/: tidy up header files
X-Git-Url: https://git.mdlowis.com/?a=commitdiff_plain;h=649437e33660a0aa15851d7bf0a8bc16595b7f67;p=proto%2Flabwc.git

include/: tidy up header files
---

diff --git a/include/common/buf.h b/include/common/buf.h
index f732bb5f..98be625d 100644
--- a/include/common/buf.h
+++ b/include/common/buf.h
@@ -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
diff --git a/include/common/bug-on.h b/include/common/bug-on.h
index aa5f7f3f..1b25c803 100644
--- a/include/common/bug-on.h
+++ b/include/common/bug-on.h
@@ -1,7 +1,7 @@
 #ifndef __LABWC_BUG_ON_H
 #define __LABWC_BUG_ON_H
 
-/*
+/**
  * BUG_ON - assert() without abort()
  * @condition - expression to be evaluated
  */
diff --git a/include/common/font.h b/include/common/font.h
index 04f99f09..9832c667 100644
--- a/include/common/font.h
+++ b/include/common/font.h
@@ -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'
  */
diff --git a/include/config/keybind.h b/include/config/keybind.h
index ce57caf7..8742ca48 100644
--- a/include/config/keybind.h
+++ b/include/config/keybind.h
@@ -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 */
diff --git a/include/labwc.h b/include/labwc.h
index c3a3a615..e5ebb1e0 100644
--- a/include/labwc.h
+++ b/include/labwc.h
@@ -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);
diff --git a/include/theme/theme-dir.h b/include/theme/theme-dir.h
index 9ebb09af..310e6077 100644
--- a/include/theme/theme-dir.h
+++ b/include/theme/theme-dir.h
@@ -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 */
diff --git a/include/theme/theme.h b/include/theme/theme.h
index 6833c079..1478624e 100644
--- a/include/theme/theme.h
+++ b/include/theme/theme.h
@@ -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 */