pidgin/pidgin

86f6d297385b
Parents d2615938ce5e
Children 669d3113448d
Document the fields for PurpleProtocolAction
--- a/libpurple/action.h Sat Sep 28 01:01:12 2019 -0500
+++ b/libpurple/action.h Sat Sep 28 01:26:11 2019 -0500
@@ -25,9 +25,7 @@
#include <glib.h>
#include <glib-object.h>
-
-#define PURPLE_TYPE_PROTOCOL_ACTION (purple_protocol_action_get_type())
-
+#define PURPLE_TYPE_PROTOCOL_ACTION (purple_protocol_action_get_type())
typedef struct _PurpleProtocolAction PurpleProtocolAction;
typedef void (*PurpleProtocolActionCallback)(PurpleProtocolAction *action);
@@ -45,6 +43,11 @@
/**
* PurpleProtocolAction:
+ * @label: A translated string to be shown in a user interface.
+ * @callback: The function to call when the user wants to perform this action.
+ * @connection: The connection to that this connection should be performed
+ * against.
+ * @user_data: User data to pass to @callback.
*
* Represents an action that the protocol can perform. This shows up in the
* Accounts menu, under a submenu with the name of the account.