/pidgin/main: 35c6b0947dfc: purple-gio: Fix Gir annotation warnings

Mike Ruprecht <[email protected]> Tue, 06 Sep 2016 11:19:21 -0400
Newsgroups gmane.comp.gnome.gaim.cvs
Message-ID <[email protected]>
Changeset: 35c6b0947dfc778e14e670564d56816043bf4200
Author:	 Mike Ruprecht <[email protected]>
Date:	 2016-08-30 00:50 -0500
Branch:	 default
URL: https://hg.pidgin.im/pidgin/main/rev/35c6b0947dfc

Description:

purple-gio: Fix Gir annotation warnings

This patch fixes several Gir annotation build warnings:
 * GIOStream, GInputStream, and GOutputStream unresolved types
 * "optional" is only for out or inout parameters
 * purple_gio_socket_client_new() missing transfer notation for return

diffstat:

 libpurple/Makefile.am  |  2 +-
 libpurple/purple-gio.h |  6 +++---
 2 files changed, 4 insertions(+), 4 deletions(-)

diffs (35 lines):

diff --git a/libpurple/Makefile.am b/libpurple/Makefile.am
--- a/libpurple/Makefile.am
+++ b/libpurple/Makefile.am
@@ -503,7 +503,7 @@ introspection_sources = \
 	$(addprefix media/, $(purple_mediaheaders))
 
 Purple-$(PURPLE_MAJOR_VERSION).$(PURPLE_MINOR_VERSION).gir: $(builddir)/libpurple.la
-Purple_3_0_gir_INCLUDES = GObject-2.0
+Purple_3_0_gir_INCLUDES = Gio-2.0 GObject-2.0
 if PLUGINS
 Purple_3_0_gir_INCLUDES += GPlugin-0.0
 endif
diff --git a/libpurple/purple-gio.h b/libpurple/purple-gio.h
--- a/libpurple/purple-gio.h
+++ b/libpurple/purple-gio.h
@@ -44,8 +44,8 @@ G_BEGIN_DECLS
 /**
  * purple_gio_graceful_close:
  * @stream: A #GIOStream to close
- * @input: (optional): A #GInputStream which wraps @stream's input stream
- * @output: (optional): A #GOutputStream which wraps @stream's output stream
+ * @input: (nullable): A #GInputStream which wraps @stream's input stream
+ * @output: (nullable): A #GOutputStream which wraps @stream's output stream
  *
  * Closes @input, @output, @stream. If there are pending operations, it
  * asynchronously waits for the operations to finish before closing the
@@ -64,7 +64,7 @@ purple_gio_graceful_close(GIOStream *str
  * A helper function to simplify creating a #GSocketClient. It's intended
  * to be used in protocol plugins.
  *
- * Returns: A new #GSocketClient with the appropriate
+ * Returns: (transfer full): A new #GSocketClient with the appropriate
  * GProxyResolver, based on the #PurpleAccount settings and
  * TLS Certificate handling, or NULL if an error occurred.
  */

_______________________________________________
Commits mailing list
[email protected]
https://pidgin.im/cgi-bin/mailman/listinfo/commits