mirrors/wayland
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/wayland/wayland.git synced 2026-04-16 08:21:35 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

util: Document wl_array and wl_list members

Browse source 
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>
This commit is contained in:
Yong Bakos 2016-12-06 07:21:56 -08:00 • committed by Daniel Stone
parent deb370cc8f
commit 721e0b4a97
1 changed files with 5 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

5
src/wayland-util.h
View file

@ -261,7 +261,9 @@ struct wl_interface {
* \sa http://git.kernel.org/cgit/linux/kernel/git/torvalds/linux.git/tree/include/linux/list.h * \sa http://git.kernel.org/cgit/linux/kernel/git/torvalds/linux.git/tree/include/linux/list.h
*/ */
struct wl_list { struct wl_list {
/** Previous list element */
struct wl_list *prev; struct wl_list *prev;
/** Next list element */
struct wl_list *next; struct wl_list *next;
}; };
@ -490,8 +492,11 @@ wl_list_insert_list(struct wl_list *list, struct wl_list *other);
* *
*/ */
struct wl_array { struct wl_array {
/** Array size */
size_t size; size_t size;
/** Allocated space */
size_t alloc; size_t alloc;
/** Array data */
void *data; void *data;
}; };