summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorYong Bakos <ybakos@humanoriented.com>2016-12-06 07:21:56 -0800
committerDaniel Stone <daniels@collabora.com>2016-12-10 00:37:02 +0000
commit721e0b4a9783a965dcb7f926ff595755219351f5 (patch)
tree8cf29206deca08ded3d310bd4eaec4d4e1b5d136
parentdeb370cc8f834aa93c294b70f2e944dafd692031 (diff)
util: Document wl_array and wl_list members
Despite their clear names, wl_array and wl_list members are undocumented, resulting in doxygen warnings[1] when building documentation. Document these members, suppressing the warnings. [1] Warnings are visible when EXTRACT_ALL = NO. Signed-off-by: Yong Bakos <ybakos@humanoriented.com> Reviewed-by: Daniel Stone <daniels@collabora.com>
-rw-r--r--src/wayland-util.h5
1 files changed, 5 insertions, 0 deletions
diff --git a/src/wayland-util.h b/src/wayland-util.h
index f0a4508..caeac82 100644
--- a/src/wayland-util.h
+++ b/src/wayland-util.h
@@ -261,7 +261,9 @@ struct wl_interface {
* \sa http://git.kernel.org/cgit/linux/kernel/git/torvalds/linux.git/tree/include/linux/list.h
*/
struct wl_list {
+ /** Previous list element */
struct wl_list *prev;
+ /** Next list element */
struct wl_list *next;
};
@@ -490,8 +492,11 @@ wl_list_insert_list(struct wl_list *list, struct wl_list *other);
*
*/
struct wl_array {
+ /** Array size */
size_t size;
+ /** Allocated space */
size_t alloc;
+ /** Array data */
void *data;
};