From 81a2928c89e058a27d8b830a8df77d598baf5fd9 Mon Sep 17 00:00:00 2001 From: Sebastian Rasmussen Date: Sun, 2 Mar 2014 05:12:10 +0100 Subject: [PATCH] docs: Enable and fix gtk-doc warnings * Makefile: Enable gtk-doc warnings, like the rest of GStreamer * addresspool/mediafactory: Add missing annotation colon * stream: Annotate return value Fixes https://bugzilla.gnome.org/show_bug.cgi?id=725528 --- gst/rtsp-server/Makefile.am | 1 + gst/rtsp-server/rtsp-address-pool.c | 2 +- gst/rtsp-server/rtsp-media-factory.c | 2 +- gst/rtsp-server/rtsp-stream.c | 8 ++++---- 4 files changed, 7 insertions(+), 6 deletions(-) diff --git a/gst/rtsp-server/Makefile.am b/gst/rtsp-server/Makefile.am index 7697ae845a..bbae027de5 100644 --- a/gst/rtsp-server/Makefile.am +++ b/gst/rtsp-server/Makefile.am @@ -75,6 +75,7 @@ GstRtspServer-@GST_API_VERSION@.gir: $(INTROSPECTION_SCANNER) libgstrtspserver-@ $(INTROSPECTION_SCANNER) -v --namespace GstRtspServer \ --nsversion=@GST_API_VERSION@ \ --strip-prefix=Gst \ + --warn-all \ -I$(top_srcdir) \ -I$(top_builddir) \ -DIN_GOBJECT_INTROSPECTION=1 \ diff --git a/gst/rtsp-server/rtsp-address-pool.c b/gst/rtsp-server/rtsp-address-pool.c index 4f433be376..c6ba13d567 100644 --- a/gst/rtsp-server/rtsp-address-pool.c +++ b/gst/rtsp-server/rtsp-address-pool.c @@ -625,7 +625,7 @@ find_address_in_ranges (GList * addresses, Addr * addr, guint port, * @port: The first port to reserve * @n_ports: The number of ports * @ttl: The requested ttl - * @address: (out) storage for a #GstRTSPAddress + * @address: (out): storage for a #GstRTSPAddress * * Take a specific address and ports from @pool. @n_ports consecutive * ports will be allocated of which the first one can be found in diff --git a/gst/rtsp-server/rtsp-media-factory.c b/gst/rtsp-server/rtsp-media-factory.c index 590b1f7d69..b8a781cea5 100644 --- a/gst/rtsp-server/rtsp-media-factory.c +++ b/gst/rtsp-server/rtsp-media-factory.c @@ -1053,7 +1053,7 @@ default_configure (GstRTSPMediaFactory * factory, GstRTSPMedia * media) * implementation of this function returns the bin created from the * launch parameter. * - * Returns: (transfer floating) a new #GstElement. + * Returns: (transfer floating): a new #GstElement. */ GstElement * gst_rtsp_media_factory_create_element (GstRTSPMediaFactory * factory, diff --git a/gst/rtsp-server/rtsp-stream.c b/gst/rtsp-server/rtsp-stream.c index 9c83c8251d..ec82a1f2d2 100644 --- a/gst/rtsp-server/rtsp-stream.c +++ b/gst/rtsp-server/rtsp-stream.c @@ -2186,8 +2186,8 @@ gst_rtsp_stream_remove_transport (GstRTSPStream * stream, * * @stream must be joined to a bin. * - * Returns: the RTP socket or %NULL if no socket could be allocated for @family. - * Unref after usage + * Returns: (transfer full): the RTP socket or %NULL if no socket could be + * allocated for @family. Unref after usage */ GSocket * gst_rtsp_stream_get_rtp_socket (GstRTSPStream * stream, GSocketFamily family) @@ -2220,8 +2220,8 @@ gst_rtsp_stream_get_rtp_socket (GstRTSPStream * stream, GSocketFamily family) * * @stream must be joined to a bin. * - * Returns: the RTCP socket or %NULL if no socket could be allocated for - * @family. Unref after usage + * Returns: (transfer full): the RTCP socket or %NULL if no socket could be + * allocated for @family. Unref after usage */ GSocket * gst_rtsp_stream_get_rtcp_socket (GstRTSPStream * stream, GSocketFamily family)