[PATCH wayland] util: Document wl_array and wl_list members
Yong Bakos
junk at humanoriented.com
Tue Dec 6 15:21:56 UTC 2016
From: Yong Bakos <ybakos at humanoriented.com>
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 at humanoriented.com>
---
src/wayland-util.h | 5 +++++
1 file changed, 5 insertions(+)
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;
};
--
2.7.2
More information about the wayland-devel
mailing list