changeset 20893:c521b0f72a7b

Add "@since 2.3.0" annotations to the new API, as advocated by rlaager.
author Will Thompson <will.thompson@collabora.co.uk>
date Fri, 12 Oct 2007 23:22:46 +0000
parents bbcc9e206c43
children fa3c4c5dea66
files libpurple/connection.h
diffstat 1 files changed, 7 insertions(+), 1 deletions(-) [+]
line wrap: on
line diff
--- a/libpurple/connection.h	Fri Oct 12 00:19:12 2007 +0000
+++ b/libpurple/connection.h	Fri Oct 12 23:22:46 2007 +0000
@@ -54,7 +54,9 @@
 
 } PurpleConnectionState;
 
-/** Possible errors that can cause a connection to be closed. */
+/** Possible errors that can cause a connection to be closed.
+ *  @since 2.3.0
+ */
 typedef enum
 {
 	/** There was an error sending or receiving on the network socket, or
@@ -195,6 +197,7 @@
 	 *  @param text  a localized message describing the disconnection
 	 *               in more detail to the user.
 	 *  @see #purple_connection_error_reason
+	 *  @since 2.3.0
 	 */
 	void (*report_disconnect_reason)(PurpleConnection *gc,
 	                                 PurpleDisconnectReason reason,
@@ -400,6 +403,7 @@
  *
  * @param reason      why the connection is closing.
  * @param description a localized description of the error.
+ * @since 2.3.0
  */
 void
 purple_connection_error_reason (PurpleConnection *gc,
@@ -410,6 +414,7 @@
  * Closes a connection due to an SSL error; this is basically a shortcut to
  * turning the #PurpleSslErrorType into a #PurpleDisconnectReason and a
  * human-readable string and then calling purple_connection_error_reason().
+ * @since 2.3.0
  */
 void
 purple_connection_ssl_error (PurpleConnection *gc,
@@ -432,6 +437,7 @@
  *
  * @return @c TRUE if the account should not be automatically reconnected, and
  *         @c FALSE otherwise.
+ * @since 2.3.0
  */
 gboolean
 purple_connection_reason_is_fatal (PurpleDisconnectReason reason);