/soc/2013/ankitkv/gobjectification: 774b0a0593f0: Merge gtkdoc-c...

Ankit Vani a at nevitus.org
Tue Feb 4 17:16:53 EST 2014


Changeset: 774b0a0593f08468b264d2ea527d5b080e156baa
Author:	 Ankit Vani <a at nevitus.org>
Date:	 2014-02-05 03:46 +0530
Branch:	 soc.2013.gobjectification.plugins
URL: https://hg.pidgin.im/soc/2013/ankitkv/gobjectification/rev/774b0a0593f0

Description:

Merge gtkdoc-conversion

diffstat:

 configure.ac                  |    2 +-
 libpurple/certificate.h       |  188 ++++++++++++++++-------------------------
 libpurple/connection.h        |   93 +++++++++-----------
 libpurple/conversation.c      |   23 ++--
 libpurple/conversation.h      |  114 ++++++++++++-------------
 libpurple/conversations.c     |    2 +-
 libpurple/conversationtypes.c |   65 ++++++-------
 libpurple/conversationtypes.h |    7 +-
 libpurple/core.h              |   44 ++++-----
 libpurple/dbus-server.c       |    2 +-
 libpurple/desktopitem.c       |    6 +-
 libpurple/dnsquery.c          |   12 +-
 libpurple/dnsquery.h          |   17 ++-
 libpurple/dnssrv.c            |   27 +++--
 libpurple/dnssrv.h            |   21 ++--
 libpurple/glibcompat.h        |    2 +-
 16 files changed, 287 insertions(+), 338 deletions(-)

diffs (truncated from 1143 to 300 lines):

diff --git a/configure.ac b/configure.ac
--- a/configure.ac
+++ b/configure.ac
@@ -556,7 +556,7 @@ Use --without-x if you do not need X11 s
 			else
 				if test "x$force_deps" = "xyes" ; then
 					AC_MSG_ERROR([
-XScreenSaver extension development headers not found.
+XScreenSaver extension development headers (libXScrnSaver-devel) not found.
 Use --disable-screensaver if you do not need XScreenSaver extension support,
 this is required for detecting idle time by mouse and keyboard usage.
 ])
diff --git a/libpurple/certificate.h b/libpurple/certificate.h
--- a/libpurple/certificate.h
+++ b/libpurple/certificate.h
@@ -74,6 +74,8 @@ typedef enum
 	PURPLE_CERTIFICATE_INVALID_CHAIN = 0x10000,
 	PURPLE_CERTIFICATE_REVOKED = 0x20000,
 	PURPLE_CERTIFICATE_REJECTED = 0x40000,
+
+	/*< private >*/
 	PURPLE_CERTIFICATE_LAST = 0x80000,
 } PurpleCertificateVerificationStatus;
 
