cpw.nader.asynclogging-3: 04fd65c5: Cleaned up the documentation a bit more ...
morshed.nader at gmail.com
morshed.nader at gmail.com
Mon Mar 21 00:13:02 EDT 2011
----------------------------------------------------------------------
Revision: 04fd65c5e3381c1f0aa261f0c3b9fef497938c66
Parent: 9f750254a977e6e08652797cf14c8fb96bb41ee8
Author: morshed.nader at gmail.com
Date: 03/20/11 23:49:51
Branch: im.pidgin.cpw.nader.asynclogging-3
URL: http://d.pidgin.im/viewmtn/revision/info/04fd65c5e3381c1f0aa261f0c3b9fef497938c66
Changelog:
Cleaned up the documentation a bit more and got rid of a few doc build errors
Changes against parent 9f750254a977e6e08652797cf14c8fb96bb41ee8
patched finch/gntlog.h
patched libpurple/commonlog.h
patched libpurple/log.h
patched pidgin/gtklog.c
patched pidgin/gtklog.h
-------------- next part --------------
============================================================
--- libpurple/log.h 49955114bc2eacf6ae98ecb8e6f40f9355004f11
+++ libpurple/log.h e841f8659f43001b5e3cb1f0cdccb07b0c312f5f
@@ -100,8 +100,8 @@ struct _PurpleLog {
* All asynchronous and finish methods are normally implemented by PurpleLog
* and rely on the synchronous versions being implemented by the subclasses
*
- * For more examples using #GCancellable, #GAsyncReadyCallback, and
- * #GAsyncResult, refer to Gio's documentaton.
+ * For more examples using GCancellable, GAsyncReadyCallback, and
+ * GAsyncResult, refer to Gio's documentaton.
*/
struct _PurpleLogClass {
GObjectClass parent_class;
@@ -231,14 +231,15 @@ struct _PurpleLogClass {
gssize (* total_size_finish) (PurpleLog *log, GAsyncResult *res,
GError **error);
- /** Adds #PurpleLogSet<!-- -->s to a #GHashTable. By passing the data in the
- * #PurpleLogSet<!-- -->s to list, the caller can get every available
- * #PurpleLog from the logger. Loggers using purple_log_common_writer()
- * (or otherwise storing their logs in the same directory structure as the
- * stock loggers) do not need to implement this function.
+ /**
+ * Adds log sets to a hash table. By passing the data in the
+ * log sets to list, the caller can get every available log from
+ * the logger. Loggers using purple_log_common_writer()
+ * (or otherwise storing their logs in the same directory structure as the
+ * stock loggers) do not need to implement this function.
*
- * Loggers which implement this function must create a #PurpleLogSet,
- * then call @a cb with @a sets and the newly created #PurpleLogSet.
+ * Loggers which implement this function must create a PurpleLogSet,
+ * then call @a cb with @a sets and the newly created PurpleLogSet.
*/
GHashTable * (* get_log_sets_fn) (PurpleLog *log, GCancellable *cancellable,
GError **error);
@@ -276,7 +277,7 @@ struct _PurpleLogClass {
* Describes available logs.
*
* By passing the elements of this struct to purple_log_get_logs(), the caller
- * can get all available #PurpleLog<!-- -->s.
+ * can get all available logs.
*/
struct _PurpleLogSet {
/** The type of logs available */
@@ -355,7 +356,7 @@ G_CONST_RETURN gchar *purple_log_get_nam
G_CONST_RETURN gchar *purple_log_get_name(const PurpleLog *log);
/**
- * Returns the #PurpleAccount associated with the log
+ * Returns the account associated with the log
*
* @param log The log to get the property from
*
@@ -405,8 +406,8 @@ gchar *_process_txt_log(gchar *, gchar *
* system messages
* @param time A timestamp in UNIX time
* @param message The message to log
- * @param cancellable (allow-none): #GCancellable object
- * @param error (out) (allow-none): a #GError location to store the error
+ * @param cancellable (allow-none): GCancellable object
+ * @param error (out) (allow-none): a GError location to store the error
*/
gssize purple_log_write(PurpleLog *log, PurpleMessageFlags type,
const gchar *from, time_t time, const gchar *message,
@@ -421,8 +422,8 @@ gssize purple_log_write(PurpleLog *log,
* @param time A timestamp in UNIX time
* @param message The message to log (will be removed in function)
* @param io_priority The io priority of the request
- * @param cancellable (allow-none): #GCancellable object
- * @param cb (allow-none): A #GAsyncReadyCallback to call when the
+ * @param cancellable (allow-none): GCancellable object
+ * @param cb (allow-none): A GAsyncReadyCallback to call when the
request is satisfied
* @param userdata (allow-none): The data to pass to callback function
*
@@ -435,9 +436,9 @@ void purple_log_write_async(PurpleLog *l
/**
* Finishing asynchronously writing to a log
*
- * @param log The #PurpleLog that was written to
- * @param res A #GAsyncResult
- * @param error (out) (allow-none): a #GError location to store the error
+ * @param log The log that was to be written to
+ * @param res A GAsyncResult
+ * @param error (out) (allow-none): a GError location to store the error
*
* @return Number of bytes written, -1 on failure
*
@@ -451,8 +452,8 @@ gssize purple_log_write_finish(PurpleLog
*
* @param log The log to read from
* @param flags (allow-none): Location to store the returned logging flags
- * @param cancellable (allow-none): #GCancellable object
- * @param error (out) (allow-none): a #GError location to store the error
+ * @param cancellable (allow-none): GCancellable object
+ * @param error (out) (allow-none): a GError location to store the error
* Note: The error will not have HTML formatting applied
*
* @return The contents of this log in Purple Markup
@@ -461,12 +462,12 @@ gchar *purple_log_read(PurpleLog *log, P
GCancellable *cancellable, GError **error);
/**
- * Reads from a log asynchronously
+ * Asynchronously reads from a log.
*
* @param log The log to read from
* @param io_priority The io priority of the request
- * @param cancellable (allow-none): #GCancellable object
- * @param cb (allow-none): A #GAsyncReadyCallback to call when the
+ * @param cancellable (allow-none): GCancellable object
+ * @param cb (allow-none): A GAsyncReadyCallback to call when the
request is satisfied
* @param userdata (allow-none): The data to pass to callback function
*
@@ -476,14 +477,15 @@ void purple_log_read_async(PurpleLog *lo
GCancellable *cancellable, GAsyncReadyCallback cb, gpointer userdata);
/**
- * Finishes asynchronously reading a log
+ * Finishes asynchronously reading a log.
*
- * Note: If error's message is set, it will already contain the HTML formatting tags
+ * Note: If error's message is set, it will already contain the HTML
+ * formatting tags.
*
- * @param log The #PurpleLog that was read
- * @param res A #GAsyncResult
+ * @param log The log
+ * @param res A GAsyncResult
* @param flags (out) (allow-none): Location to store the returned logging flags
- * @param error (out) (allow-none): a #GError location to store the error
+ * @param error (out) (allow-none): a GError location to store the error
*
* @return pointer to contents of file or %NULL on error
*
@@ -507,8 +509,8 @@ gssize purple_log_get_size(PurpleLog *lo
*
* @param log The log
* @param io_priority The io priority of the request
- * @param cancellable (allow-none): #GCancellable object
- * @param cb (allow-none): A #GAsyncReadyCallback to call when the
+ * @param cancellable (allow-none): GCancellable object
+ * @param cb (allow-none): A GAsyncReadyCallback to call when the
request is satisfied
* @param userdata (allow-none): The data to pass to callback function
*
@@ -520,9 +522,9 @@ void purple_log_get_size_async(PurpleLog
/**
* Finishes asynchronously getting the size of a log
*
- * @param log The #PurpleLog to size
- * @param res A #GAsyncResult
- * @param error (out) (allow-none): a #GError location to store the error
+ * @param log The log
+ * @param res A GAsyncResult
+ * @param error (out) (allow-none): a GError location to store the error
*
* @return size of file or -1 on error
*
@@ -539,7 +541,7 @@ gssize purple_log_get_size_finish(Purple
* @param name The name of the log
* @param account The account
*
- * @return A sorted list of #PurpleLog<!-- -->s
+ * @return A sorted list of logs
*/
GList *purple_log_get_logs(PurpleLog *log, PurpleLogChatType type,
const gchar *name, PurpleAccount *account, GCancellable *cancellable,
@@ -553,8 +555,8 @@ GList *purple_log_get_logs(PurpleLog *lo
* @param name The name of the log
* @param account The account
* @param io_priority The io priority of the request
- * @param cancellable (allow-none): #GCancellable object
- * @param cb (allow-none): A #GAsyncReadyCallback to call when the
+ * @param cancellable (allow-none): GCancellable object
+ * @param cb (allow-none): A GAsyncReadyCallback to call when the
request is satisfied
* @param userdata (allow-none): The data to pass to callback function
*
@@ -571,8 +573,8 @@ void purple_log_get_logs_async(PurpleLog
* Note: Make sure to examine that error is not NULL as it is completely possible
* for the list to be empty and the function to return NULL without an error
*
- * @param res A #GAsyncResult
- * @param error (out) (allow-none): a #GError location to store the error
+ * @param res A GAsyncResult
+ * @param error (out) (allow-none): a GError location to store the error
*
* @return pointer to log list or %NULL on error
*
@@ -588,7 +590,7 @@ GList *purple_log_get_logs_finish(Purple
* @param type The type of the log
* @param name The name of the log
* @param account The account
- * @param error (out) (allow-none): a #GError location to store the error
+ * @param error (out) (allow-none): a GError location to store the error
*
* @return pointer to log list or %NULL on error
*
@@ -606,8 +608,8 @@ GList *purple_logs_get_logs(PurpleLogCha
* @param name The name of the log
* @param account The account
* @param io_priority The io priority of the request
- * @param cancellable (allow-none): #GCancellable object
- * @param cb (allow-none): A #GAsyncReadyCallback to call when the
+ * @param cancellable (allow-none): GCancellable object
+ * @param cb (allow-none): A GAsyncReadyCallback to call when the
request is satisfied
* @param userdata (allow-none): The data to pass to callback function
*
@@ -623,8 +625,8 @@ void purple_logs_get_logs_async(PurpleLo
* Finishes asynchronously getting a list of all available logs
* See purple_log_get_logs_finish() for more details.
*
- * @param res A #GAsyncResult
- * @param error (out) (allow-none): a #GError location to store the error
+ * @param res A GAsyncResult
+ * @param error (out) (allow-none): a GError location to store the error
*
* @return pointer to log list or %NULL on error
*
@@ -637,10 +639,10 @@ GList *purple_logs_get_logs_finish(GAsyn
*
* @param log A dummy log of the type of logger to list the logs of
* @param account The account
- * @param cancellable (allow-none): #GCancellable object
- * @param error (out) (allow-none): a #GError location to store the error
+ * @param cancellable (allow-none): GCancellable object
+ * @param error (out) (allow-none): a GError location to store the error
*
- * @return A sorted list of #PurpleLog<!-- -->s
+ * @return A sorted list of logs
*/
GList *purple_log_get_system_logs(PurpleLog *log, PurpleAccount *account,
GCancellable *cancellable, GError **error);
@@ -651,8 +653,8 @@ GList *purple_log_get_system_logs(Purple
* @param log A dummy log of the type of logger to list the logs of
* @param account The account
* @param io_priority The io priority of the request
- * @param cancellable (allow-none): #GCancellable object
- * @param cb (allow-none): A #GAsyncReadyCallback to call when the
+ * @param cancellable (allow-none): GCancellable object
+ * @param cb (allow-none): A GAsyncReadyCallback to call when the
request is satisfied
* @param userdata (allow-none): The data to pass to callback function
*
@@ -668,8 +670,8 @@ void purple_log_get_system_logs_async(Pu
* Note: Make sure to examine that error is not NULL as it is completely possible
* for the list to be empty and the function to return NULL without an error
*
- * @param res A #GAsyncResult
- * @param error (out) (allow-none): a #GError location to store the error
+ * @param res A GAsyncResult
+ * @param error (out) (allow-none): a GError location to store the error
*
* @return pointer to log list or %NULL on error
*
@@ -683,8 +685,8 @@ GList *purple_log_get_system_logs_finish
* See purple_log_get_system_logs() for more details.
*
* @param account The account
- * @param cancellable (allow-none): #GCancellable object
- * @param error (out) (allow-none): a #GError location to store the error
+ * @param cancellable (allow-none): GCancellable object
+ * @param error (out) (allow-none): a GError location to store the error
*
* @return pointer to log list or %NULL on error
*
@@ -700,8 +702,8 @@ GList *purple_logs_get_system_logs(Purpl
*
* @param account The account
* @param io_priority The io priority of the request
- * @param cancellable (allow-none): #GCancellable object
- * @param cb (allow-none): A #GAsyncReadyCallback to call when the
+ * @param cancellable (allow-none): GCancellable object
+ * @param cb (allow-none): A GAsyncReadyCallback to call when the
request is satisfied
* @param userdata (allow-none): The data to pass to callback function
*
@@ -716,8 +718,8 @@ void purple_logs_get_system_logs_async(P
* loggers.
* See purple_log_get_system_logs_finish() for more details.
*
- * @param res A #GAsyncResult
- * @param error (out) (allow-none): a #GError location to store the error
+ * @param res A GAsyncResult
+ * @param error (out) (allow-none): a GError location to store the error
*
* @return pointer to log list or %NULL on error
*
@@ -745,8 +747,8 @@ gssize purple_log_get_total_size(PurpleL
* @param name The name of the log
* @param account The account
* @param io_priority The io priority of the request
- * @param cancellable (allow-none): #GCancellable object
- * @param cb (allow-none): A #GAsyncReadyCallback to call when the
+ * @param cancellable (allow-none): GCancellable object
+ * @param cb (allow-none): A GAsyncReadyCallback to call when the
request is satisfied
* @param userdata (allow-none): The data to pass to callback function
*
@@ -759,8 +761,8 @@ void purple_log_get_total_size_async(Pur
/**
* Finishes asynchronously getting the total size of a conversation
*
- * @param res A #GAsyncResult
- * @param error (out) (allow-none): a #GError location to store the error
+ * @param res A GAsyncResult
+ * @param error (out) (allow-none): a GError location to store the error
*
* @return Size of logs or -1 on error
*
@@ -776,8 +778,8 @@ gssize purple_log_get_total_size_finish(
* @param type The type of the log
* @param name The name of the log
* @param account The account
- * @param cancellable (allow-none): #GCancellable object
- * @param error (out) (allow-none): a #GError location to store the error
+ * @param cancellable (allow-none): GCancellable object
+ * @param error (out) (allow-none): a GError location to store the error
*
* @return Size of logs or -1 on error
*
@@ -794,8 +796,8 @@ gssize purple_logs_get_total_size(Purple
* @param name The name of the log
* @param account The account
* @param io_priority The io priority of the request
- * @param cancellable (allow-none): #GCancellable object
- * @param cb (allow-none): A #GAsyncReadyCallback to call when the
+ * @param cancellable (allow-none): GCancellable object
+ * @param cb (allow-none): A GAsyncReadyCallback to call when the
request is satisfied
* @param userdata (allow-none): The data to pass to callback function
*
@@ -809,8 +811,8 @@ void purple_logs_get_total_size_async(Pu
* Finishes asynchronously getting the total size of all stored conversations.
* See purple_log_get_total_size_finish().
*
- * @param res A #GAsyncResult
- * @param error (out) (allow-none): a #GError location to store the error
+ * @param res A GAsyncResult
+ * @param error (out) (allow-none): a GError location to store the error
*
* @return Size of logs or -1 on error
*
@@ -819,33 +821,31 @@ gssize purple_logs_get_total_size_finish
gssize purple_logs_get_total_size_finish(GAsyncResult *res, GError **error);
/**
- * Returns a GHashTable of #PurpleLogSet<!-- -->s.
+ * Returns a hash table of log sets.
*
* A "log set" here means the information necessary to gather the
- * #PurpleLog<!-- -->s for a given buddy/chat. This information would be passed
- * to purple_log_get_log to get a list of #PurpleLog<!-- -->s.
+ * PurpleLogs for a given buddy/chat. This information would be passed
+ * to purple_log_get_log to get a list of logs.
*
* The primary use of this function is to get a list of everyone the
* user has ever talked to (assuming he or she uses logging).
*
- * The GHashTable that's returned will free all log sets in it when
- * destroyed. If a #PurpleLogSet is removed from the GHashTable, it
+ * The table that's returned will free all log sets in it when
+ * destroyed. If a log set is removed from the table, it
* must be freed with purple_log_set_free().
*
- * @return A GHashTable of all available unique #PurpleLogSet<!-- -->s
+ * @return A table of all available unique log sets
*/
GHashTable *purple_log_get_log_sets(PurpleLog *, GCancellable *cancellable,
GError **error);
/**
- * Asychronously gets a #GHashTable of #PurpleLogSet<!-- -->s.
+ * Asychronously gets a hash table of log sets.
+ * For more details, see purple_log_get_log_sets().
*
- * For more details, see purple_log_get_log_sets() which is
- * the synchronous version of this call.
- *
* @param io_priority The io priority of the request
- * @param cancellable (allow-none): #GCancellable object
- * @param cb (allow-none): A #GAsyncReadyCallback to call when the
+ * @param cancellable (allow-none): GCancellable object
+ * @param cb (allow-none): A GAsyncReadyCallback to call when the
request is satisfied
* @param userdata (allow-none): The data to pass to callback function
*
@@ -857,8 +857,8 @@ void purple_log_get_log_sets_async(Purpl
/**
* Finishes asynchronously getting a hash table of log sets
*
- * @param res A #GAsyncResult
- * @param error (out) (allow-none): a #GError location to store the error
+ * @param res A GAsyncResult
+ * @param error (out) (allow-none): a GError location to store the error
*
* @return The hash table of log sets or %NULL on error
*
@@ -868,11 +868,11 @@ GHashTable *purple_log_get_log_sets_fini
GError **error);
/**
- * Gets a #GHashTable for the combined log sets of all accounts.
+ * Gets a hash table for the combined log sets of all accounts.
* See purple_log_get_log_sets() for more details.
*
- * @param cancellable (allow-none): #GCancellable object
- * @param error (out) (allow-none): a #GError location to store the error
+ * @param cancellable (allow-none): GCancellable object
+ * @param error (out) (allow-none): a GError location to store the error
*
* @return The hash table of the log sets or %NULL on error
*
@@ -882,12 +882,12 @@ GHashTable *purple_logs_get_log_sets(GCa
GError **error);
/**
- * Asynchronously gets a #GHashTable for the combined log sets of all accounts.
+ * Asynchronously gets a GHashTable for the combined log sets of all accounts.
* See purple_log_get_log_sets_async() for more details.
*
* @param io_priority The io priority of the request
- * @param cancellable (allow-none): #GCancellable object
- * @param cb (allow-none): A #GAsyncReadyCallback to call when the
+ * @param cancellable (allow-none): GCancellable object
+ * @param cb (allow-none): A GAsyncReadyCallback to call when the
request is satisfied
* @param userdata (allow-none): The data to pass to callback function
*
@@ -900,8 +900,8 @@ void purple_logs_get_log_sets_async(gint
* Finishes asynchronously getting the log sets for all accounts.
* See purple_log_get_log_sets_finish() for more details.
*
- * @param res A #GAsyncResult
- * @param error (out) (allow-none): a #GError location to store the error
+ * @param res A GAsyncResult
+ * @param error (out) (allow-none): a GError location to store the error
*
* @return The hash table of the log sets or %NULL on error
*
@@ -931,8 +931,8 @@ gssize purple_log_get_activity_score(Pur
* @param name The name of the log
* @param account The account
* @param io_priority The io priority of the request
- * @param cancellable (allow-none): #GCancellable object
- * @param cb (allow-none): A #GAsyncReadyCallback to call when the
+ * @param cancellable (allow-none): GCancellable object
+ * @param cb (allow-none): A GAsyncReadyCallback to call when the
request is satisfied
* @param userdata (allow-none): The data to pass to callback function
*
@@ -945,8 +945,8 @@ void purple_log_get_activity_score_async
/**
* Finishes asynchronously getting the activity score of a log
*
- * @param res A #GAsyncResult
- * @param error (out) (allow-none): a #GError location to store the error
+ * @param res A GAsyncResult
+ * @param error (out) (allow-none): a GError location to store the error
*
* @return The activity score of the log or -1 on failure
*
@@ -982,8 +982,8 @@ gboolean purple_log_remove(PurpleLog *lo
*
* @param log The log
* @param io_priority The io priority of the request
- * @param cancellable (allow-none): #GCancellable object
- * @param cb (allow-none): A #GAsyncReadyCallback to call when the
+ * @param cancellable (allow-none): GCancellable object
+ * @param cb (allow-none): A GAsyncReadyCallback to call when the
request is satisfied
* @param userdata (allow-none): The data to pass to callback function
*
@@ -995,9 +995,9 @@ void purple_log_remove_async(PurpleLog *
/**
* Finishes asynchronously deleting a log
*
- * @param log The #PurpleLog that was to be removed
- * @param res A #GAsyncResult
- * @param error (out) (allow-none): a #GError location to store the error
+ * @param log The log that was to be removed
+ * @param res A GAsyncResult
+ * @param error (out) (allow-none): a GError location to store the error
*
* @return %TRUE if the log was removed, %FALSE otherwise
*
@@ -1041,20 +1041,20 @@ void purple_log_list_free(GList *list);
void purple_log_list_free(GList *list);
/**
- * Implements GCompareFunc for #PurpleLog<!-- -->s
+ * Implements GCompareFunc for PurpleLog
*
- * @param y A #PurpleLog
- * @param z Another #PurpleLog
+ * @param y A PurpleLog
+ * @param z Another PurpleLog
*
* @return A value as specified by GCompareFunc
*/
gint purple_log_compare(gconstpointer y, gconstpointer z);
/**
- * Implements GCompareFunc for #PurpleLogSet<!-- -->s
+ * Implements GCompareFunc for PurpleLogSet
*
- * @param y A #PurpleLogSet
- * @param z Another #PurpleLogSet
+ * @param y A PurpleLogSet
+ * @param z Another PurpleLogSet
*
* @return A value as specified by GCompareFunc
*/
@@ -1113,7 +1113,8 @@ GArray *purple_log_logger_get_all(void);
GArray *purple_log_logger_get_all(void);
/**
- * Gets a #GList containing the IDs and names of the registered loggers that are writeable.
+ * Gets a GList containing the IDs and names of the registered loggers
+ * that are writeable.
*
* @return The list of IDs and names
*/
============================================================
--- pidgin/gtklog.c e135b48a6f32665b19139e931d693667597f7b9b
+++ pidgin/gtklog.c 42ca59732049757c1ca65bc96825678e00602832
@@ -1148,7 +1148,8 @@ void
}
void
-pidgin_log_show(PurpleLogChatType chat_type, const gchar *buddyname, PurpleAccount *account)
+pidgin_log_show(PurpleLogChatType chat_type, const gchar *buddyname,
+ PurpleAccount *account)
{
log_viewer_hash_t *ht;
_pidgin_log_data *pidgin_log_data;
============================================================
--- pidgin/gtklog.h 983cd6bf099ba32d6ff288b46cbed81d2e8d227f
+++ pidgin/gtklog.h 9f6aa767fa22a0eb1304aeb92f81fec4814dd6f2
@@ -124,12 +124,16 @@ void pidgin_log_viewer_set_selected(Pidg
/*@{*/
+//
GType pidgin_log_viewer_get_type(void);
+//
+// pidgin_log_viewer_new()
+
/**
* Displays the logs of a certain type for a buddy or chat on an account
*
- * @param type: The #PurpleLogType
+ * @param chat_type: The chat type
* @param buddyname: The buddy or chat name
* @param account: The account
*/
============================================================
--- finch/gntlog.h 6a26538a41bdc14a45bdef9728995e5e2dfce31f
+++ finch/gntlog.h b86870d6ced2ea62a354838c056e78d665488ef7
@@ -122,7 +122,7 @@ GType finch_log_viewer_get_type(void);
/**
* Displays the logs of a certain type for a buddy or chat on an account
*
- * @param type: The #PurpleLogType
+ * @param chat_type: The chat type
* @param username: The buddy or chat name
* @param account: The account
*/
@@ -131,7 +131,7 @@ void finch_log_show(PurpleLogChatType ch
/**
* Displays the logs for one contact
*
- * @param contact: The #PurpleContact to display the logs of
+ * @param contact: The contact to display the logs of
*/
void finch_log_show_contact(PurpleContact *contact);
============================================================
--- libpurple/commonlog.h 167883e2c992fa53aef3f59ccb9e57fb0badfd67
+++ libpurple/commonlog.h cc0d3ed6d00ffe8d0e99e140aa7ab0c664135933
@@ -57,10 +57,13 @@ struct _PurpleCommonLogClass {
void (*_purple_reserved4)(void);
};
+//
GType purple_common_log_get_type(void);
-PurpleLog *purple_common_log_new(GType log_type, PurpleLogChatType chat_type, const gchar *name, PurpleAccount *account,
- PurpleConversation *conv, time_t time, const struct tm *tm);
+//
+PurpleLog *purple_common_log_new(GType log_type, PurpleLogChatType chat_type,
+ const gchar *name, PurpleAccount *account, PurpleConversation *conv,
+ time_t time, const struct tm *tm);
/******************************************/
@@ -109,8 +112,8 @@ gboolean purple_log_common_writer(Purple
* @param log The log to write to
* @param ext (allow-none): The file extension to give to this log file
* @param io_priority The io priority of the request
- * @param cancellable (allow-none): #GCancellable object
- * @param cb (allow-none): A #GAsyncReadyCallback to call when the request is satisfied
+ * @param cancellable (allow-none): GCancellable object
+ * @param cb (allow-none): A GAsyncReadyCallback to call when the request is satisfied
* @param userdata (allow-none): The data to pass to callback function
*/
void purple_log_common_writer_async(PurpleLog *log, const gchar *ext, gint io_priority, GCancellable *cancellable, GAsyncReadyCallback cb, gpointer userdata);
@@ -122,15 +125,15 @@ void purple_log_common_writer_async(Purp
* the synchronous version of this call.
*
* @param log The log to write to
- * @param res A #GAsyncResult
- * @param error (out) (allow-none): a #GError location to store the error
+ * @param res A GAsyncResult
+ * @param error (out) (allow-none): a GError location to store the error
*
* @return %TRUE if the log was created, %FALSE otherwise
*/
gboolean purple_log_common_writer_finish(PurpleLog *log, GAsyncResult *res, GError **error);
/**
- * Returns a sorted #GList of #PurpleLog<!-- -->s of the requested type
+ * Returns a sorted list of logs of the requested type
*
* This function should only be used with logs that are written
* with purple_log_common_writer(). It's intended to be used as
@@ -144,24 +147,22 @@ gboolean purple_log_common_writer_finish
* @param ext The file extension this log format uses
* @param log_type The log type to create the new logs with, or G_TYPE_INVALID to use the default type
*
- * @return A sorted #GList of #PurpleLog<!-- -->s matching the parameters
+ * @return The sorted list of logs matching the parameters
*/
GList *purple_log_common_lister(PurpleLogChatType type, const gchar *name, PurpleAccount *account, const gchar *ext, GType log_type, GCancellable *cancellable, GError **error);
/**
- * Asynchronously gets a sorted #GList of #PurpleLog<!-- -->s of the requested type
+ * Asynchronously gets a sorted list of log of the requested type.
+ * See purple_log_common_lister() for more details.
*
- * For more details, see purple_log_common_lister() which is
- * the synchronous version of this call.
- *
* @param type The type of the logs being listed
* @param name The name of the log
* @param account The account of the log
* @param ext The file extension this log format uses
* @param log_type The log type to create the new logs with, or G_TYPE_INVALID to use the default type
* @param io_priority The io priority of the request
- * @param cancellable (allow-none): #GCancellable object
- * @param cb (allow-none): A #GAsyncReadyCallback to call when the request is satisfied
+ * @param cancellable (allow-none): GCancellable object
+ * @param cb (allow-none): A GAsyncReadyCallback to call when the request is satisfied
* @param userdata (allow-none): The data to pass to callback function
*
* @since 2.8.0
@@ -169,16 +170,16 @@ void purple_log_common_lister_async(Purp
void purple_log_common_lister_async(PurpleLogChatType type, const gchar *name, PurpleAccount *account, const gchar *ext, GType log_type, gint io_priority, GCancellable *cancellable, GAsyncReadyCallback cb, gpointer userdata);
/**
- * Finishes asynchronously lister listing the #PurpleLog<!-- -->s of a requested type.
- * Remember to free the #GList returned if you do not store it.
+ * Finishes asynchronously listing the logs of a requested type.
+ * Remember to free the list returned if you do not store it.
*
* Note: Make sure to examine that error is not NULL as it is completely possible
* for the list to be empty and the function to return NULL without an error
*
- * @param res A #GAsyncResult
- * @param error (out) (allow-none): a #GError location to store the error
+ * @param res A GAsyncResult
+ * @param error (out) (allow-none): a GError location to store the error
*
- * @return A sorted #GList of #PurpleLog<!-- -->s or %NULL on error
+ * @return A sorted list of list or %NULL on error
*
* @since 2.8.0
*/
@@ -194,42 +195,47 @@ GList *purple_log_common_lister_finish(G
* It should only be passed to purple_log_logger_new() and never
* called directly.
*
- * @param type The type of the logs being sized
+ * @param chat_type The type of the logs being sized
* @param name The name of the logs to size
* (e.g. the username or chat name)
* @param account The account of the log
* @param ext The file extension this log format uses
+ * @param cancellable (allow-none): GCancellable object
+ * @param error (out) (allow-none): a GError location to store the error
*
* @return The size of all the logs with the specified extension
* for the specified user
*/
-gssize purple_log_common_total_sizer(PurpleLogChatType purple_log_common_total_sizer_async, const gchar *name, PurpleAccount *account, const gchar *ext, GCancellable *cancellable, GError **error);
+gssize purple_log_common_total_sizer(PurpleLogChatType chat_type,
+ const gchar *name, PurpleAccount *account, const gchar *ext,
+ GCancellable *cancellable, GError **error);
/**
* Asychronously gets the total size of all the logs for a given user, with
* a given extension.
+ * See purple_log_common_total_sizer() for more details.
*
- * For more details, see purple_log_common_total_sizer() which is
- * the synchronous version of this call.
- *
- * @param type The type of the logs being sized
+ * @param chat_type The type of the logs being sized
* @param name The name of the logs to size (e.g. the username or chat name)
* @param account The account of the log
* @param ext The file extension this log format uses
* @param io_priority The io priority of the request
- * @param cancellable (allow-none): #GCancellable object
- * @param cb (allow-none): A #GAsyncReadyCallback to call when the request is satisfied
+ * @param cancellable (allow-none): GCancellable object
+ * @param cb (allow-none): A GAsyncReadyCallback to call when the request is satisfied
* @param userdata (allow-none): The data to pass to callback function
*
* @since 2.8.0
*/
-void purple_log_common_total_sizer_async(PurpleLogChatType chat_type, const gchar *name, PurpleAccount *account, const gchar *ext, gint io_priority, GCancellable *cancellable, GAsyncReadyCallback cb, gpointer userdata);
+void purple_log_common_total_sizer_async(PurpleLogChatType chat_type,
+ const gchar *name, PurpleAccount *account, const gchar *ext,
+ gint io_priority, GCancellable *cancellable, GAsyncReadyCallback cb,
+ gpointer userdata);
/**
* Finishes asynchronously getting the total size of logs for a given user
*
- * @param res A #GAsyncResult
- * @param error (out) (allow-none): a #GError location to store the error
+ * @param res A GAsyncResult
+ * @param error (out) (allow-none): a GError location to store the error
*
* @return size of file or -1 on error
*
More information about the Commits
mailing list