docs: Enable and fix gtk-doc warnings
authorSebastian Rasmussen <sebras@hotmail.com>
Sun, 2 Mar 2014 04:12:10 +0000 (05:12 +0100)
committerSebastian Dröge <sebastian@centricular.com>
Mon, 3 Mar 2014 08:43:05 +0000 (09:43 +0100)
 * 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
gst/rtsp-server/rtsp-address-pool.c
gst/rtsp-server/rtsp-media-factory.c
gst/rtsp-server/rtsp-stream.c

index 7697ae8..bbae027 100644 (file)
@@ -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 \
index 4f433be..c6ba13d 100644 (file)
@@ -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
index 590b1f7..b8a781c 100644 (file)
@@ -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,
index 9c83c82..ec82a1f 100644 (file)
@@ -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)