summaryrefslogtreecommitdiff
path: root/libpurple/roomlist.h
diff options
context:
space:
mode:
authorGary Kramlich <grim@reaperworld.com>2020-08-25 23:18:09 -0500
committerGary Kramlich <grim@reaperworld.com>2020-08-25 23:18:09 -0500
commitbf285dddb150ca913393cc0ae28661c6ee77881c (patch)
tree7448ce1f9115b99dab20ad48c171f5c807f126e9 /libpurple/roomlist.h
parent0a1e9c5a3665efc6bb35169d4f2b9f25c2929e37 (diff)
downloadpidgin-bf285dddb150ca913393cc0ae28661c6ee77881c.tar.gz
Add documentation for all PURPLE_TYPE_ functions as well as PURPLE_TUNE_ constants
Add document for all PURPLE_TYPE_ defines as well as PURPLE_TUNE_ constants Testing Done: Compile and doc build. Reviewed at https://reviews.imfreedom.org/r/92/
Diffstat (limited to 'libpurple/roomlist.h')
-rw-r--r--libpurple/roomlist.h29
1 files changed, 23 insertions, 6 deletions
diff --git a/libpurple/roomlist.h b/libpurple/roomlist.h
index 369bb72931..214fc01722 100644
--- a/libpurple/roomlist.h
+++ b/libpurple/roomlist.h
@@ -32,19 +32,36 @@
* @title: Room List API
*/
+/**
+ * PURPLE_TYPE_ROOMLIST:
+ *
+ * The standard _get_type macro for #PurpleRoomlist.
+ */
#define PURPLE_TYPE_ROOMLIST (purple_roomlist_get_type())
typedef struct _PurpleRoomlist PurpleRoomlist;
-#define PURPLE_TYPE_ROOMLIST_ROOM (purple_roomlist_room_get_type())
-
+/**
+ * PURPLE_TYPE_ROOMLIST_ROOM:
+ *
+ * The standard _get_type macro for #PurpleRoomlistRoom.
+ */
+#define PURPLE_TYPE_ROOMLIST_ROOM (purple_roomlist_room_get_type())
typedef struct _PurpleRoomlistRoom PurpleRoomlistRoom;
-#define PURPLE_TYPE_ROOMLIST_FIELD (purple_roomlist_field_get_type())
-
+/**
+ * PURPLE_TYPE_ROOMLIST_FIELD:
+ *
+ * The standard _get_type macro for #PurpleRoomlistField.
+ */
+#define PURPLE_TYPE_ROOMLIST_FIELD (purple_roomlist_field_get_type())
typedef struct _PurpleRoomlistField PurpleRoomlistField;
-#define PURPLE_TYPE_ROOMLIST_UI_OPS (purple_roomlist_ui_ops_get_type())
-
+/**
+ * PURPLE_TYPE_ROOMLIST_UI_OPS:
+ *
+ * The standard _get_type macro for #PurpleRoomlistUiOps.
+ */
+#define PURPLE_TYPE_ROOMLIST_UI_OPS (purple_roomlist_ui_ops_get_type())
typedef struct _PurpleRoomlistUiOps PurpleRoomlistUiOps;
/**