cpw.nader.asynclogging-3: 9cc4e609: Filled in more of the function docs

morshed.nader at gmail.com morshed.nader at gmail.com
Mon May 30 03:07:54 EDT 2011


----------------------------------------------------------------------
Revision: 9cc4e609aa175bd263da6730279245b6d61682f5
Parent:   bad2521d29a448e5d9e652b494d1dc099c07cd2c
Author:   morshed.nader at gmail.com
Date:     05/30/11 02:49:01
Branch:   im.pidgin.cpw.nader.asynclogging-3
URL: http://d.pidgin.im/viewmtn/revision/info/9cc4e609aa175bd263da6730279245b6d61682f5

Changelog: 

Filled in more of the function docs
Added @since 3.0.0 to function docs when needed (Left out a bunch)
Moved the additions to the changelog from being under 2.8.0 to 3.0.0

Changes against parent bad2521d29a448e5d9e652b494d1dc099c07cd2c

  patched  ChangeLog
  patched  ChangeLog.API
  patched  libpurple/commonlog.h
  patched  libpurple/htmllog.h
  patched  libpurple/oldlog.h
  patched  libpurple/txtlog.h

-------------- next part --------------
============================================================
--- ChangeLog	1d32c74cdefe811faf293727f08051bb1b3c44fc
+++ ChangeLog	d98176fd46847db37a713f10a8997ac26f5e0e70
@@ -1,6 +1,6 @@ Pidgin and Finch: The Pimpin' Penguin IM
 Pidgin and Finch: The Pimpin' Penguin IM Clients That're Good for the Soul
 
