pidgin/pidgin

Parents 9bcf96663cb9
Children 96fc115d6c36
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/
--- a/libpurple/account.h Tue Aug 25 21:53:23 2020 -0500
+++ b/libpurple/account.h Tue Aug 25 23:18:09 2020 -0500
@@ -25,6 +25,7 @@
#ifndef PURPLE_ACCOUNT_H
#define PURPLE_ACCOUNT_H
+
/**
* SECTION:account
* @section_id: libpurple-account
@@ -35,6 +36,11 @@
#include <glib.h>
#include <glib-object.h>
+/**
+ * PURPLE_TYPE_ACCOUNT:
+ *
+ * The standard _get_type macro for #PurpleAccount.
+ */
#define PURPLE_TYPE_ACCOUNT (purple_account_get_type())
typedef struct _PurpleAccount PurpleAccount;
--- a/libpurple/attention.h Tue Aug 25 21:53:23 2020 -0500
+++ b/libpurple/attention.h Tue Aug 25 23:18:09 2020 -0500
@@ -51,6 +51,11 @@
G_BEGIN_DECLS
+/**
+ * PURPLE_TYPE_PROTOCOL_ATTENTION:
+ *
+ * The standard _get_type macro for #PurpleProtocolAttention.
+ */
#define PURPLE_TYPE_PROTOCOL_ATTENTION (purple_protocol_attention_get_type())
/******************************************************************************
--- a/libpurple/buddylist.h Tue Aug 25 21:53:23 2020 -0500
+++ b/libpurple/buddylist.h Tue Aug 25 23:18:09 2020 -0500
@@ -38,9 +38,19 @@
#include "buddy.h"
+/**
+ * PURPLE_TYPE_BUDDY_LIST:
+ *
+ * The standard _get_type macro for #PurpleBuddyList.
+ */
#define PURPLE_TYPE_BUDDY_LIST (purple_buddy_list_get_type())
typedef struct _PurpleBuddyList PurpleBuddyList;
+/**
+ * PURPLE_BLIST_DEFAULT_GROUP_NAME:
+ *
+ * A helper to get the default group name for the buddy list.
+ */
#define PURPLE_BLIST_DEFAULT_GROUP_NAME (purple_blist_get_default_group_name())
#include "chat.h"
--- a/libpurple/circularbuffer.h Tue Aug 25 21:53:23 2020 -0500
+++ b/libpurple/circularbuffer.h Tue Aug 25 23:18:09 2020 -0500
@@ -35,6 +35,11 @@
G_BEGIN_DECLS
+/**
+ * PURPLE_TYPE_CIRCULAR_BUFFER:
+ *
+ * The standard _get_type macro for #PurpleCircularBuffer.
+ */
#define PURPLE_TYPE_CIRCULAR_BUFFER (purple_circular_buffer_get_type())
G_DECLARE_DERIVABLE_TYPE(PurpleCircularBuffer, purple_circular_buffer, PURPLE,
--- a/libpurple/connection.h Tue Aug 25 21:53:23 2020 -0500
+++ b/libpurple/connection.h Tue Aug 25 23:18:09 2020 -0500
@@ -35,16 +35,28 @@
#include <glib.h>
+/**
+ * PURPLE_TYPE_CONNECTION:
+ *
+ * The standard _get_type macro for #PurpleConnection.
+ */
#define PURPLE_TYPE_CONNECTION purple_connection_get_type()
-
typedef struct _PurpleConnection PurpleConnection;
+/**
+ * PURPLE_TYPE_CONNECTION_UI_OPS:
+ *
+ * The standard _get_type macro for #PurpleConnectionUiOps.
+ */
#define PURPLE_TYPE_CONNECTION_UI_OPS (purple_connection_ui_ops_get_type())
-
typedef struct _PurpleConnectionUiOps PurpleConnectionUiOps;
+/**
+ * PURPLE_TYPE_CONNECTION_ERROR_INFO:
+ *
+ * The standard _get_type macro for #PurpleConnectionErrorInfo.
+ */
#define PURPLE_TYPE_CONNECTION_ERROR_INFO (purple_connection_error_info_get_type())
-
typedef struct _PurpleConnectionErrorInfo PurpleConnectionErrorInfo;
/* This is meant to track use-after-free errors.
--- a/libpurple/conversation.h Tue Aug 25 21:53:23 2020 -0500
+++ b/libpurple/conversation.h Tue Aug 25 23:18:09 2020 -0500
@@ -44,10 +44,13 @@
#define PURPLE_IS_CONVERSATION_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass), PURPLE_TYPE_CONVERSATION))
#define PURPLE_CONVERSATION_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS((obj), PURPLE_TYPE_CONVERSATION, PurpleConversationClass))
+/**
+ * PURPLE_TYPE_CONVERSATION_UI_OPS:
+ *
+ * The standard _get_type macro for #PurpleConversationUiOps.
+ */
#define PURPLE_TYPE_CONVERSATION_UI_OPS (purple_conversation_ui_ops_get_type())
-#define PURPLE_TYPE_CONVERSATION_MESSAGE (purple_conversation_message_get_type())
-
/**************************************************************************/
/* Data Structures */
/**************************************************************************/
--- a/libpurple/debug.h Tue Aug 25 21:53:23 2020 -0500
+++ b/libpurple/debug.h Tue Aug 25 23:18:09 2020 -0500
@@ -39,6 +39,11 @@
G_BEGIN_DECLS
+/**
+ * PURPLE_TYPE_DEBUG_UI:
+ *
+ * The standard _get_type macro for #PurpleDebugUi.
+ */
#define PURPLE_TYPE_DEBUG_UI (purple_debug_ui_get_type())
G_DECLARE_INTERFACE(PurpleDebugUi, purple_debug_ui, PURPLE, DEBUG_UI, GObject)
--- a/libpurple/image.h Tue Aug 25 21:53:23 2020 -0500
+++ b/libpurple/image.h Tue Aug 25 23:18:09 2020 -0500
@@ -44,6 +44,11 @@
#include <glib-object.h>
+/**
+ * PURPLE_TYPE_IMAGE:
+ *
+ * The standard _get_type macro for #PurpleImage.
+ */
#define PURPLE_TYPE_IMAGE purple_image_get_type()
struct _PurpleImageClass {
--- a/libpurple/media-gst.h Tue Aug 25 21:53:23 2020 -0500
+++ b/libpurple/media-gst.h Tue Aug 25 23:18:09 2020 -0500
@@ -37,7 +37,18 @@
#include <gst/gst.h>
+/**
+ * PURPLE_TYPE_MEDIA_ELEMENT_TYPE:
+ *
+ * The standard _get_type macro for #PurpleMediaElementType.
+ */
#define PURPLE_TYPE_MEDIA_ELEMENT_TYPE purple_media_element_type_get_type()
+
+/**
+ * PURPLE_TYPE_MEDIA_ELEMENT_INFO:
+ *
+ * The standard _get_type macro for #PurpleMediaElementInfo.
+ */
#define PURPLE_TYPE_MEDIA_ELEMENT_INFO purple_media_element_info_get_type()
/**
--- a/libpurple/media/candidate.h Tue Aug 25 21:53:23 2020 -0500
+++ b/libpurple/media/candidate.h Tue Aug 25 23:18:09 2020 -0500
@@ -38,6 +38,11 @@
G_BEGIN_DECLS
+/**
+ * PURPLE_TYPE_MEDIA_CANDIDATE:
+ *
+ * The standard _get_type macro for #PurpleMediaCandidate.
+ */
#define PURPLE_TYPE_MEDIA_CANDIDATE purple_media_candidate_get_type()
/**
--- a/libpurple/media/codec.h Tue Aug 25 21:53:23 2020 -0500
+++ b/libpurple/media/codec.h Tue Aug 25 23:18:09 2020 -0500
@@ -48,7 +48,12 @@
G_BEGIN_DECLS
-#define PURPLE_TYPE_MEDIA_CODEC purple_media_codec_get_type()
+/**
+ * PURPLE_TYPE_MEDIA_CODEC:
+ *
+ * The standard _get_type macro for #PurpleMediaCodec.
+ */
+#define PURPLE_TYPE_MEDIA_CODEC purple_media_codec_get_type()
/**
* purple_media_codec_get_type:
--- a/libpurple/media/enum-types.c Tue Aug 25 21:53:23 2020 -0500
+++ b/libpurple/media/enum-types.c Tue Aug 25 23:18:09 2020 -0500
@@ -200,7 +200,7 @@
*/
GType
-purple_media_state_changed_get_type()
+purple_media_state_get_type()
{
static GType type = 0;
if (type == 0) {
--- a/libpurple/media/enum-types.h Tue Aug 25 21:53:23 2020 -0500
+++ b/libpurple/media/enum-types.h Tue Aug 25 23:18:09 2020 -0500
@@ -36,12 +36,47 @@
G_BEGIN_DECLS
-#define PURPLE_TYPE_MEDIA_CANDIDATE_TYPE (purple_media_candidate_type_get_type())
-#define PURPLE_MEDIA_TYPE_CAPS (purple_media_caps_get_type())
-#define PURPLE_MEDIA_TYPE_INFO_TYPE (purple_media_info_type_get_type())
+/**
+ * PURPLE_TYPE_MEDIA_CANDIDATE_TYPE:
+ *
+ * The standard _get_type macro for #PurpleMediaCandidateType.
+ */
+#define PURPLE_TYPE_MEDIA_CANDIDATE_TYPE (purple_media_candidate_type_get_type())
+
+/**
+ * PURPLE_MEDIA_TYPE_CAPS:
+ *
+ * The standard _get_type macro for #PurpleMediaCaps.
+ */
+#define PURPLE_MEDIA_TYPE_CAPS (purple_media_caps_get_type())
+
+/**
+ * PURPLE_MEDIA_TYPE_INFO_TYPE:
+ *
+ * The standard _get_type macro for #PurpleMediaInfoType.
+ */
+#define PURPLE_MEDIA_TYPE_INFO_TYPE (purple_media_info_type_get_type())
+
+/**
+ * PURPLE_TYPE_MEDIA_NETWORK_PROTOCOL:
+ *
+ * The standard _get_type macro for #PurpleMediaNetworkProtocol.
+ */
#define PURPLE_TYPE_MEDIA_NETWORK_PROTOCOL (purple_media_network_protocol_get_type())
-#define PURPLE_TYPE_MEDIA_SESSION_TYPE (purple_media_session_type_get_type())
-#define PURPLE_MEDIA_TYPE_STATE (purple_media_state_changed_get_type())
+
+/**
+ * PURPLE_TYPE_MEDIA_SESSION_TYPE:
+ *
+ * The standard _get_type macro for #PurpleMediaSessionType.
+ */
+#define PURPLE_TYPE_MEDIA_SESSION_TYPE (purple_media_session_type_get_type())
+
+/**
+ * PURPLE_MEDIA_TYPE_STATE:
+ *
+ * The standard _get_type macro for #PurpleMediaState.
+ */
+#define PURPLE_MEDIA_TYPE_STATE (purple_media_state_get_type())
/**
* PurpleMediaCandidateType:
@@ -188,13 +223,13 @@
GType purple_media_session_type_get_type(void);
/**
- * purple_media_state_changed_get_type:
+ * purple_media_state_get_type:
*
- * Gets the type of the state-changed enum
+ * Gets the type of the state enum
*
- * Returns: The state-changed enum's GType
+ * Returns: The state enum's GType
*/
-GType purple_media_state_changed_get_type(void);
+GType purple_media_state_get_type(void);
G_END_DECLS
--- a/libpurple/mediamanager.h Tue Aug 25 21:53:23 2020 -0500
+++ b/libpurple/mediamanager.h Tue Aug 25 23:18:09 2020 -0500
@@ -40,7 +40,12 @@
#include "account.h"
#include "media.h"
-#define PURPLE_TYPE_MEDIA_MANAGER purple_media_manager_get_type()
+/**
+ * PURPLE_TYPE_MEDIA_MANAGER:
+ *
+ * The standard _get_type macro for #PurpleMediaManager.
+ */
+#define PURPLE_TYPE_MEDIA_MANAGER purple_media_manager_get_type()
/**
* PurpleMediaManagerClass:
--- a/libpurple/message.h Tue Aug 25 21:53:23 2020 -0500
+++ b/libpurple/message.h Tue Aug 25 23:18:09 2020 -0500
@@ -41,6 +41,11 @@
G_BEGIN_DECLS
+/**
+ * PURPLE_TYPE_MESSAGE:
+ *
+ * The standard _get_type macro for #PurpleMessage.
+ */
#define PURPLE_TYPE_MESSAGE purple_message_get_type()
/**
--- a/libpurple/plugins.h Tue Aug 25 21:53:23 2020 -0500
+++ b/libpurple/plugins.h Tue Aug 25 23:18:09 2020 -0500
@@ -57,10 +57,20 @@
typedef GPluginPluginInterface PurplePluginInterface;
-#define PURPLE_TYPE_PLUGIN_INFO (purple_plugin_info_get_type())
+/**
+ * PURPLE_TYPE_PLUGIN_INFO:
+ *
+ * The standard _get_type macro for #PurplePluginInfo.
+ */
+#define PURPLE_TYPE_PLUGIN_INFO (purple_plugin_info_get_type())
typedef struct _PurplePluginInfo PurplePluginInfo;
-#define PURPLE_TYPE_PLUGIN_ACTION (purple_plugin_action_get_type())
+/**
+ * PURPLE_TYPE_PLUGIN_ACTION:
+ *
+ * The standard _get_type macro for #PurplePluginAction.
+ */
+#define PURPLE_TYPE_PLUGIN_ACTION (purple_plugin_action_get_type())
typedef struct _PurplePluginAction PurplePluginAction;
#include "pluginpref.h"
--- a/libpurple/presence.h Tue Aug 25 21:53:23 2020 -0500
+++ b/libpurple/presence.h Tue Aug 25 23:18:09 2020 -0500
@@ -83,6 +83,11 @@
/* PurplePresence API */
/**************************************************************************/
+/**
+ * PURPLE_TYPE_PRESENCE:
+ *
+ * The standard _get_type macro for #PurplePresence.
+ */
#define PURPLE_TYPE_PRESENCE purple_presence_get_type()
/**
@@ -263,6 +268,11 @@
/* PurpleAccountPresence API */
/**************************************************************************/
+/**
+ * PURPLE_TYPE_ACCOUNT_PRESENCE:
+ *
+ * The standard _get_type macro for #PurpleAccountPresence.
+ */
#define PURPLE_TYPE_ACCOUNT_PRESENCE (purple_account_presence_get_type())
/**
@@ -299,6 +309,11 @@
/* PurpleBuddyPresence API */
/**************************************************************************/
+/**
+ * PURPLE_TYPE_BUDDY_PRESENCE:
+ *
+ * The standard _get_type macro for #PurpleBuddyPresence.
+ */
#define PURPLE_TYPE_BUDDY_PRESENCE (purple_buddy_presence_get_type())
/**
--- a/libpurple/purplechatuser.h Tue Aug 25 21:53:23 2020 -0500
+++ b/libpurple/purplechatuser.h Tue Aug 25 23:18:09 2020 -0500
@@ -66,6 +66,11 @@
} PurpleChatUserFlags;
+/**
+ * PURPLE_TYPE_CHAT_USER:
+ *
+ * The standard _get_type macro for #PurpleChatUser.
+ */
#define PURPLE_TYPE_CHAT_USER purple_chat_user_get_type()
/**
--- a/libpurple/purpleprotocolfactory.h Tue Aug 25 21:53:23 2020 -0500
+++ b/libpurple/purpleprotocolfactory.h Tue Aug 25 23:18:09 2020 -0500
@@ -45,6 +45,11 @@
G_BEGIN_DECLS
+/**
+ * PURPLE_TYPE_PROTOCOL_FACTORY:
+ *
+ * The standard _get_type macro for #PurpleProtocolFactory.
+ */
#define PURPLE_TYPE_PROTOCOL_FACTORY (purple_protocol_factory_iface_get_type())
G_DECLARE_INTERFACE(PurpleProtocolFactory, purple_protocol_factory, PURPLE,
PROTOCOL_FACTORY, GObject)
--- a/libpurple/purpleuiinfo.h Tue Aug 25 21:53:23 2020 -0500
+++ b/libpurple/purpleuiinfo.h Tue Aug 25 23:18:09 2020 -0500
@@ -39,6 +39,11 @@
G_BEGIN_DECLS
+/**
+ * PURPLE_TYPE_UI_INFO:
+ *
+ * The standard _get_type macro for #PurpleUiInfo.
+ */
#define PURPLE_TYPE_UI_INFO (purple_ui_info_get_type())
G_DECLARE_FINAL_TYPE(PurpleUiInfo, purple_ui_info, PURPLE, UI_INFO, GObject)
--- a/libpurple/queuedoutputstream.h Tue Aug 25 21:53:23 2020 -0500
+++ b/libpurple/queuedoutputstream.h Tue Aug 25 23:18:09 2020 -0500
@@ -42,6 +42,11 @@
G_BEGIN_DECLS
+/**
+ * PURPLE_TYPE_QUEUED_OUTPUT_STREAM:
+ *
+ * The standard _get_type macro for #PurpleQueuedOutputStream.
+ */
#define PURPLE_TYPE_QUEUED_OUTPUT_STREAM purple_queued_output_stream_get_type()
G_DECLARE_FINAL_TYPE(PurpleQueuedOutputStream,
--- a/libpurple/roomlist.h Tue Aug 25 21:53:23 2020 -0500
+++ b/libpurple/roomlist.h Tue Aug 25 23:18:09 2020 -0500
@@ -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;
/**
--- a/libpurple/signals.h Tue Aug 25 21:53:23 2020 -0500
+++ b/libpurple/signals.h Tue Aug 25 23:18:09 2020 -0500
@@ -36,7 +36,13 @@
#include <glib.h>
#include <glib-object.h>
-#define PURPLE_CALLBACK(func) ((PurpleCallback)func)
+/**
+ * PURPLE_CALLBACK:
+ * @func: a function pointer.
+ *
+ * Cast a function pointer to #PurpleCallback.
+ */
+#define PURPLE_CALLBACK(func) ((PurpleCallback)(func))
typedef void (*PurpleCallback)(void);
typedef void (*PurpleSignalMarshalFunc)(PurpleCallback cb, va_list args,
--- a/libpurple/smiley-list.h Tue Aug 25 21:53:23 2020 -0500
+++ b/libpurple/smiley-list.h Tue Aug 25 23:18:09 2020 -0500
@@ -45,6 +45,11 @@
G_BEGIN_DECLS
+/**
+ * PURPLE_TYPE_SMILEY_LIST:
+ *
+ * The standard _get_type macro for #PurpleSmileyList.
+ */
#define PURPLE_TYPE_SMILEY_LIST purple_smiley_list_get_type()
/**
--- a/libpurple/smiley-theme.h Tue Aug 25 21:53:23 2020 -0500
+++ b/libpurple/smiley-theme.h Tue Aug 25 23:18:09 2020 -0500
@@ -45,6 +45,11 @@
G_BEGIN_DECLS
+/**
+ * PURPLE_TYPE_SMILEY_THEME:
+ *
+ * The standard _get_type macro for #PurpleSmileyTheme.
+ */
#define PURPLE_TYPE_SMILEY_THEME purple_smiley_theme_get_type()
/**
--- a/libpurple/smiley.h Tue Aug 25 21:53:23 2020 -0500
+++ b/libpurple/smiley.h Tue Aug 25 23:18:09 2020 -0500
@@ -48,6 +48,11 @@
G_BEGIN_DECLS
+/**
+ * PURPLE_TYPE_SMILEY:
+ *
+ * The standard _get_type macro for #PurpleSmiley.
+ */
#define PURPLE_TYPE_SMILEY purple_smiley_get_type()
/**
--- a/libpurple/status.h Tue Aug 25 21:53:23 2020 -0500
+++ b/libpurple/status.h Tue Aug 25 23:18:09 2020 -0500
@@ -33,10 +33,20 @@
* @title: Status Object API
*/
-#define PURPLE_TYPE_STATUS (purple_status_get_type())
-typedef struct _PurpleStatus PurpleStatus;
+/**
+ * PURPLE_TYPE_STATUS:
+ *
+ * The standard _get_type macro for #PurpleStatus.
+ */
+#define PURPLE_TYPE_STATUS (purple_status_get_type())
+typedef struct _PurpleStatus PurpleStatus;
-#define PURPLE_TYPE_STATUS_TYPE (purple_status_type_get_type())
+/**
+ * PURPLE_TYPE_STATUS_TYPE:
+ *
+ * The standard _get_type macro for #PurpleStatusType.
+ */
+#define PURPLE_TYPE_STATUS_TYPE (purple_status_type_get_type())
/**
* PurpleStatusType:
@@ -50,13 +60,22 @@
* hardcoded in each protocol and will not change often. And because
* they are hardcoded, they do not need to be saved to any XML file.
*/
-typedef struct _PurpleStatusType PurpleStatusType;
-
-#define PURPLE_TYPE_STATUS_ATTRIBUTE (purple_status_attribute_get_type())
+typedef struct _PurpleStatusType PurpleStatusType;
-typedef struct _PurpleStatusAttribute PurpleStatusAttribute;
+/**
+ * PURPLE_TYPE_STATUS_ATTRIBUTE:
+ *
+ * The standard _get_type macro for #PurpleStatusAttribute.
+ */
+#define PURPLE_TYPE_STATUS_ATTRIBUTE (purple_status_attribute_get_type())
+typedef struct _PurpleStatusAttribute PurpleStatusAttribute;
-#define PURPLE_TYPE_MOOD (purple_mood_get_type())
+/**
+ * PURPLE_TYPE_MOOD:
+ *
+ * The standard _get_type macro for #PurpleMood.
+ */
+#define PURPLE_TYPE_MOOD (purple_mood_get_type())
typedef struct {
const char *mood;
@@ -102,16 +121,75 @@
#include "presence.h"
-#define PURPLE_TUNE_ARTIST "tune_artist"
-#define PURPLE_TUNE_TITLE "tune_title"
-#define PURPLE_TUNE_ALBUM "tune_album"
-#define PURPLE_TUNE_GENRE "tune_genre"
-#define PURPLE_TUNE_COMMENT "tune_comment"
-#define PURPLE_TUNE_TRACK "tune_track"
-#define PURPLE_TUNE_TIME "tune_time"
-#define PURPLE_TUNE_YEAR "tune_year"
-#define PURPLE_TUNE_URL "tune_url"
-#define PURPLE_TUNE_FULL "tune_full"
+/**
+ * PURPLE_TUNE_ALBUM:
+ *
+ * A constant for a status attribute that represents the album of a song.
+ */
+#define PURPLE_TUNE_ALBUM "tune_album"
+
+/**
+ * PURPLE_TUNE_ARTIST:
+ *
+ * A constant for a status attribute that represents the artists of a song.
+ */
+#define PURPLE_TUNE_ARTIST "tune_artist"
+
+/**
+ * PURPLE_TUNE_COMMENT:
+ *
+ * A constant for a status attribute that represents the comment of a song.
+ */
+#define PURPLE_TUNE_COMMENT "tune_comment"
+
+/**
+ * PURPLE_TUNE_FULL:
+ *
+ * A constant for a status attribute that represents the full details of a song.
+ */
+#define PURPLE_TUNE_FULL "tune_full"
+
+/**
+ * PURPLE_TUNE_GENRE:
+ *
+ * A constant for a status attribute that represents the genre of a song.
+ */
+#define PURPLE_TUNE_GENRE "tune_genre"
+
+/**
+ * PURPLE_TUNE_TIME:
+ *
+ * A constant for a status attribute that represents the duration of a song.
+ */
+#define PURPLE_TUNE_TIME "tune_time"
+
+/**
+ * PURPLE_TUNE_TITLE:
+ *
+ * A constant for a status attribute that represents the title of a song.
+ */
+#define PURPLE_TUNE_TITLE "tune_title"
+
+/**
+ * PURPLE_TUNE_TRACK:
+ *
+ * A constant for a status attribute that represents the track number of a song.
+ */
+#define PURPLE_TUNE_TRACK "tune_track"
+
+/**
+ * PURPLE_TUNE_URL:
+ *
+ * A constant for a status attribute that represents the url of a song.
+ */
+#define PURPLE_TUNE_URL "tune_url"
+
+/**
+ * PURPLE_TUNE_YEAR:
+ *
+ * A constant for a status attribute that represents the release year of a song.
+ */
+#define PURPLE_TUNE_YEAR "tune_year"
#define PURPLE_MOOD_NAME "mood"
#define PURPLE_MOOD_COMMENT "moodtext"
--- a/libpurple/theme-loader.h Tue Aug 25 21:53:23 2020 -0500
+++ b/libpurple/theme-loader.h Tue Aug 25 23:18:09 2020 -0500
@@ -36,6 +36,11 @@
#include <glib-object.h>
#include "theme.h"
+/**
+ * PURPLE_TYPE_THEME_LOADER:
+ *
+ * The standard _get_type macro for #PurpleThemeLoader.
+ */
#define PURPLE_TYPE_THEME_LOADER purple_theme_loader_get_type()
struct _PurpleThemeLoaderClass
--- a/libpurple/theme-manager.h Tue Aug 25 21:53:23 2020 -0500
+++ b/libpurple/theme-manager.h Tue Aug 25 23:18:09 2020 -0500
@@ -40,7 +40,12 @@
typedef void (*PurpleThemeFunc) (PurpleTheme *theme);
-#define PURPLE_TYPE_THEME_MANAGER purple_theme_manager_get_type()
+/**
+ * PURPLE_TYPE_THEME_MANAGER:
+ *
+ * The standard _get_type macro for #PurpleThemeManager.
+ */
+#define PURPLE_TYPE_THEME_MANAGER purple_theme_manager_get_type()
/**************************************************************************/
/* Purple Theme Manager API */
--- a/libpurple/theme.h Tue Aug 25 21:53:23 2020 -0500
+++ b/libpurple/theme.h Tue Aug 25 23:18:09 2020 -0500
@@ -35,7 +35,12 @@
#include <glib.h>
#include <glib-object.h>
-#define PURPLE_TYPE_THEME purple_theme_get_type()
+/**
+ * PURPLE_TYPE_THEME:
+ *
+ * The standard _get_type macro for #PurpleTheme.
+ */
+#define PURPLE_TYPE_THEME purple_theme_get_type()
struct _PurpleThemeClass
{
--- a/libpurple/trie.h Tue Aug 25 21:53:23 2020 -0500
+++ b/libpurple/trie.h Tue Aug 25 23:18:09 2020 -0500
@@ -55,7 +55,12 @@
#include <glib-object.h>
-#define PURPLE_TYPE_TRIE purple_trie_get_type()
+/**
+ * PURPLE_TYPE_TRIE:
+ *
+ * The standard _get_type macro for #PurpleTrie.
+ */
+#define PURPLE_TYPE_TRIE purple_trie_get_type()
/**
* PurpleTrieReplaceCb:
--- a/libpurple/whiteboard.h Tue Aug 25 21:53:23 2020 -0500
+++ b/libpurple/whiteboard.h Tue Aug 25 23:18:09 2020 -0500
@@ -32,9 +32,19 @@
* @title: Whiteboard Object
*/
+/**
+ * PURPLE_TYPE_WHITEBOARD:
+ *
+ * The standard _get_type macro for #PurpleWhiteboard.
+ */
#define PURPLE_TYPE_WHITEBOARD (purple_whiteboard_get_type())
typedef struct _PurpleWhiteboard PurpleWhiteboard;
+/**
+ * PURPLE_TYPE_WHITEBOARD_UI_OPS:
+ *
+ * The standard _get_type macro for #PurpleWhiteboardUiOps.
+ */
#define PURPLE_TYPE_WHITEBOARD_UI_OPS (purple_whiteboard_ui_ops_get_type())
typedef struct _PurpleWhiteboardUiOps PurpleWhiteboardUiOps;
--- a/libpurple/xfer.h Tue Aug 25 21:53:23 2020 -0500
+++ b/libpurple/xfer.h Tue Aug 25 23:18:09 2020 -0500
@@ -33,6 +33,11 @@
* @see_also: <link linkend="chapter-signals-xfer">File Transfer signals</link>
*/
+/**
+ * PURPLE_TYPE_XFER_UI_OPS:
+ *
+ * The standard _get_type macro for #PurpleXferUiOps.
+ */
#define PURPLE_TYPE_XFER_UI_OPS (purple_xfer_ui_ops_get_type())
/**************************************************************************/
@@ -88,8 +93,12 @@
G_BEGIN_DECLS
+/**
+ * PURPLE_TYPE_XFER:
+ *
+ * The standard _get_type macro for #PurpleXfer.
+ */
#define PURPLE_TYPE_XFER (purple_xfer_get_type())
-
G_DECLARE_DERIVABLE_TYPE(PurpleXfer, purple_xfer, PURPLE, XFER, GObject)
/**
@@ -796,6 +805,12 @@
/******************************************************************************
* Protocol Interface
*****************************************************************************/
+
+/**
+ * PURPLE_TYPE_PROTOCOL_XFER:
+ *
+ * The standard _get_type macro for #PurpleProtocolXfer.
+ */
#define PURPLE_TYPE_PROTOCOL_XFER (purple_protocol_xfer_get_type())
/**