/pidgin/main: ea9d401c7037: Merged in rw_grim/pidgin (pull reque...

Changeset: ea9d401c70371471ec174c5674a424405bc19f1f
Author:	 Gary Kramlich <[email protected]>
Date:	 2016-09-09 12:08 -0500
Branch:	 default
URL: https://hg.pidgin.im/pidgin/main/rev/ea9d401c7037

Description:

Merged in rw_grim/pidgin (pull request #110)

A bunch of random doc fixes (many more to come)

diffstat:

 doc/reference/libpurple/Makefile.am |   1 +
 libpurple/blistnode.h               |   5 ----
 libpurple/buddy.h                   |   5 ----
 libpurple/buddylist.h               |   5 ----
 libpurple/chat.h                    |   5 ----
 libpurple/cipher.h                  |  10 ---------
 libpurple/contact.h                 |   5 ----
 libpurple/countingnode.h            |   5 ----
 libpurple/group.h                   |   5 ----
 libpurple/media.h                   |   2 +-
 libpurple/plugins.h                 |  11 ----------
 libpurple/proxy.h                   |   1 +
 libpurple/server.h                  |  11 +++++++++-
 libpurple/signals.h                 |   8 ++++--
 libpurple/sound.h                   |   6 +++++
 libpurple/sslconn.h                 |   6 ++++-
 libpurple/status.h                  |  14 ++++++++++++-
 libpurple/stringref.h               |   1 +
 libpurple/stun.h                    |  38 +++++++++++++++++++++++++++++++-----
 libpurple/util.h                    |   4 +++
 libpurple/xfer.h                    |  11 +++++++++-
 21 files changed, 89 insertions(+), 70 deletions(-)

diffs (truncated from 488 to 300 lines):

diff --git a/doc/reference/libpurple/Makefile.am b/doc/reference/libpurple/Makefile.am
--- a/doc/reference/libpurple/Makefile.am
+++ b/doc/reference/libpurple/Makefile.am
@@ -69,6 +69,7 @@ IGNORE_HFILES=\
 	plugins \
 	protocols \
 	tests \
+	tests.h \
 	win32 \
 	backend-fs2.h \
 	dbus-define-api.h \
diff --git a/libpurple/blistnode.h b/libpurple/blistnode.h
--- a/libpurple/blistnode.h
+++ b/libpurple/blistnode.h
@@ -66,11 +66,6 @@ struct _PurpleBlistNode {
 	gpointer ui_data;
 };
 
-/**
- * PurpleBlistNodeClass:
- *
- * The base class for all #PurpleBlistNode's.
- */
 struct _PurpleBlistNodeClass {
 	GObjectClass gparent_class;
 
diff --git a/libpurple/buddy.h b/libpurple/buddy.h
--- a/libpurple/buddy.h
+++ b/libpurple/buddy.h
@@ -70,11 +70,6 @@ struct _PurpleBuddy {
 	PurpleBlistNode node;
 };
 
-/**
- * PurpleBuddyClass:
- *
- * The base class for all #PurpleBuddy's.
- */
 struct _PurpleBuddyClass {
 	PurpleBlistNodeClass node_class;
 
diff --git a/libpurple/buddylist.h b/libpurple/buddylist.h
--- a/libpurple/buddylist.h
+++ b/libpurple/buddylist.h
@@ -70,11 +70,6 @@ struct _PurpleBuddyList {
 	gpointer ui_data;
 };
 
-/**
- * PurpleBuddyListClass:
- *
- * The base class for all #PurpleBuddyList's.
- */
 struct _PurpleBuddyListClass {
 	GObjectClass gparent_class;
 
diff --git a/libpurple/chat.h b/libpurple/chat.h
--- a/libpurple/chat.h
+++ b/libpurple/chat.h
@@ -51,11 +51,6 @@ struct _PurpleChat {
 	PurpleBlistNode node;
 };
 
-/**
- * PurpleChatClass:
- *
- * The base class for all #PurpleChat's.
- */
 struct _PurpleChatClass {
 	PurpleBlistNodeClass node_class;
 
diff --git a/libpurple/cipher.h b/libpurple/cipher.h
--- a/libpurple/cipher.h
+++ b/libpurple/cipher.h
@@ -73,11 +73,6 @@ struct _PurpleCipher {
 	GObject gparent;
 };
 
-/**
- * PurpleCipherClass:
- *
- * The base class for all #PurpleCipher's.
- */
 struct _PurpleCipherClass {
 	GObjectClass parent_class;
 
@@ -139,11 +134,6 @@ struct _PurpleHash {
 	GObject gparent;
 };
 
-/**
- * PurpleHashClass:
- *
- * The base class for all #PurpleHash's.
- */
 struct _PurpleHashClass {
 	GObjectClass parent_class;
 
diff --git a/libpurple/contact.h b/libpurple/contact.h
--- a/libpurple/contact.h
+++ b/libpurple/contact.h
@@ -53,11 +53,6 @@ struct _PurpleContact {
 	PurpleCountingNode counting;
 };
 
-/**
- * PurpleContactClass:
- *
- * The base class for all #PurpleContact's.
- */
 struct _PurpleContactClass {
 	PurpleCountingNodeClass counting_class;
 
diff --git a/libpurple/countingnode.h b/libpurple/countingnode.h
--- a/libpurple/countingnode.h
+++ b/libpurple/countingnode.h
@@ -63,11 +63,6 @@ struct _PurpleCountingNode {
 	PurpleBlistNode node;
 };
 
-/**
- * PurpleCountingNodeClass:
- *
- * The base class for all #PurpleCountingNode's.
- */
 struct _PurpleCountingNodeClass {
 	PurpleBlistNodeClass node_class;
 
diff --git a/libpurple/group.h b/libpurple/group.h
--- a/libpurple/group.h
+++ b/libpurple/group.h
@@ -63,11 +63,6 @@ struct _PurpleGroup {
 	PurpleCountingNode counting;
 };
 
-/**
- * PurpleGroupClass:
- *
- * The base class for all #PurpleGroup's.
- */
 struct _PurpleGroupClass {
 	PurpleCountingNodeClass counting_class;
 
diff --git a/libpurple/media.h b/libpurple/media.h
--- a/libpurple/media.h
+++ b/libpurple/media.h
@@ -494,7 +494,7 @@ void purple_media_remove_output_windows(
 /**
  * purple_media_send_dtmf:
  * @media: The media instance to send a DTMF signal to.
- * @sess_id: The session id of the session to send the DTMF signal on.
+ * @session_id: The session id of the session to send the DTMF signal on.
  * @dtmf: The character representing the DTMF in the range [0-9#*A-D].
  * @volume: The power level expressed in dBm0 after dropping the sign in the
  *          range of 0 to 63.  A larger value represents a lower volume.
diff --git a/libpurple/plugins.h b/libpurple/plugins.h
--- a/libpurple/plugins.h
+++ b/libpurple/plugins.h
@@ -60,12 +60,6 @@
  */
 typedef GPluginPlugin PurplePlugin;
 
-/**
- * PurplePluginClass:
- *
- * The base class for all #PurplePlugin's.
- * This type is an alias for GPluginPluginClass.
- */
 typedef GPluginPluginClass PurplePluginClass;
 
 #else /* !defined(PURPLE_PLUGINS) */
@@ -178,11 +172,6 @@ struct _PurplePluginInfo {
 	gpointer ui_data;
 };
 
-/**
- * PurplePluginInfoClass:
- *
- * The base class for all #PurplePluginInfo's.
- */
 struct _PurplePluginInfoClass {
 #ifdef PURPLE_PLUGINS
 	GPluginPluginInfoClass parent_class;
diff --git a/libpurple/proxy.h b/libpurple/proxy.h
--- a/libpurple/proxy.h
+++ b/libpurple/proxy.h
@@ -309,6 +309,7 @@ PurpleProxyConnectData *purple_proxy_con
 
 /**
  * purple_proxy_connect_cancel:
+ * @connect_data: The #PurpleProxyConnectData to cancel.
  *
  * Cancel an in-progress connection attempt.  This should be called
  * by the protocol if the user disables an account while it is still
diff --git a/libpurple/server.h b/libpurple/server.h
--- a/libpurple/server.h
+++ b/libpurple/server.h
@@ -78,6 +78,8 @@ int  purple_serv_send_im(PurpleConnectio
 
 /**
  * purple_get_attention_type_from_code:
+ * @account: The #PurpleAccount
+ * @type_code: The protocol specific attention type code to convert
  *
  * Get information about an account's attention commands, from the protocol.
  *
@@ -254,6 +256,10 @@ void purple_serv_got_typing(PurpleConnec
 
 /**
  * purple_serv_got_typing_stopped:
+ * @gc: The #PurpleConnection
+ * @name: The name of the person that stopped typing.
+ *
+ * Called from a protocol when it has recieved a type stopped.
  *
  * @todo Could probably move this into the conversation API.
  */
@@ -265,6 +271,7 @@ void purple_serv_got_typing_stopped(Purp
  * @who:    The username of the buddy that sent the message.
  * @msg:    The actual message received.
  * @flags:  The flags applicable to this message.
+ * @mtime:  The timestamp of the message.
  *
  * This function is called by the protocol when it receives an IM message.
  */
@@ -273,6 +280,7 @@ void purple_serv_got_im(PurpleConnection
 
 /**
  * purple_serv_join_chat:
+ * @gc:   The #PurpleConnection
  * @data: The hash function should be g_str_hash() and the equal
  *             function should be g_str_equal().
  */
@@ -280,6 +288,7 @@ void purple_serv_join_chat(PurpleConnect
 
 /**
  * purple_serv_reject_chat:
+ * @gc: The #PurpleConnection 
  * @data: The hash function should be g_str_hash() and the equal
  *             function should be g_str_equal().
  */
@@ -350,7 +359,7 @@ void purple_serv_got_chat_in(PurpleConne
 
 /**
  * purple_serv_send_file:
- * @g:      The connection on which the message was received.
+ * @gc:     The connection on which the message was received.
  * @who:    The name of the user to who send the file.
  * @file:   The filename to send.
  *
diff --git a/libpurple/signals.h b/libpurple/signals.h
--- a/libpurple/signals.h
+++ b/libpurple/signals.h
@@ -40,9 +40,9 @@ typedef void (*PurpleSignalMarshalFunc)(
 
 G_BEGIN_DECLS
 
-/**************************************************************************/
-/* Signal API                                                             */
-/**************************************************************************/
+/******************************************************************************
+ * Signal API
+ *****************************************************************************/
 
 /**
  * PURPLE_SIGNAL_PRIORITY_DEFAULT:
@@ -247,6 +247,7 @@ void purple_signals_disconnect_by_handle
  * purple_signal_emit:
  * @instance: The instance emitting the signal.
  * @signal:   The signal being emitted.
+ * @...:      The arguments to pass to the callbacks.
  *
  * Emits a signal.
  *
@@ -270,6 +271,7 @@ void purple_signal_emit_vargs(void *inst
  * purple_signal_emit_return_1:
  * @instance: The instance emitting the signal.
  * @signal:   The signal being emitted.
+ * @...:      The arguments to pass to the callbacks.
  *
  * Emits a signal and returns the first non-NULL return value.
  *
diff --git a/libpurple/sound.h b/libpurple/sound.h
--- a/libpurple/sound.h
+++ b/libpurple/sound.h
@@ -90,6 +90,12 @@ typedef enum
 
 /**
  * PurpleSoundUiOps:
+ * @init: Called when the UI should initialize sound
+ * @uninit: Called when the UI should teardown sound
+ * @play_file: Called when a file should be played.
+ *             <sbr/>@filename: The filename to play
+ * @play_event: Called when a sound event should be played.
+ *              <sbr/>@event: The #@PurpleSoundEventID to play
  *
  * Operations used by the core to request that particular sound files, or the
  * sound associated with a particular event, should be played.
diff --git a/libpurple/sslconn.h b/libpurple/sslconn.h
--- a/libpurple/sslconn.h

_______________________________________________
Commits mailing list
[email protected]
https://pidgin.im/cgi-bin/mailman/listinfo/commits