-version 2.8.0 (??/??/????):
+version 3.0.0 (??/??/????):
 	libpurple:
 	* Added a non-blocking API (#2280)
 	* Added a dependency for gio-2.0, which is packaged with glib-2.0 >= 2.16
@@ -14,7 +14,6 @@ version 2.8.0 (??/??/????):
 	Plugins:
 	* Updated the History and GntHistory plugins to make use of the non-blocking API (#2280)
 
-version 3.0.0 (??/??/????):
 	AIM and ICQ:
 	* Make buddy list management code more efficient. (Oliver) (#4816)
 	* Don't try to format ICQ usernames entered as email addresses.
============================================================
--- ChangeLog.API	6d17d3b1d80d371e038baac0b5807ea77614650a
+++ ChangeLog.API	b4570979414fbe930b25f20e861203e55d0b10c5
@@ -1,8 +1,12 @@ Pidgin and Finch: The Pimpin' Penguin IM
 Pidgin and Finch: The Pimpin' Penguin IM Clients That're Good for the Soul
 
-version 2.8.0 (??/??/????):
+version 3.0.0 (??/??/????):
 	libpurple:
 		Added:
+		* purple_notify_searchresult_column_set_visible
+		* purple_notify_searchresult_column_is_visible
+		* purple_request_field_set_tooltip
+		* purple_request_field_get_tooltip
 		* Non-blocking Logging API
 		   * purple_log_write_async, purple_log_write_finish
 		   * purple_log_read_async, purple_log_read_finish
@@ -20,14 +24,6 @@ version 2.8.0 (??/??/????):
 		   * purple_log_common_deleter_async, purple_log_common_deleter_finish
 		   * purple_log_logger_get_all
 
-version 3.0.0 (??/??/????):
-	libpurple:
-		Added:
-		* purple_notify_searchresult_column_set_visible
-		* purple_notify_searchresult_column_is_visible
-		* purple_request_field_set_tooltip
-		* purple_request_field_get_tooltip
-
 		Removed:
 		* purple_core_migrate
 
============================================================
--- libpurple/htmllog.h	36e36ec777c4de014baccedbdc6c0c2e122f31fa
+++ libpurple/htmllog.h	3ef714bac4135573acd829b8a7e19f3af55eda83
@@ -59,7 +59,18 @@ GType purple_html_log_get_type(void);
 
 GType purple_html_log_get_type(void);
 
+/**
+ * Initializes the html log subsystem
+ *
+ * @since 3.0.0
+ */
 void purple_html_log_system_init(void);
+
+/**
+ * Uninitializes the html log subsystem
+ *
+ * @since 3.0.0
+ */
 void purple_html_log_system_uninit(void);
 
 G_END_DECLS
============================================================
--- libpurple/oldlog.h	0707dad69972f2f10e4fe4371ab32978ddeffb43
+++ libpurple/oldlog.h	e159c52419a0331fc0ec96f79f01c5a5378690c1
@@ -59,7 +59,18 @@ GType purple_old_log_get_type(void);
 
 GType purple_old_log_get_type(void);
 
+/**
+ * Initializes the old log subsystem
+ *
+ * @since 3.0.0
+ */
 void purple_old_log_system_init(void);
+
+/**
+ * Uninitializes the old log subsystem
+ *
+ * @since 3.0.0
+ */
 void purple_old_log_system_uninit(void);
 
 G_END_DECLS
============================================================
--- libpurple/txtlog.h	d808d3d4f4e7b2a46ad2272d6b2c99cd9676b068
+++ libpurple/txtlog.h	dcc400cfa66ea52d31496a4d1db49c4e808d424f
@@ -59,7 +59,18 @@ GType purple_txt_log_get_type(void);
 
 GType purple_txt_log_get_type(void);
 
+/**
+ * Initializes the txt log subsystem
+ *
+ * @since 3.0.0
+ */
 void purple_txt_log_system_init(void);
+
+/**
+ * Uninitializes the txt log subsystem
+ *
+ * @since 3.0.0
+ */
 void purple_txt_log_system_uninit(void);
 
 G_END_DECLS
============================================================
--- libpurple/commonlog.h	fca243affd56e937745880cde7bfd22e73a56917
+++ libpurple/commonlog.h	5868e6aebb0e032f9dbcd80a594c921c473cd85a
@@ -71,6 +71,8 @@ GType purple_common_log_get_type(void);
  *
  * @param common_log   The log
  * @param file         The log's file
+ *
+ * @since 3.0.0
  */
 void purple_common_log_set_file(PurpleCommonLog *common_log, GFile *file);
 
@@ -79,6 +81,8 @@ void purple_common_log_set_file(PurpleCo
  *
  * @param common_log   The log
  * @param offset       The log's offset
+ *
+ * @since 3.0.0
  */
 void purple_common_log_set_offset(PurpleCommonLog *common_log, gssize offset);
 
@@ -88,6 +92,8 @@ void purple_common_log_set_offset(Purple
  *
  * @param common_log   The log
  * @param length       The log's size
+ *
+ * @since 3.0.0
  */
 void purple_common_log_set_length(PurpleCommonLog *common_log, gssize length);
 
@@ -98,6 +104,8 @@ void purple_common_log_set_length(Purple
  * @param commmon_log  The log
  *
  * @return             The log's file
+ *
+ * @since 3.0.0
  */
 GFile *purple_common_log_get_file(PurpleCommonLog *common_log);
 
@@ -107,6 +115,8 @@ GFile *purple_common_log_get_file(Purple
  * @param common_log   The log
  *
  * @return             The log's offset
+ *
+ * @since 3.0.0
  */
 gssize purple_common_log_get_offset(PurpleCommonLog *common_log);
 
@@ -116,6 +126,8 @@ gssize purple_common_log_get_offset(Purp
  * @param common_log   The log
  *
  * @return             The log's size
+ *
+ * @since 3.0.0
  */
 gssize purple_common_log_get_length(PurpleCommonLog *common_log);
 
@@ -152,6 +164,8 @@ gboolean purple_log_common_writer(Purple
  * @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 3.0.0
  */
 void purple_log_common_writer_async(PurpleLog *log, const gchar *ext,
 	gint io_priority, GCancellable *cancellable, GAsyncReadyCallback cb,
@@ -166,6 +180,8 @@ void purple_log_common_writer_async(Purp
  * @param error        (out) (allow-none): a GError location to store the error
  *
  * @return             %TRUE if the log was created, %FALSE otherwise
+ *
+ * @since 3.0.0
  */
 gboolean purple_log_common_writer_finish(PurpleLog *log, GAsyncResult *res,
 	GError **error);


More information about the Commits mailing list