/pidgin/main: 3ac0882cd563: A few random cleanups and don't even...

Changeset: 3ac0882cd563efdbf201f5cd8981b6351091107a
Author:	 Gary Kramlich <[email protected]>
Date:	 2016-08-28 16:27 -0500
Branch:	 default
URL: https://hg.pidgin.im/pidgin/main/rev/3ac0882cd563

Description:

A few random cleanups and don't even try to document class structs

diffstat:

 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          |   2 +-
 libpurple/sslconn.h         |   1 -
 libpurple/stringref.h       |   1 +
 libpurple/stun.h            |   5 ++++-
 libpurple/tls-certificate.h |   4 ++--
 libpurple/util.h            |   4 ++++
 libpurple/xfer.h            |   1 +
 18 files changed, 15 insertions(+), 62 deletions(-)

diffs (285 lines):

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
@@ -350,7 +350,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/sslconn.h b/libpurple/sslconn.h
--- a/libpurple/sslconn.h
+++ b/libpurple/sslconn.h
@@ -68,7 +68,6 @@ typedef void (*PurpleSslErrorFunction)(P
  * @connect_data:    Data related to the underlying TCP connection
  * @private_data:    Internal connection data managed by the SSL backend
  *                   (GnuTLS/LibNSS/whatever)
- * @verifier:        Verifier to use in authenticating the peer
  */
 struct _PurpleSslConnection
 {
diff --git a/libpurple/stringref.h b/libpurple/stringref.h
--- a/libpurple/stringref.h
+++ b/libpurple/stringref.h
@@ -66,6 +66,7 @@ PurpleStringref *purple_stringref_new_no
 /**
  * purple_stringref_printf:
  * @format: A printf-style format specification.
+ * @...: The arguments for the format specification.
  *
  * Creates an immutable reference-counted string object from a printf
  * format specification and arguments.  The created object will have a
diff --git a/libpurple/stun.h b/libpurple/stun.h
--- a/libpurple/stun.h
+++ b/libpurple/stun.h
@@ -36,7 +36,10 @@ typedef struct _PurpleStunNatDiscovery P
 
 /**
  * PurpleStunStatus:
- * @PURPLE_STUN_STATUS_UNKNOWN: no STUN server reachable
+ * @PURPLE_STUN_STATUS_UNDISCOVERED: No request has been published
+ * @PURPLE_STUN_STATUS_UNKNOWN: No STUN server reachable
+ * @PURPLE_STUN_STATUS_DISCOVERING: The request has been sent to the server
+ * @PURPLE_STUN_STATUS_DISCOVERED: The server has responded
  */
 typedef enum {
 	PURPLE_STUN_STATUS_UNDISCOVERED = -1,
diff --git a/libpurple/tls-certificate.h b/libpurple/tls-certificate.h
--- a/libpurple/tls-certificate.h
+++ b/libpurple/tls-certificate.h
@@ -106,7 +106,7 @@ purple_tls_certificate_distrust(const gc
  * Connects the Purple TLS certificate subsystem to @conn so it will accept
  * certificates trusted by purple_tls_certificate_trust() and friends.
  *
- * Returns: (transfer: none) (type GObject.Object): @conn, similar to
+ * Returns: (transfer none) (type GObject.Object): @conn, similar to
  *          g_object_connect()
  */
 gpointer
@@ -120,7 +120,7 @@ purple_tls_certificate_attach_to_tls_con
  * connections it creates will accept certificates trusted by
  * purple_tls_certificate_trust() and friends.
  *
- * Returns: (transfer: none) (type GObject.Object): @client, similar to
+ * Returns: (transfer none) (type GObject.Object): @client, similar to
  *          g_object_connect()
  */
 gpointer
diff --git a/libpurple/util.h b/libpurple/util.h
--- a/libpurple/util.h
+++ b/libpurple/util.h
@@ -44,6 +44,8 @@ typedef struct _PurpleMenuAction PurpleM
 
 /**
  * PurpleKeyValuePair:
+ * @key: The key
+ * @value: The value
  *
  * A key-value pair.
  *
@@ -537,6 +539,8 @@ char *purple_uts35_to_str(const char *fo
 
 /**
  * purple_markup_escape_text:
+ * @text: The text to escape
+ * @length: The length of the text, or -1 if #NULL terminated
  *
  * Escapes special characters in a plain-text string so they display
  * correctly as HTML.  For example, &amp; is replaced with &amp;amp; and &lt; is
diff --git a/libpurple/xfer.h b/libpurple/xfer.h
--- a/libpurple/xfer.h
+++ b/libpurple/xfer.h
@@ -94,6 +94,7 @@ typedef enum
 
 /**
  * PurpleXferUiOps:
+ * @new_xfer: UI op to initialize a new transfer
  * @ui_write: UI op to write data received from the protocol. The UI must deal
  *            with the entire buffer and return size, or it is treated as an
  *            error.

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