/soc/2013/ankitkv/gobjectification: e259e75f1c6f: Fix some gtk-d...
Ankit Vani
a at nevitus.org
Wed Feb 5 17:04:01 EST 2014
Changeset: e259e75f1c6f25c0c4bb38679079ff9d498248de
Author: Ankit Vani <a at nevitus.org>
Date: 2014-02-06 03:04 +0530
Branch: gtkdoc-conversion
URL: https://hg.pidgin.im/soc/2013/ankitkv/gobjectification/rev/e259e75f1c6f
Description:
Fix some gtk-doc warnings till xmlnode.h
diffstat:
libpurple/request-datasheet.h | 6 +-
libpurple/request.h | 33 +++++++++--------
libpurple/roomlist.c | 35 +++++++++---------
libpurple/roomlist.h | 7 ++-
libpurple/savedstatuses.c | 24 +++++++------
libpurple/savedstatuses.h | 5 +-
libpurple/signals.h | 45 ++++++++++++------------
libpurple/sslconn.h | 78 +++++++++++++++++++-----------------------
libpurple/status.c | 7 +--
libpurple/status.h | 8 ++--
libpurple/stringref.c | 6 +-
libpurple/stun.c | 4 +-
libpurple/util.h | 4 +-
libpurple/whiteboard.h | 5 +-
libpurple/xfer.c | 77 ++++++++++++++++++++---------------------
libpurple/xfer.h | 78 ++++++++++++++++++------------------------
libpurple/xmlnode.h | 2 +-
17 files changed, 203 insertions(+), 221 deletions(-)
diffs (truncated from 985 to 300 lines):
diff --git a/libpurple/request-datasheet.h b/libpurple/request-datasheet.h
--- a/libpurple/request-datasheet.h
+++ b/libpurple/request-datasheet.h
@@ -377,9 +377,9 @@ purple_request_datasheet_record_set_stri
/**
* purple_request_datasheet_record_set_image_data:
- * @rec: The record.
- * @col_no: The column.
- * @data: The stock identifier of a image.
+ * @rec: The record.
+ * @col_no: The column.
+ * @stock_id: The stock identifier of a image.
*
* Sets data for a image column of specified record.
*/
diff --git a/libpurple/request.h b/libpurple/request.h
--- a/libpurple/request.h
+++ b/libpurple/request.h
@@ -64,6 +64,8 @@ typedef struct _PurpleRequestFieldGroup
*/
typedef struct _PurpleRequestCommonParameters PurpleRequestCommonParameters;
+typedef struct _PurpleRequestUiOps PurpleRequestUiOps;
+
#include "account.h"
#define PURPLE_DEFAULT_ACTION_NONE -1
@@ -133,14 +135,22 @@ typedef void (*PurpleRequestCancelCb)(gp
/**
* PurpleRequestUiOps:
+ * @request_input: See purple_request_input().
+ * @request_choice: See purple_request_choice_varg().
+ * @request_action: See purple_request_action_varg().
+ * @request_wait: See purple_request_wait().
+ * @request_wait_update: See purple_request_wait_pulse(),
+ * purple_request_wait_progress().
+ * @request_fields: See purple_request_fields().
+ * @request_file: See purple_request_file().
+ * @request_folder: See purple_request_folder().
*
* Request UI operations.
*/
-typedef struct
+struct _PurpleRequestUiOps
{
PurpleRequestFeature features;
- /** @see purple_request_input(). */
void *(*request_input)(const char *title, const char *primary,
const char *secondary, const char *default_value,
gboolean multiline, gboolean masked, gchar *hint,
@@ -148,45 +158,35 @@ typedef struct
const char *cancel_text, GCallback cancel_cb,
PurpleRequestCommonParameters *cpar, void *user_data);
- /** @see purple_request_choice_varg(). */
void *(*request_choice)(const char *title, const char *primary,
const char *secondary, gpointer default_value,
const char *ok_text, GCallback ok_cb, const char *cancel_text,
GCallback cancel_cb, PurpleRequestCommonParameters *cpar,
void *user_data, va_list choices);
- /** @see purple_request_action_varg(). */
void *(*request_action)(const char *title, const char *primary,
const char *secondary, int default_action,
PurpleRequestCommonParameters *cpar, void *user_data,
size_t action_count, va_list actions);
- /** @see purple_request_wait(). */
void *(*request_wait)(const char *title, const char *primary,
const char *secondary, gboolean with_progress,
PurpleRequestCancelCb cancel_cb,
PurpleRequestCommonParameters *cpar, void *user_data);
- /**
- * @see purple_request_wait_pulse().
- * @see purple_request_wait_progress().
- */
void (*request_wait_update)(void *ui_handle, gboolean pulse,
gfloat fraction);
- /** @see purple_request_fields(). */
void *(*request_fields)(const char *title, const char *primary,
const char *secondary, PurpleRequestFields *fields,
const char *ok_text, GCallback ok_cb,
const char *cancel_text, GCallback cancel_cb,
PurpleRequestCommonParameters *cpar, void *user_data);
- /** @see purple_request_file(). */
void *(*request_file)(const char *title, const char *filename,
gboolean savedialog, GCallback ok_cb, GCallback cancel_cb,
PurpleRequestCommonParameters *cpar, void *user_data);
- /** @see purple_request_folder(). */
void *(*request_folder)(const char *title, const char *dirname,
GCallback ok_cb, GCallback cancel_cb,
PurpleRequestCommonParameters *cpar, void *user_data);
@@ -198,7 +198,7 @@ typedef struct
void (*_purple_reserved2)(void);
void (*_purple_reserved3)(void);
void (*_purple_reserved4)(void);
-} PurpleRequestUiOps;
+};
typedef void (*PurpleRequestInputCb)(void *, const char *);
@@ -1243,7 +1243,7 @@ void purple_request_field_int_set_lower_
*
* Sets the upper bound in an integer field.
*/
-void purple_request_field_int_set_upper_bound(PurpleRequestField *field, int lower_bound);
+void purple_request_field_int_set_upper_bound(PurpleRequestField *field, int upper_bound);
/**
* purple_request_field_int_set_value:
@@ -1897,8 +1897,9 @@ gboolean purple_request_field_email_vali
/**
* purple_request_field_alphanumeric_validator:
* @field: The field.
- * @errmsg: (Optional) destination for error message.
- * @user_data: (Optional) allowed character list (NULL-terminated string).
+ * @errmsg: (allow-none): destination for error message.
+ * @allowed_characters: (allow-none): allowed character list
+ * (NULL-terminated string).
*
* Validates a field which should contain alphanumeric content.
*
diff --git a/libpurple/roomlist.c b/libpurple/roomlist.c
--- a/libpurple/roomlist.c
+++ b/libpurple/roomlist.c
@@ -31,41 +31,40 @@
#define PURPLE_ROOMLIST_GET_PRIVATE(obj) \
(G_TYPE_INSTANCE_GET_PRIVATE((obj), PURPLE_TYPE_ROOMLIST, PurpleRoomlistPrivate))
-/** @copydoc _PurpleRoomlistPrivate */
typedef struct _PurpleRoomlistPrivate PurpleRoomlistPrivate;
-/**
+/*
* Private data for a room list.
*/
struct _PurpleRoomlistPrivate {
- PurpleAccount *account; /**< The account this list belongs to. */
- GList *fields; /**< The fields. */
- GList *rooms; /**< The list of rooms. */
- gboolean in_progress; /**< The listing is in progress. */
+ PurpleAccount *account; /* The account this list belongs to. */
+ GList *fields; /* The fields. */
+ GList *rooms; /* The list of rooms. */
+ gboolean in_progress; /* The listing is in progress. */
/* TODO Remove this and use protocol-specific subclasses. */
- gpointer proto_data; /** Protocol private data. */
+ gpointer proto_data; /* Protocol private data. */
};
-/**
+/*
* Represents a room.
*/
struct _PurpleRoomlistRoom {
- PurpleRoomlistRoomType type; /**< The type of room. */
- gchar *name; /**< The name of the room. */
- GList *fields; /**< Other fields. */
- PurpleRoomlistRoom *parent; /**< The parent room, or NULL. */
- gboolean expanded_once; /**< A flag the UI uses to avoid multiple expand prpl cbs. */
+ PurpleRoomlistRoomType type; /* The type of room. */
+ gchar *name; /* The name of the room. */
+ GList *fields; /* Other fields. */
+ PurpleRoomlistRoom *parent; /* The parent room, or NULL. */
+ gboolean expanded_once; /* A flag the UI uses to avoid multiple expand prpl cbs. */
};
-/**
+/*
* A field a room might have.
*/
struct _PurpleRoomlistField {
- PurpleRoomlistFieldType type; /**< The type of field. */
- gchar *label; /**< The i18n user displayed name of the field. */
- gchar *name; /**< The internal name of the field. */
- gboolean hidden; /**< Hidden? */
+ PurpleRoomlistFieldType type; /* The type of field. */
+ gchar *label; /* The i18n user displayed name of the field. */
+ gchar *name; /* The internal name of the field. */
+ gboolean hidden; /* Hidden? */
};
/* Room list property enums */
diff --git a/libpurple/roomlist.h b/libpurple/roomlist.h
--- a/libpurple/roomlist.h
+++ b/libpurple/roomlist.h
@@ -117,6 +117,7 @@ struct _PurpleRoomlistUiOps {
struct _PurpleRoomlist {
GObject gparent;
+ /*< public >*/
gpointer ui_data;
};
@@ -145,7 +146,7 @@ G_BEGIN_DECLS
/**
* purple_roomlist_get_type:
*
- * Returns the GType for the Room List object.
+ * Returns: The #GType for the Room List object.
*/
GType purple_roomlist_get_type(void);
@@ -327,7 +328,7 @@ void purple_roomlist_set_ui_data(PurpleR
/**
* purple_roomlist_room_get_type:
*
- * Returns the GType for the PurpleRoomlistRoom boxed structure.
+ * Returns: The #GType for the #PurpleRoomlistRoom boxed structure.
*/
GType purple_roomlist_room_get_type(void);
@@ -432,7 +433,7 @@ GList * purple_roomlist_room_get_fields(
/**
* purple_roomlist_field_get_type:
*
- * Returns the GType for the PurpleRoomlistField boxed structure.
+ * Returns: The #GType for the #PurpleRoomlistField boxed structure.
*/
GType purple_roomlist_field_get_type(void);
diff --git a/libpurple/savedstatuses.c b/libpurple/savedstatuses.c
--- a/libpurple/savedstatuses.c
+++ b/libpurple/savedstatuses.c
@@ -30,19 +30,19 @@
#include "util.h"
#include "xmlnode.h"
-/**
+/*
* The maximum number of transient statuses to save. This
* is used during the shutdown process to clean out old
* transient statuses.
*/
#define MAX_TRANSIENTS 5
-/**
+/*
* The default message to use when the user becomes auto-away.
*/
#define DEFAULT_AUTOAWAY_MESSAGE _("I'm not here right now")
-/**
+/*
* The information stores a snap-shot of the statuses of all
* your accounts. Basically these are your saved away messages.
* There is an overall status and message that applies to
@@ -59,14 +59,14 @@ struct _PurpleSavedStatus
PurpleStatusPrimitive type;
char *message;
- /** The timestamp when this saved status was created. This must be unique. */
+ /* The timestamp when this saved status was created. This must be unique. */
time_t creation_time;
time_t lastused;
unsigned int usage_count;
- GList *substatuses; /**< A list of PurpleSavedStatusSub's. */
+ GList *substatuses; /* A list of PurpleSavedStatusSub's. */
};
/*
@@ -151,7 +151,7 @@ set_creation_time(PurpleSavedStatus *sta
status);
}
-/**
+/*
* A magic number is calculated for each status, and then the
* statuses are ordered by the magic number. The magic number
* is the date the status was last used offset by one day for
@@ -178,7 +178,7 @@ saved_statuses_sort_func(gconstpointer a
return 0;
}
-/**
+/*
* Transient statuses are added and removed automatically by
* Purple. If they're not used for a certain length of time then
* they'll expire and be automatically removed. This function
@@ -419,7 +419,7 @@ parse_substatus(PurpleXmlNode *substatus
return ret;
}
-/**
+/*
* Parse a saved status and add it to the saved_statuses linked list.
*
* Here's an example of the XML for a saved status:
@@ -515,11 +515,13 @@ parse_status(PurpleXmlNode *status)
More information about the Commits
mailing list