/soc/2013/ankitkv/gobjectification: 6eae3b385153: Convert docs f...
Ankit Vani
a at nevitus.org
Sat Feb 1 06:09:36 EST 2014
Changeset: 6eae3b385153b830686dcdd0fe69631a314ba00c
Author: Ankit Vani <a at nevitus.org>
Date: 2014-02-01 16:38 +0530
Branch: gtkdoc-conversion
URL: https://hg.pidgin.im/soc/2013/ankitkv/gobjectification/rev/6eae3b385153
Description:
Convert docs from doxygen to gtk-doc format for purple-socket to smiley
diffstat:
libpurple/purple-socket.h | 88 ++++++++++-------
libpurple/request-datasheet.h | 151 +++++++++++++++++++------------
libpurple/roomlist.h | 200 +++++++++++++++++++++++++++--------------
libpurple/savedstatuses.h | 162 +++++++++++++++++++++------------
libpurple/server.h | 81 ++++++++++------
libpurple/signals.h | 153 +++++++++++++++++++-------------
libpurple/smiley.h | 96 ++++++++++++-------
7 files changed, 578 insertions(+), 353 deletions(-)
diffs (truncated from 2369 to 300 lines):
diff --git a/libpurple/purple-socket.h b/libpurple/purple-socket.h
--- a/libpurple/purple-socket.h
+++ b/libpurple/purple-socket.h
@@ -30,77 +30,86 @@
#include "connection.h"
/**
+ * PurpleSocket:
+ *
* A structure holding all resources needed for the TCP connection.
*/
typedef struct _PurpleSocket PurpleSocket;
/**
- * A callback fired after (successfully or not) establishing a connection.
- *
+ * PurpleSocketConnectCb:
* @ps: The socket.
* @error: Error message, or NULL if connection was successful.
* @user_data: The user data passed with callback function.
+ *
+ * A callback fired after (successfully or not) establishing a connection.
*/
typedef void (*PurpleSocketConnectCb)(PurpleSocket *ps, const gchar *error,
gpointer user_data);
/**
+ * purple_socket_new:
+ * @gc: The connection for which the socket is needed, or NULL.
+ *
* Creates new, disconnected socket.
*
* Passing a PurpleConnection allows for proper proxy handling.
*
- * @gs: The connection for which the socket is needed, or NULL.
- *
* Returns: The new socket struct.
*/
PurpleSocket *
purple_socket_new(PurpleConnection *gc);
/**
+ * purple_socket_get_connection:
+ * @ps: The socket.
+ *
* Gets PurpleConnection tied with specified socket.
*
- * @ps: The socket.
- *
* Returns: The PurpleConnection object.
*/
PurpleConnection *
purple_socket_get_connection(PurpleSocket *ps);
/**
- * Determines, if socket should handle TLS.
- *
+ * purple_socket_set_tls:
* @ps: The socket.
* @is_tls: TRUE, if TLS should be handled transparently, FALSE otherwise.
+ *
+ * Determines, if socket should handle TLS.
*/
void
purple_socket_set_tls(PurpleSocket *ps, gboolean is_tls);
/**
- * Sets connection host.
- *
+ * purple_socket_set_host:
* @ps: The socket.
* @host: The connection host.
+ *
+ * Sets connection host.
*/
void
purple_socket_set_host(PurpleSocket *ps, const gchar *host);
/**
- * Sets connection port.
- *
+ * purple_socket_set_port:
* @ps: The socket.
* @port: The connection port.
+ *
+ * Sets connection port.
*/
void
purple_socket_set_port(PurpleSocket *ps, int port);
/**
- * Establishes a connection.
- *
+ * purple_socket_connect:
* @ps: The socket.
* @cb: The function to call after establishing a connection, or on
* error.
* @user_data: The user data to be passed to callback function.
*
+ * Establishes a connection.
+ *
* Returns: TRUE on success (this doesn't mean it's connected yet), FALSE
* otherwise.
*/
@@ -109,90 +118,97 @@ purple_socket_connect(PurpleSocket *ps,
gpointer user_data);
/**
+ * purple_socket_read:
+ * @ps: The socket.
+ * @buf: The buffer to write data to.
+ * @len: The buffer size.
+ *
* Reads incoming data from socket.
*
* This function deals with TLS, if the socket is configured to do it.
*
- * @ps: The socket.
- * @buf: The buffer to write data to.
- * @len: The buffer size.
- *
* Returns: Amount of data written, or -1 on error (errno will be also be set).
*/
gssize
purple_socket_read(PurpleSocket *ps, guchar *buf, size_t len);
/**
+ * purple_socket_write:
+ * @ps: The socket.
+ * @buf: The buffer to read data from.
+ * @len: The amount of data to read and send.
+ *
* Sends data through socket.
*
* This function deals with TLS, if the socket is configured to do it.
*
- * @ps: The socket.
- * @buf: The buffer to read data from.
- * @len: The amount of data to read and send.
- *
- * @Amount: of data sent, or -1 on error (errno will albo be set).
+ * Returns: Amount of data sent, or -1 on error (errno will albo be set).
*/
gssize
purple_socket_write(PurpleSocket *ps, const guchar *buf, size_t len);
/**
- * Adds an input handler for the socket.
- *
- * If the specified socket had input handler already registered, it will be
- * removed. To remove any input handlers, pass an NULL handler function.
- *
+ * purple_socket_watch:
* @ps: The socket.
* @cond: The condition type.
* @func: The callback function for data, or NULL to remove any
* existing callbacks.
* @user_data: The user data to be passed to callback function.
+ *
+ * Adds an input handler for the socket.
+ *
+ * If the specified socket had input handler already registered, it will be
+ * removed. To remove any input handlers, pass an NULL handler function.
*/
void
purple_socket_watch(PurpleSocket *ps, PurpleInputCondition cond,
PurpleInputFunction func, gpointer user_data);
/**
+ * purple_socket_get_fd:
+ * @ps: The socket
+ *
* Gets underlying file descriptor for socket.
*
* It's not meant to read/write data (use purple_socket_read/
* purple_socket_write), rather for watching for changes with select().
*
- * @ps: The socket
- *
* Returns: The file descriptor, or -1 on error.
*/
int
purple_socket_get_fd(PurpleSocket *ps);
/**
- * Sets extra data for a socket.
- *
+ * purple_socket_set_data:
* @ps: The socket.
* @key: The unique key.
* @data: The data to assign, or NULL to remove.
+ *
+ * Sets extra data for a socket.
*/
void
purple_socket_set_data(PurpleSocket *ps, const gchar *key, gpointer data);
/**
- * Returns extra data in a socket.
- *
+ * purple_socket_get_data:
* @ps: The socket.
* @key: The unqiue key.
*
+ * Returns extra data in a socket.
+ *
* Returns: The data associated with the key.
*/
gpointer
purple_socket_get_data(PurpleSocket *ps, const gchar *key);
/**
+ * purple_socket_destroy:
+ * @ps: The socket.
+ *
* Destroys the socket, closes connection and frees all resources.
*
* If file descriptor for the socket was extracted with purple_socket_get_fd and
* added to event loop, it have to be removed prior this.
- *
- * @ps: The socket.
*/
void
purple_socket_destroy(PurpleSocket *ps);
diff --git a/libpurple/request-datasheet.h b/libpurple/request-datasheet.h
--- a/libpurple/request-datasheet.h
+++ b/libpurple/request-datasheet.h
@@ -51,6 +51,8 @@ G_BEGIN_DECLS
/*@{*/
/**
+ * purple_request_datasheet_new:
+ *
* Creates new Datasheet.
*
* Returns: The new datasheet.
@@ -59,42 +61,46 @@ PurpleRequestDatasheet *
purple_request_datasheet_new(void);
/**
+ * purple_request_datasheet_free:
+ * @sheet: The datasheet.
+ *
* Destroys datasheet with all its contents.
- *
- * @sheet: The datasheet.
*/
void
purple_request_datasheet_free(PurpleRequestDatasheet *sheet);
/**
+ * purple_request_datasheet_add_column:
+ * @sheet: The datasheet.
+ * @type: The column type.
+ * @title: The column title (may be %NULL).
+ *
* Adds a column to the datasheet.
*
* You cannot add a column if datasheet contains any data.
- *
- * @sheet: The datasheet.
- * @type: The column type.
- * @title: The column title (may be %NULL).
*/
void
purple_request_datasheet_add_column(PurpleRequestDatasheet *sheet,
PurpleRequestDatasheetColumnType type, const gchar *title);
/**
+ * purple_request_datasheet_get_column_count:
+ * @sheet: The datasheet.
+ *
* Returns the column count of datasheet.
*
- * @sheet: The datasheet.
- *
* Returns: The column count.
*/
guint
purple_request_datasheet_get_column_count(PurpleRequestDatasheet *sheet);
/**
- * Returns the column type for a datasheet.
- *
+ * purple_request_datasheet_get_column_type:
* @sheet: The datasheet.
* @col_no: The column number (0 is the first one).
*
+ * Returns the column type for a datasheet.
+ *
* Returns: The column type.
*/
PurpleRequestDatasheetColumnType
@@ -102,11 +108,12 @@ purple_request_datasheet_get_column_type
guint col_no);
/**
- * Returns the column title for a datasheet.
- *
+ * purple_request_datasheet_get_column_title:
More information about the Commits
mailing list