changeset 10160:7a75a264ac20

[gaim-migrate @ 11243] I forgot to commit this a few days ago. It's just some comments. committer: Tailor Script <tailor@pidgin.im>
author Mark Doliner <mark@kingant.net>
date Mon, 08 Nov 2004 00:07:14 +0000
parents 952fb08c60b0
children f17e538bf9e0
files src/prpl.h
diffstat 1 files changed, 10 insertions(+), 4 deletions(-) [+]
line wrap: on
line diff
--- a/src/prpl.h	Fri Nov 05 05:55:48 2004 +0000
+++ b/src/prpl.h	Mon Nov 08 00:07:14 2004 +0000
@@ -160,7 +160,8 @@
  * A protocol plugin information structure.
  *
  * Every protocol plugin initializes this structure. It is the gateway
- * between gaim and the protocol plugin.
+ * between gaim and the protocol plugin.  Many of this callbacks can be
+ * NULL.  If a callback must be implemented, it has a comment indicated so.
  */
 struct _GaimPluginProtocolInfo
 {
@@ -168,12 +169,13 @@
 
 	GList *user_splits;      /* A GList of GaimAccountUserSplit */
 	GList *protocol_options; /* A GList of GaimAccountOption    */
-	
+
 	GaimBuddyIconSpec icon_spec; /* The icon spec. */
-	
+
 	/**
 	 * Returns the base icon name for the given buddy and account.
-	 * If buddy is NULL, it will return the name to use for the account's icon
+	 * If buddy is NULL, it will return the name to use for the account's
+	 * icon.  This must be implemented.
 	 */
 	const char *(*list_icon)(GaimAccount *account, GaimBuddy *buddy);
 
@@ -202,7 +204,11 @@
 	GHashTable *(*chat_info_defaults)(GaimConnection *, const char *chat_name);
 
 	/* All the server-related functions */
+
+	/** This must be implemented. */
 	void (*login)(GaimAccount *);
+
+	/** This must be implemented. */
 	void (*close)(GaimConnection *);
 	int  (*send_im)(GaimConnection *, const char *who,
 					const char *message,