cpw.nader.asynclogging-3: e66d76ed: More log.h cleanup and added more of the...
morshed.nader at gmail.com
morshed.nader at gmail.com
Fri Mar 18 01:08:11 EDT 2011
----------------------------------------------------------------------
Revision: e66d76ed2f6b5855bc7e48c9b8f361bf76f566dd
Parent: 1c270848b4795b63e72d410c85bde8dedae44ec5
Author: morshed.nader at gmail.com
Date: 03/18/11 00:59:43
Branch: im.pidgin.cpw.nader.asynclogging-3
URL: http://d.pidgin.im/viewmtn/revision/info/e66d76ed2f6b5855bc7e48c9b8f361bf76f566dd
Changelog:
More log.h cleanup and added more of the docs that were previously missing
Changes against parent 1c270848b4795b63e72d410c85bde8dedae44ec5
patched libpurple/log.h
-------------- next part --------------
============================================================
--- libpurple/log.h 89fd9b660ba0d39e502bdb2612bc61656d763cb8
+++ libpurple/log.h 38c5070565147de30387bd745781d3a1891200a1
@@ -422,7 +422,7 @@ gssize purple_log_write(PurpleLog *log,
* @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
+ * @since 3.0.0
*/
void purple_log_write_async(PurpleLog *log, PurpleMessageFlags type,
const gchar *from, time_t time, const gchar *message, gint io_priority,
@@ -437,7 +437,7 @@ void purple_log_write_async(PurpleLog *l
*
* @return Number of bytes written, -1 on failure
*
- * @since 2.8.0
+ * @since 3.0.0
*/
gssize purple_log_write_finish(PurpleLog *log, GAsyncResult *res,
GError **error);
@@ -449,10 +449,10 @@ gssize purple_log_write_finish(PurpleLog
* @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
+ * Note: The error will not have HTML formatting applied
*
* @return The contents of this log in Purple Markup
*/
-// NOTE: Error does not have HTML formatting applied
gchar *purple_log_read(PurpleLog *log, PurpleLogReadFlags *flags,
GCancellable *cancellable, GError **error);
@@ -465,7 +465,7 @@ gchar *purple_log_read(PurpleLog *log, P
* @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
+ * @since 3.0.0
*/
void purple_log_read_async(PurpleLog *log, gint io_priority,
GCancellable *cancellable, GAsyncReadyCallback cb, gpointer userdata);
@@ -482,7 +482,7 @@ void purple_log_read_async(PurpleLog *lo
*
* @return pointer to contents of file or %NULL on error
*
- * @since 2.8.0
+ * @since 3.0.0
*/
gchar *purple_log_read_finish(PurpleLog *log, GAsyncResult *res,
PurpleLogReadFlags *flags, GError **error);
@@ -506,7 +506,7 @@ gssize purple_log_get_size(PurpleLog *lo
* @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
+ * @since 3.0.0
*/
void purple_log_get_size_async(PurpleLog *log, gint io_priority,
GCancellable *cancellable, GAsyncReadyCallback cb, gpointer userdata);
@@ -520,14 +520,15 @@ void purple_log_get_size_async(PurpleLog
*
* @return size of file or -1 on error
*
- * @since 2.8.0
+ * @since 3.0.0
*/
gssize purple_log_get_size_finish(PurpleLog *log, GAsyncResult *res,
GError **error);
/**
- * Returns a list of all available logs
+ * Returns a list of all available logs for a given logger
*
+ * @param log A dummy log of the type of logger to list the logs of
* @param type The type of the log
* @param name The name of the log
* @param account The account
@@ -539,24 +540,27 @@ GList *purple_log_get_logs(PurpleLog *lo
GError **error);
/**
- * Asynchronously gets a list of all available logs
+ * Asynchronously gets a list of all available logs for a given logger
*
+ * @param log A dummy log of the type of logger to list the logs of
* @param type The type of the log
* @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 request is satisfied
+ * @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
+ * @since 3.0.0
*/
void purple_log_get_logs_async(PurpleLog *log, PurpleLogChatType type,
const gchar *name, PurpleAccount *account, gint io_priority,
GCancellable *cancellable, GAsyncReadyCallback cb, gpointer userdata);
/**
- * Finishes asynchronously getting a list of all available logs
+ * Finishes asynchronously getting a list of all available logs for a given
+ * logger
*
* 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
@@ -566,20 +570,61 @@ void purple_log_get_logs_async(PurpleLog
*
* @return pointer to log list or %NULL on error
*
- * @since 2.8.0
+ * @since 3.0.0
*/
GList *purple_log_get_logs_finish(PurpleLog *log, GAsyncResult *res,
GError **error);
-
-//
+/**
+ * Gets a list of all available logs for all available added loggers
+ *
+ * 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 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
+ *
+ * @return pointer to log list or %NULL on error
+ *
+ * @since 3.0.0
+ */
GList *purple_logs_get_logs(PurpleLogChatType type, const gchar *name,
PurpleAccount *account, GCancellable *cancellable, GError **error);
-//
+
+/**
+ * Asynchronously gets a list of all available logs for all available added loggers
+ *
+ * @param type The type of the log
+ * @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 request is satisfied
+ * @param userdata (allow-none): The data to pass to callback function
+ *
+ * @return pointer to log list or %NULL on error
+ *
+ * @since 3.0.0
+ */
void purple_logs_get_logs_async(PurpleLogChatType type, const gchar *name,
PurpleAccount *account, gint io_priority, GCancellable *cancellable,
GAsyncReadyCallback cb, gpointer userdata);
-//
+
+/**
+ * Finishes asynchronously getting a list of all available logs
+ *
+ * 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
+ *
+ * @return pointer to log list or %NULL on error
+ *
+ * @since 3.0.0
+ */
GList *purple_logs_get_logs_finish(GAsyncResult *res, GError **error);
/**
@@ -601,7 +646,7 @@ GList *purple_log_get_system_logs(Purple
* @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
+ * @since 3.0.0
*/
void purple_log_get_system_logs_async(PurpleLog *log, PurpleAccount *account,
gint io_priority, GCancellable *cancellable, GAsyncReadyCallback cb,
@@ -618,7 +663,7 @@ void purple_log_get_system_logs_async(Pu
*
* @return pointer to log list or %NULL on error
*
- * @since 2.8.0
+ * @since 3.0.0
*/
GList *purple_log_get_system_logs_finish(PurpleLog *log, GAsyncResult *res,
GError **error);
@@ -657,7 +702,7 @@ gssize purple_log_get_total_size(PurpleL
* @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
+ * @since 3.0.0
*/
void purple_log_get_total_size_async(PurpleLog *log, PurpleLogChatType type,
const gchar *name, PurpleAccount *account, gint io_priority,
@@ -671,7 +716,7 @@ void purple_log_get_total_size_async(Pur
*
* @return size of file or -1 on error
*
- * @since 2.8.0
+ * @since 3.0.0
*/
gssize purple_log_get_total_size_finish(PurpleLog *log, GAsyncResult *res,
GError **error);
@@ -718,7 +763,7 @@ GHashTable *purple_log_get_log_sets(Purp
* @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
+ * @since 3.0.0
*/
void purple_log_get_log_sets_async(PurpleLog *log, gint io_priority,
GCancellable *cancellable, GAsyncReadyCallback cb, gpointer userdata);
@@ -731,7 +776,7 @@ void purple_log_get_log_sets_async(Purpl
*
* @return pointer to hash table of log sets or %NULL on error
*
- * @since 2.8.0
+ * @since 3.0.0
*/
GHashTable *purple_log_get_log_sets_finish(PurpleLog *log, GAsyncResult *res,
GError **error);
@@ -773,7 +818,7 @@ gssize purple_log_get_activity_score(Pur
* @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
+ * @since 3.0.0
*/
void purple_log_get_activity_score_async(PurpleLogChatType type,
const gchar *name, PurpleAccount *account, gint io_priority,
@@ -787,7 +832,7 @@ void purple_log_get_activity_score_async
*
* @return The activity score of the log or -1 on failure
*
- * @since 2.8.0
+ * @since 3.0.0
*/
gssize purple_log_get_activity_score_finish(GAsyncResult *res, GError **error);
@@ -823,7 +868,7 @@ gboolean purple_log_remove(PurpleLog *lo
* @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
+ * @since 3.0.0
*/
void purple_log_remove_async(PurpleLog *log, gint io_priority,
GCancellable *cancellable, GAsyncReadyCallback cb, gpointer userdata);
@@ -837,7 +882,7 @@ void purple_log_remove_async(PurpleLog *
*
* @return %TRUE if the log was removed, %FALSE otherwise
*
- * @since 2.8.0
+ * @since 3.0.0
*/
gboolean purple_log_remove_finish(PurpleLog *log, GAsyncResult *res,
GError **error);
@@ -939,7 +984,7 @@ GType purple_log_logger_get_default(void
*
* @return All available loggers
*
- * @since 2.8.0
+ * @since 3.0.0
*/
GArray *purple_log_logger_get_all(void);
More information about the Commits
mailing list