Finish up comments in wayland-util.h

1 files changed, 29 insertions, 0 deletions

diff --git a/wayland-util.h b/wayland-util.h
index dfd0efd..18891ec 100644
--- a/wayland-util.h
+++ b/wayland-util.h
@@ -68,17 +68,38 @@
 	const typeof( ((type *)0)->member ) *__mptr = (ptr);	\
 	(type *)( (char *)__mptr - offsetof(type,member) );})
 
+/**
+ * FIXME: This appears to be unused.
+ **/
 struct wl_argument {
 	uint32_t type;
 	void *data;
 };
 
+/**
+ * A name and signature for a method or event in a wl_interface.
+ *
+ * name: Name of this message.
+ * signature: What arguments this message comes with, in DBus style.
+ * types: FIXME: This appears to be unused.
+ **/
 struct wl_message {
 	const char *name;
 	const char *signature;
 	const void **types;
 };
 
+/**
+ * An interface implemented by an object. Lists what operations may be
+ * performed on that object.
+ *
+ * name: Name of this interface.
+ * version: Version of this interface.
+ * method_count: Length of `methods`.
+ * methods: List of methods this object supports.
+ * event_count: Length of `events`.
+ * events: Events this object may emit which others may listen for.
+ **/
 struct wl_interface {
 	const char *name;
 	int version;
@@ -88,6 +109,14 @@ struct wl_interface {
 	const struct wl_message *events;
 };
 
+/**
+ * An object in the OO sense. It has methods specified by `interface` and
+ * implemented with the functions in `implementation`, and a unique `id`.
+ *
+ * interface: The interface that this object adhere's to.
+ * implementation: Functions implementing `interface`
+ * id: A unique id.
+ **/
 struct wl_object {
 	const struct wl_interface *interface;
 	void (**implementation)(void);