@@ -169,154 +171,114 @@ struct _PurpleCertificatePool
 
 /**
  * PurpleCertificateScheme:
+ * @name: Name of the certificate type. ex: "x509", "pgp", etc.
+ *        <sbr/> This must be globally unique - you may not register more than
+ *        one CertificateScheme of the same name at a time.
+ * @fullname: User-friendly name for this type. ex: N_("X.509 Certificates")
+ *            <sbr/> When this is displayed anywhere, it should be i18ned. ex:
+ *            _(scheme->fullname)
+ * @import_certificate: Imports a certificate from a file
+ *                      <sbr/> @filename: File to import the certificate from
+ *                      <sbr/> Returns: Pointer to the newly allocated
+ *                      Certificate struct or NULL on failure.
+ * @export_certificate: Exports a certificate to a file.
+ *                      <sbr/>See purple_certificate_export().
+ *                      <sbr/>@filename: File to export the certificate to
+ *                      <sbr/>@crt:      Certificate to export
+ *                      <sbr/>Returns:   %TRUE if the export succeeded,
+ *                                       otherwise %FALSE
+ * @copy_certificate: Duplicates a certificate
+ *                    <sbr/>Certificates are generally assumed to be read-only,
+ *                    so feel free to do any sort of reference-counting magic
+ *                    you want here. If this ever changes, please remember to
+ *                    change the magic accordingly.
+ *                    <sbr/>Returns: Reference to the new copy
+ * @destroy_certificate: Destroys and frees a Certificate structure
+ *                       <sbr/> Destroys a Certificate's internal data
+ *                       structures and calls free(@crt)
+ *                       <sbr/> @crt:  Certificate instance to be destroyed.
+ *                       It <emphasis>WILL NOT</emphasis> be destroyed if it is
+ *                       not of the correct CertificateScheme. Can be %NULL.
+ * @signed_by: Find whether "crt" has a valid signature from issuer "issuer".
+ *             <sbr/>See purple_certificate_signed_by().
+ * @get_fingerprint_sha1: Retrieves the certificate public key fingerprint using
+ *                        SHA1
+ *                        <sbr/>@crt:    Certificate instance
+ *                        <sbr/>Returns: Binary representation of SHA1 hash -
+ *                                       must be freed using g_byte_array_free().
+ * @get_unique_id: Retrieves a unique certificate identifier
+ *                 <sbr/>@crt:    Certificate instance
+ *                 <sbr/>Returns: Newly allocated string that can be used to
+ *                                uniquely identify the certificate.
+ * @get_issuer_unique_id: Retrieves a unique identifier for the certificate's
+ *                        issuer
+ *                        <sbr/>@crt:    Certificate instance
+ *                        <sbr/>Returns: Newly allocated string that can be used
+ *                                       to uniquely identify the issuer's
+ *                                       certificate.
+ * @get_subject_name: Gets the certificate subject's name
+ *                    <sbr/>For X.509, this is the "Common Name" field, as we're
+ *                    only using it for hostname verification at the moment.
+ *                    <sbr/>See purple_certificate_get_subject_name().
+ *                    <sbr/>@crt:    Certificate instance
+ *                    <sbr/>Returns: Newly allocated string with the certificate
+ *                                   subject.
+ * @check_subject_name: Check the subject name against that on the certificate
+ *                      <sbr/>See purple_certificate_check_subject_name().
+ *                      <sbr/>Returns: %TRUE if it is a match, else %FALSE
+ * @get_times: Retrieve the certificate activation/expiration times
+ * @import_certificates: Imports certificates from a file
+ *                       <sbr/> @filename: File to import the certificates from
+ *                       <sbr/> Returns:   #GSList of pointers to the newly
+ *                                         allocated Certificate structs or
+ *                                         %NULL on failure.
+ * @get_der_data: Retrieves the certificate data in DER form
+ *                <sbr/>@crt:    Certificate instance
+ *                <sbr/>Returns: Binary DER representation of certificate - must
+ *                               be freed using g_byte_array_free().
+ * @get_display_string: Retrieves a string representation of the certificate
+ *                      suitable for display
+ *                      <sbr/>@crt:   Certificate instance
+ *                      <sbr/>Returns: User-displayable string representation of
+ *                                     certificate - must be freed using
+ *                                     g_free().
  *
  * A certificate type.
  *
  * A CertificateScheme must implement all of the fields in the structure,
  * and register it using purple_certificate_register_scheme().
  *
- * There may be only ONE CertificateScheme provided for each certificate
- * type, as specified by the "name" field.
+ * There may be only <emphasis>ONE</emphasis> CertificateScheme provided for
+ * each certificate type, as specified by the "name" field.
  */
 struct _PurpleCertificateScheme
 {
-	/** Name of the certificate type
-	 *  ex: "x509", "pgp", etc.
-	 *  This must be globally unique - you may not register more than one
-	 *  CertificateScheme of the same name at a time.
-	 */
 	gchar * name;
-
-	/** User-friendly name for this type
-	 *  ex: N_("X.509 Certificates")
-	 *  When this is displayed anywhere, it should be i18ned
-	 *  ex: _(scheme->fullname)
-	 */
 	gchar * fullname;
 
-	/** Imports a certificate from a file
-	 *
-	 *  @filename:   File to import the certificate from
-	 *  Returns:           Pointer to the newly allocated Certificate struct
-	 *                    or NULL on failure.
-	 */
 	PurpleCertificate * (* import_certificate)(const gchar * filename);
-
-	/**
-	 * Exports a certificate to a file
-	 *
-	 * @filename:    File to export the certificate to
-	 * @crt:         Certificate to export
-	 * Returns: TRUE if the export succeeded, otherwise FALSE
-	 * @see purple_certificate_export()
-	 */
 	gboolean (* export_certificate)(const gchar *filename, PurpleCertificate *crt);
 
-	/**
-	 * Duplicates a certificate
-	 *
-	 * Certificates are generally assumed to be read-only, so feel free to
-	 * do any sort of reference-counting magic you want here. If this ever
-	 * changes, please remember to change the magic accordingly.
-	 * Returns: Reference to the new copy
-	 */
 	PurpleCertificate * (* copy_certificate)(PurpleCertificate *crt);
-
-	/** Destroys and frees a Certificate structure
-	 *
-	 *  Destroys a Certificate's internal data structures and calls
-	 *  free(crt)
-	 *
-	 *  @crt:  Certificate instance to be destroyed. It WILL NOT be
-	 *              destroyed if it is not of the correct
-	 *              CertificateScheme. Can be NULL
-	 */
 	void (* destroy_certificate)(PurpleCertificate * crt);
 
-	/** Find whether "crt" has a valid signature from issuer "issuer"
-	 *  @see purple_certificate_signed_by() */
 	gboolean (*signed_by)(PurpleCertificate *crt, PurpleCertificate *issuer);
-	/**
-	 * Retrieves the certificate public key fingerprint using SHA1
-	 *
-	 * @crt:   Certificate instance
-	 * Returns: Binary representation of SHA1 hash - must be freed using
-	 *         g_byte_array_free()
-	 */
 	GByteArray * (* get_fingerprint_sha1)(PurpleCertificate *crt);
-
-	/**
-	 * Retrieves a unique certificate identifier
-	 *
-	 * @crt:   Certificate instance
-	 * Returns: Newly allocated string that can be used to uniquely
-	 *         identify the certificate.
-	 */
 	gchar * (* get_unique_id)(PurpleCertificate *crt);
-
-	/**
-	 * Retrieves a unique identifier for the certificate's issuer
-	 *
-	 * @crt:   Certificate instance
-	 * Returns: Newly allocated string that can be used to uniquely
-	 *         identify the issuer's certificate.
-	 */
 	gchar * (* get_issuer_unique_id)(PurpleCertificate *crt);
 
-	/**
-	 * Gets the certificate subject's name
-	 *
-	 * For X.509, this is the "Common Name" field, as we're only using it
-	 * for hostname verification at the moment
-	 *
-	 * @see purple_certificate_get_subject_name()
-	 *
-	 * @crt:   Certificate instance
-	 * Returns: Newly allocated string with the certificate subject.
-	 */
 	gchar * (* get_subject_name)(PurpleCertificate *crt);
-
-	/**
-	 * Check the subject name against that on the certificate
-	 * @see purple_certificate_check_subject_name()
-	 * Returns: TRUE if it is a match, else FALSE
-	 */
 	gboolean (* check_subject_name)(PurpleCertificate *crt, const gchar *name);
 
-	/** Retrieve the certificate activation/expiration times */
 	gboolean (* get_times)(PurpleCertificate *crt, gint64 *activation, gint64 *expiration);
 
-	/** Imports certificates from a file
-	 *
-	 *  @filename:   File to import the certificates from
-	 *  Returns:           GSList of pointers to the newly allocated Certificate structs
-	 *                    or NULL on failure.
-	 */
 	GSList * (* import_certificates)(const gchar * filename);
-
-	/**
-	 * Retrieves the certificate data in DER form
-	 *
-	 * @crt:   Certificate instance
-	 * Returns: Binary DER representation of certificate - must be freed using
-	 *         g_byte_array_free()
-	 */
 	GByteArray * (* get_der_data)(PurpleCertificate *crt);
 
-	/**
-	 * Retrieves a string representation of the certificate suitable for display
-	 *
-	 * @crt:   Certificate instance
-	 * Returns: User-displayable string representation of certificate - must be
-	 *         freed using g_free().
-	 */
 	gchar * (* get_display_string)(PurpleCertificate *crt);
 
 	/*< private >*/
 	void (*_purple_reserved1)(void);
-	void (*_purple_reserved2)(void);
-	void (*_purple_reserved3)(void);
-	void (*_purple_reserved4)(void);
 };
 
 /**
diff --git a/libpurple/connection.h b/libpurple/connection.h
--- a/libpurple/connection.h
+++ b/libpurple/connection.h
@@ -41,6 +41,8 @@
 typedef struct _PurpleConnection PurpleConnection;
 typedef struct _PurpleConnectionClass PurpleConnectionClass;
 
+typedef struct _PurpleConnectionUiOps PurpleConnectionUiOps;
+
 /**
  * PurpleConnectionFlags:
  * @PURPLE_CONNECTION_FLAG_HTML: Connection sends/receives in 'HTML'
@@ -190,72 +192,58 @@ typedef struct
 
 /**
  * PurpleConnectionUiOps:
+ * @connect_progress: When an account is connecting, this operation is called to
+ *                    notify the UI of what is happening, as well as which @step
+ *                    out of @step_count has been reached (which might be
+ *                    displayed as a progress bar).
+ *                    <sbr/>See purple_connection_update_progress().
+ * @connected: Called when a connection is established (just before the
+ *   <link linkend="connections-signed-on"><literal>"signed-on"</literal></link>
+ *             signal).
+ * @disconnected: Called when a connection is ended (between the
+ *   <link linkend="connections-signing-off"><literal>"signing-off"</literal></link>
+ *   and <link linkend="connections-signed-off"><literal>"signed-off"</literal></link>
+ *                signals).
+ * @notice: Used to display connection-specific notices. (Pidgin's Gtk user
+ *          interface implements this as a no-op; purple_connection_notice(),
+ *          which uses this operation, is not used by any of the protocols
+ *          shipped with libpurple.)
+ * @network_connected: Called when libpurple discovers that the computer's
+ *                     network connection is active.  On Linux, this uses
+ *                     Network Manager if available; on Windows, it uses
+ *                     Win32's network change notification infrastructure.
+ * @network_disconnected: Called when libpurple discovers that the computer's
+ *                        network connection has gone away.
+ * @report_disconnect: Called when an error causes a connection to be
+ *                     disconnected. Called before @disconnected.
+ *                     <sbr/>See purple_connection_error().
+ *                     <sbr/>@reason: why the connection ended, if known, or
+ *                                 #PURPLE_CONNECTION_ERROR_OTHER_ERROR, if not.
+ *                     <sbr/>@text:   a localized message describing the
+ *                                 disconnection in more detail to the user.
  *
  * Connection UI operations.  Used to notify the user of changes to
  * connections, such as being disconnected, and to respond to the



More information about the Commits mailing list