purple-gio: Fix Gir annotation warnings

Tue, 30 Aug 2016 00:50:41 -0500

author
Mike Ruprecht <cmaiku@gmail.com>
date
Tue, 30 Aug 2016 00:50:41 -0500
changeset 37971
35c6b0947dfc
parent 37967
5230b8073a37
child 37972
a728c6b23e00

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

libpurple/Makefile.am file | annotate | diff | comparison | revisions
libpurple/purple-gio.h file | annotate | diff | comparison | revisions
--- a/libpurple/Makefile.am	Sun Aug 28 22:57:37 2016 -0500
+++ b/libpurple/Makefile.am	Tue Aug 30 00:50:41 2016 -0500
@@ -503,7 +503,7 @@
 	$(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
--- a/libpurple/purple-gio.h	Sun Aug 28 22:57:37 2016 -0500
+++ b/libpurple/purple-gio.h	Tue Aug 30 00:50:41 2016 -0500
@@ -44,8 +44,8 @@
 /**
  * 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 @@
  * 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.
  */

mercurial