/soc/2013/ankitkv/gobjectification: 9282701d7aa9: Convert docs f...
Ankit Vani
a at nevitus.org
Sat Feb 1 06:58:01 EST 2014
Changeset: 9282701d7aa9cc00808c6853c328c3e88c4cd057
Author: Ankit Vani <a at nevitus.org>
Date: 2014-02-01 17:25 +0530
Branch: gtkdoc-conversion
URL: https://hg.pidgin.im/soc/2013/ankitkv/gobjectification/rev/9282701d7aa9
Description:
Convert docs from doxygen to gtk-doc format for sound-theme-loader to xmlnode
diffstat:
libpurple/sound-theme-loader.h | 14 +-
libpurple/sound-theme.h | 22 ++-
libpurple/sound.h | 71 ++++++++++----
libpurple/sslconn.h | 127 +++++++++++++++----------
libpurple/stringref.h | 47 +++++----
libpurple/stun.h | 15 ++-
libpurple/theme-loader.h | 24 +++-
libpurple/theme-manager.h | 44 ++++++--
libpurple/theme.h | 67 ++++++++-----
libpurple/upnp.h | 40 +++++---
libpurple/whiteboard.h | 158 +++++++++++++++++++------------
libpurple/xmlnode.h | 200 ++++++++++++++++++++++++++--------------
12 files changed, 520 insertions(+), 309 deletions(-)
diffs (truncated from 2049 to 300 lines):
diff --git a/libpurple/sound-theme-loader.h b/libpurple/sound-theme-loader.h
--- a/libpurple/sound-theme-loader.h
+++ b/libpurple/sound-theme-loader.h
@@ -30,12 +30,6 @@
#include <glib-object.h>
#include "theme-loader.h"
-/**
- * A purple sound theme loader. extends PurpleThemeLoader (theme-loader.h)
- * This is a class designed to build sound themes
- *
- * PurpleSoundThemeLoader is a GObject.
- */
typedef struct _PurpleSoundThemeLoader PurpleSoundThemeLoader;
typedef struct _PurpleSoundThemeLoaderClass PurpleSoundThemeLoaderClass;
@@ -46,6 +40,12 @@ typedef struct _PurpleSoundThemeLoaderCl
#define PURPLE_IS_SOUND_THEME_LOADER_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass), PURPLE_TYPE_SOUND_THEME_LOADER))
#define PURPLE_SOUND_THEME_LOADER_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS((obj), PURPLE_TYPE_SOUND_THEME_LOADER, PurpleSoundThemeLoaderClass))
+/**
+ * PurpleSoundThemeLoader:
+ *
+ * A purple sound theme loader. extends PurpleThemeLoader (theme-loader.h)
+ * This is a class designed to build sound themes
+ */
struct _PurpleSoundThemeLoader
{
PurpleThemeLoader parent;
@@ -68,6 +68,8 @@ struct _PurpleSoundThemeLoaderClass
G_BEGIN_DECLS
/**
+ * purple_sound_theme_loader_get_type:
+ *
* GObject foo.
* @internal.
*/
diff --git a/libpurple/sound-theme.h b/libpurple/sound-theme.h
--- a/libpurple/sound-theme.h
+++ b/libpurple/sound-theme.h
@@ -31,9 +31,7 @@
#include "theme.h"
#include "sound.h"
-/** @copydoc _PurpleSoundTheme */
typedef struct _PurpleSoundTheme PurpleSoundTheme;
-/** @copydoc _PurpleSoundThemeClass */
typedef struct _PurpleSoundThemeClass PurpleSoundThemeClass;
#define PURPLE_TYPE_SOUND_THEME (purple_sound_theme_get_type())
@@ -44,6 +42,8 @@ typedef struct _PurpleSoundThemeClass
#define PURPLE_SOUND_THEME_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS((obj), PURPLE_TYPE_SOUND_THEME, PurpleSoundThemeClass))
/**
+ * PurpleSoundTheme:
+ *
* A purple sound theme.
* This is an object for Purple to represent a sound theme.
*/
@@ -70,28 +70,32 @@ struct _PurpleSoundThemeClass
G_BEGIN_DECLS
/**
+ * purple_sound_theme_get_type:
+ *
* GObject foo.
* @internal.
*/
GType purple_sound_theme_get_type(void);
/**
- * Returns a copy of the filename for the sound event.
- *
+ * purple_sound_theme_get_file:
* @theme: The theme.
* @event: The purple sound event to look up.
*
+ * Returns a copy of the filename for the sound event.
+ *
* Returns: The filename of the sound event.
*/
const gchar *purple_sound_theme_get_file(PurpleSoundTheme *theme,
const gchar *event);
/**
- * Returns a copy of the directory and filename for the sound event
- *
+ * purple_sound_theme_get_file_full:
* @theme: The theme.
* @event: The purple sound event to look up
*
+ * Returns a copy of the directory and filename for the sound event
+ *
* Returns: The directory + '/' + filename of the sound event. This is
* a newly allocated string that should be freed with g_free.
*/
@@ -99,15 +103,17 @@ gchar *purple_sound_theme_get_file_full(
const gchar *event);
/**
- * Sets the filename for a given sound event
- *
+ * purple_sound_theme_set_file:
* @theme: The theme.
* @event: the purple sound event to look up
* @filename: the name of the file to be used for the event
+ *
+ * Sets the filename for a given sound event
*/
void purple_sound_theme_set_file(PurpleSoundTheme *theme,
const gchar *event,
const gchar *filename);
G_END_DECLS
+
#endif /* PURPLE_SOUND_THEME_H */
diff --git a/libpurple/sound.h b/libpurple/sound.h
--- a/libpurple/sound.h
+++ b/libpurple/sound.h
@@ -35,29 +35,47 @@
/**
+ * PurpleSoundEventID:
+ * @PURPLE_SOUND_BUDDY_ARRIVE: Buddy signs on.
+ * @PURPLE_SOUND_BUDDY_LEAVE: Buddy signs off.
+ * @PURPLE_SOUND_RECEIVE: Receive an IM.
+ * @PURPLE_SOUND_FIRST_RECEIVE: Receive an IM that starts a conv.
+ * @PURPLE_SOUND_SEND: Send an IM.
+ * @PURPLE_SOUND_CHAT_JOIN: Someone joins a chat.
+ * @PURPLE_SOUND_CHAT_LEAVE: Someone leaves a chat.
+ * @PURPLE_SOUND_CHAT_YOU_SAY: You say something in a chat.
+ * @PURPLE_SOUND_CHAT_SAY: Someone else says somthing in a chat.
+ * @PURPLE_SOUND_POUNCE_DEFAULT: Default sound for a buddy pounce.
+ * @PURPLE_SOUND_CHAT_NICK: Someone says your name in a chat.
+ * @PURPLE_SOUND_GOT_ATTENTION: Got an attention.
+ * @PURPLE_NUM_SOUNDS: Total number of sounds.
+ *
* A type of sound.
*/
typedef enum
{
- PURPLE_SOUND_BUDDY_ARRIVE = 0, /**< Buddy signs on. */
- PURPLE_SOUND_BUDDY_LEAVE, /**< Buddy signs off. */
- PURPLE_SOUND_RECEIVE, /**< Receive an IM. */
- PURPLE_SOUND_FIRST_RECEIVE, /**< Receive an IM that starts a conv. */
- PURPLE_SOUND_SEND, /**< Send an IM. */
- PURPLE_SOUND_CHAT_JOIN, /**< Someone joins a chat. */
- PURPLE_SOUND_CHAT_LEAVE, /**< Someone leaves a chat. */
- PURPLE_SOUND_CHAT_YOU_SAY, /**< You say something in a chat. */
- PURPLE_SOUND_CHAT_SAY, /**< Someone else says somthing in a chat. */
- PURPLE_SOUND_POUNCE_DEFAULT, /**< Default sound for a buddy pounce. */
- PURPLE_SOUND_CHAT_NICK, /**< Someone says your name in a chat. */
- PURPLE_SOUND_GOT_ATTENTION, /**< Got an attention */
- PURPLE_NUM_SOUNDS /**< Total number of sounds. */
+ PURPLE_SOUND_BUDDY_ARRIVE = 0,
+ PURPLE_SOUND_BUDDY_LEAVE,
+ PURPLE_SOUND_RECEIVE,
+ PURPLE_SOUND_FIRST_RECEIVE,
+ PURPLE_SOUND_SEND,
+ PURPLE_SOUND_CHAT_JOIN,
+ PURPLE_SOUND_CHAT_LEAVE,
+ PURPLE_SOUND_CHAT_YOU_SAY,
+ PURPLE_SOUND_CHAT_SAY,
+ PURPLE_SOUND_POUNCE_DEFAULT,
+ PURPLE_SOUND_CHAT_NICK,
+ PURPLE_SOUND_GOT_ATTENTION,
+ PURPLE_NUM_SOUNDS
} PurpleSoundEventID;
-/** Operations used by the core to request that particular sound files, or the
- * sound associated with a particular event, should be played.
+/**
+ * PurpleSoundUiOps:
+ *
+ * Operations used by the core to request that particular sound files, or the
+ * sound associated with a particular event, should be played.
*/
typedef struct _PurpleSoundUiOps
{
@@ -81,35 +99,40 @@ G_BEGIN_DECLS
/*@{*/
/**
- * Plays the specified sound file.
- *
+ * purple_sound_play_file:
* @filename: The file to play.
* @account: The account that this sound is associated with, or
* NULL if the sound is not associated with any specific
* account. This is needed for the "sounds while away?"
* preference to work correctly.
+ *
+ * Plays the specified sound file.
*/
void purple_sound_play_file(const char *filename, const PurpleAccount *account);
/**
- * Plays the sound associated with the specified event.
- *
+ * purple_sound_play_event:
* @event: The event.
* @account: The account that this sound is associated with, or
* NULL if the sound is not associated with any specific
* account. This is needed for the "sounds while away?"
* preference to work correctly.
+ *
+ * Plays the sound associated with the specified event.
*/
void purple_sound_play_event(PurpleSoundEventID event, const PurpleAccount *account);
/**
+ * purple_sound_set_ui_ops:
+ * @ops: The UI sound operations structure.
+ *
* Sets the UI sound operations
- *
- * @ops: The UI sound operations structure.
*/
void purple_sound_set_ui_ops(PurpleSoundUiOps *ops);
/**
+ * purple_sound_get_ui_ops:
+ *
* Gets the UI sound operations
*
* Returns: The UI sound operations structure.
@@ -117,16 +140,22 @@ void purple_sound_set_ui_ops(PurpleSound
PurpleSoundUiOps *purple_sound_get_ui_ops(void);
/**
+ * purple_sound_init:
+ *
* Initializes the sound subsystem
*/
void purple_sound_init(void);
/**
+ * purple_sound_uninit:
+ *
* Shuts down the sound subsystem
*/
void purple_sound_uninit(void);
/**
+ * purple_sounds_get_handle:
+ *
* Returns the sound subsystem handle.
*
* Returns: The sound subsystem handle.
diff --git a/libpurple/sslconn.h b/libpurple/sslconn.h
--- a/libpurple/sslconn.h
+++ b/libpurple/sslconn.h
@@ -26,7 +26,11 @@
#ifndef _PURPLE_SSLCONN_H_
#define _PURPLE_SSLCONN_H_
-/** Possible SSL errors. */
+/**
+ * PurpleSslErrorType:
+ *
+ * Possible SSL errors.
+ */
typedef enum
{
PURPLE_SSL_HANDSHAKE_FAILED = 1,
@@ -39,7 +43,6 @@ typedef enum
#define PURPLE_SSL_DEFAULT_PORT 443
-/** @copydoc _PurpleSslConnection */
typedef struct _PurpleSslConnection PurpleSslConnection;
typedef void (*PurpleSslInputFunction)(gpointer, PurpleSslConnection *,
@@ -47,39 +50,45 @@ typedef void (*PurpleSslInputFunction)(g
typedef void (*PurpleSslErrorFunction)(PurpleSslConnection *, PurpleSslErrorType,
gpointer);
+/**
+ * PurpleSslConnection:
+ * @host: Hostname to which the SSL connection will be made
+ * @port: Port to connect to
+ * @connect_cb_data: Data to pass to PurpleSslConnection::connect_cb()
+ * @connect_cb: Callback triggered once the SSL handshake is complete
+ * @error_cb: Callback triggered if there is an error during connection
+ * @recv_cb_data: Data passed to PurpleSslConnection::recv_cb()
+ * @recv_cb: User-defined callback executed when the SSL connection
+ * receives data
+ * @fd: File descriptor used to refer to the socket
+ * @inpa: Glib event source ID; used to refer to the received data
+ * callback in the glib eventloop
+ * @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
More information about the Commits
mailing list