/soc/2013/ankitkv/gobjectification: dae0efb2f25f: Convert doxyge...
Ankit Vani
a at nevitus.org
Thu Jan 30 15:47:03 EST 2014
Changeset: dae0efb2f25f56dfb4b6c45c0f1560a8b3826997
Author: Ankit Vani <a at nevitus.org>
Date: 2014-01-31 02:16 +0530
Branch: soc.2013.gobjectification.gtkdoc
URL: https://hg.pidgin.im/soc/2013/ankitkv/gobjectification/rev/dae0efb2f25f
Description:
Convert doxygen comments to gtk-doc format for mime, nat-pmp, ntlm, plugins, protocols
diffstat:
libpurple/mime.h | 121 ++++++++-----
libpurple/nat-pmp.h | 19 +-
libpurple/ntlm.h | 19 +-
libpurple/plugins.h | 335 +++++++++++++++++++++++++--------------
libpurple/protocol.h | 222 ++++++++++++--------------
libpurple/protocols.h | 416 +++++++++++++++++++++++++++----------------------
6 files changed, 639 insertions(+), 493 deletions(-)
diffs (truncated from 2786 to 300 lines):
diff --git a/libpurple/mime.h b/libpurple/mime.h
--- a/libpurple/mime.h
+++ b/libpurple/mime.h
@@ -1,3 +1,11 @@
+/**
+ * @file mime.h
+ * @ingroup core
+ *
+ * Rudimentary parsing of multi-part MIME messages into more
+ * accessible structures.
+ */
+
/*
* Purple
*
@@ -27,19 +35,15 @@
#include <glib.h>
/**
- * @file mime.h
- * @ingroup core
+ * PurpleMimeDocument:
*
- * Rudimentary parsing of multi-part MIME messages into more
- * accessible structures.
- */
-
-/**
* A MIME document.
*/
typedef struct _PurpleMimeDocument PurpleMimeDocument;
/**
+ * PurpleMimePart:
+ *
* A part of a multipart MIME document.
*/
typedef struct _PurpleMimePart PurpleMimePart;
@@ -47,117 +51,133 @@ typedef struct _PurpleMimePart PurpleMim
G_BEGIN_DECLS
/**
+ * purple_mime_document_new:
+ *
* Allocate an empty MIME document.
*/
PurpleMimeDocument *purple_mime_document_new(void);
/**
+ * purple_mime_document_free:
+ * @doc: The MIME document to free.
+ *
* Frees memory used in a MIME document and all of its parts and fields
- *
- * @doc: The MIME document to free.
*/
void purple_mime_document_free(PurpleMimeDocument *doc);
/**
+ * purple_mime_document_parse:
+ * @buf: The NULL-terminated string containing the MIME-encoded data.
+ *
* Parse a MIME document from a NUL-terminated string.
*
- * @buf: The NULL-terminated string containing the MIME-encoded data.
- *
- * Returns:s A MIME document.
+ * Returns: A MIME document.
*/
PurpleMimeDocument *purple_mime_document_parse(const char *buf);
/**
- * Parse a MIME document from a string
- *
+ * purple_mime_document_parsen:
* @buf: The string containing the MIME-encoded data.
* @len: Length of buf.
*
- * Returns:s A MIME document.
+ * Parse a MIME document from a string
+ *
+ * Returns: A MIME document.
*/
PurpleMimeDocument *purple_mime_document_parsen(const char *buf, gsize len);
/**
+ * purple_mime_document_write:
+ *
* Write (append) a MIME document onto a GString.
*/
void purple_mime_document_write(PurpleMimeDocument *doc, GString *str);
/**
+ * purple_mime_document_get_fields:
+ * @doc: The MIME document.
+ *
* The list of fields in the header of a document
*
- * @doc: The MIME document.
- *
- * Returns: (transfer none): A list of strings indicating the fields (but not the values
- * of the fields) in the header of doc.
+ * Returns: (transfer none): A list of strings indicating the fields (but not
+ * the values of the fields) in the header of doc.
*/
GList *purple_mime_document_get_fields(PurpleMimeDocument *doc);
/**
- * Get the value of a specific field in the header of a document.
- *
+ * purple_mime_document_get_field:
* @doc: The MIME document.
* @field: Case-insensitive field name.
*
- * Returns:s Value associated with the indicated header field, or
+ * Get the value of a specific field in the header of a document.
+ *
+ * Returns: Value associated with the indicated header field, or
* NULL if the field doesn't exist.
*/
const char *purple_mime_document_get_field(PurpleMimeDocument *doc,
const char *field);
/**
- * Set or replace the value of a specific field in the header of a
- * document.
- *
+ * purple_mime_document_set_field:
* @doc: The MIME document.
* @field: Case-insensitive field name.
* @value: Value to associate with the indicated header field,
* of NULL to remove the field.
+ *
+ * Set or replace the value of a specific field in the header of a
+ * document.
*/
void purple_mime_document_set_field(PurpleMimeDocument *doc,
const char *field,
const char *value);
/**
+ * purple_mime_document_get_parts:
+ * @doc: The MIME document.
+ *
* The list of parts in a multipart document.
*
- * @doc: The MIME document.
- *
* Returns: (transfer none): List of PurpleMimePart contained within doc.
*/
GList *purple_mime_document_get_parts(PurpleMimeDocument *doc);
/**
+ * purple_mime_part_new:
+ * @doc: The new part's parent MIME document.
+ *
* Create and insert a new part into a MIME document.
- *
- * @doc: The new part's parent MIME document.
*/
PurpleMimePart *purple_mime_part_new(PurpleMimeDocument *doc);
/**
+ * purple_mime_part_get_fields:
+ * @part: The MIME document part.
+ *
* The list of fields in the header of a document part.
*
- * @part: The MIME document part.
- *
- * Returns: (transfer none): List of strings indicating the fields (but not the values
- * of the fields) in the header of part.
+ * Returns: (transfer none): List of strings indicating the fields (but not the
+ * values of the fields) in the header of part.
*/
GList *purple_mime_part_get_fields(PurpleMimePart *part);
/**
- * Get the value of a specific field in the header of a document part.
- *
+ * purple_mime_part_get_field:
* @part: The MIME document part.
* @field: Case-insensitive name of the header field.
*
- * Returns:s Value of the specified header field, or NULL if the
+ * Get the value of a specific field in the header of a document part.
+ *
+ * Returns: Value of the specified header field, or NULL if the
* field doesn't exist.
*/
const char *purple_mime_part_get_field(PurpleMimePart *part,
const char *field);
/**
+ * purple_mime_part_get_field_decoded:
+ *
* Get the decoded value of a specific field in the header of a
* document part.
*/
@@ -165,45 +185,50 @@ char *purple_mime_part_get_field_decoded
const char *field);
/**
- * Set or replace the value of a specific field in the header of a
- * document.
- *
+ * purple_mime_part_set_field:
* @part: The part of the MIME document.
* @field: Case-insensitive field name
* @value: Value to associate with the indicated header field,
* of NULL to remove the field.
+ *
+ * Set or replace the value of a specific field in the header of a
+ * document.
*/
void purple_mime_part_set_field(PurpleMimePart *part,
const char *field,
const char *value);
/**
+ * purple_mime_part_get_data:
+ * @part: The MIME document part.
+ *
* Get the (possibly encoded) data portion of a MIME document part.
*
- * @part: The MIME document part.
- *
- * Returns:s NULL-terminated data found in the document part
+ * Returns: NULL-terminated data found in the document part
*/
const char *purple_mime_part_get_data(PurpleMimePart *part);
/**
+ * purple_mime_part_get_data_decoded:
+ * @part: The MIME documemt part.
+ * @data: Buffer for the data.
+ * @len: The length of the buffer.
+ *
* Get the data portion of a MIME document part, after attempting to
* decode it according to the content-transfer-encoding field. If the
* specified encoding method is not supported, this function will
* return NULL.
- *
- * @part: The MIME documemt part.
- * @data: Buffer for the data.
- * @len: The length of the buffer.
*/
void purple_mime_part_get_data_decoded(PurpleMimePart *part,
guchar **data, gsize *len);
/**
+ * purple_mime_part_get_length:
+ * @part: The MIME document part.
+ *
* Get the length of the data portion of a MIME document part.
*
- * @part: The MIME document part.
- * Returns:s Length of the data in the document part.
+ * Returns: Length of the data in the document part.
*/
gsize purple_mime_part_get_length(PurpleMimePart *part);
diff --git a/libpurple/nat-pmp.h b/libpurple/nat-pmp.h
--- a/libpurple/nat-pmp.h
+++ b/libpurple/nat-pmp.h
@@ -44,36 +44,37 @@ typedef enum {
G_BEGIN_DECLS
/**
+ * purple_pmp_init:
+ *
* Initialize nat-pmp
*/
void purple_pmp_init(void);
-/**
- *
- */
char *purple_pmp_get_public_ip(void);
/**
- * Remove the NAT-PMP mapping for a specified type on a specified port
- *
+ * purple_pmp_create_map:
* @type: The PurplePmpType
* @privateport: The private port on which we are listening locally
* @publicport: The public port on which we are expecting a response
* @lifetime: The lifetime of the mapping. It is recommended that this
* be PURPLE_PMP_LIFETIME.
*
- * Returns:s TRUE if successful; FALSE if unsuccessful
+ * Remove the NAT-PMP mapping for a specified type on a specified port
+ *
+ * Returns: TRUE if successful; FALSE if unsuccessful
*/
gboolean purple_pmp_create_map(PurplePmpType type, unsigned short privateport,
unsigned short publicport, int lifetime);
More information about the Commits
mailing list