From b56930704f0c8ab17e24716f16a841154ca94021 Mon Sep 17 00:00:00 2001 From: Thibault Saunier Date: Thu, 13 Apr 2017 14:20:10 -0300 Subject: [PATCH] gi: Fix some annotations and docstrings --- gst/rtsp-server/rtsp-media-factory.c | 12 ++++++------ gst/rtsp-server/rtsp-media.c | 2 +- gst/rtsp-server/rtsp-session.c | 4 ++-- gst/rtsp-server/rtsp-stream.c | 9 +++++---- 4 files changed, 14 insertions(+), 13 deletions(-) diff --git a/gst/rtsp-server/rtsp-media-factory.c b/gst/rtsp-server/rtsp-media-factory.c index fc760aa..cecb8a0 100644 --- a/gst/rtsp-server/rtsp-media-factory.c +++ b/gst/rtsp-server/rtsp-media-factory.c @@ -803,10 +803,10 @@ gst_rtsp_media_factory_get_address_pool (GstRTSPMediaFactory * factory) /** * gst_rtsp_media_factory_set_multicast_iface: - * @media_factory: a #GstRTSPMediaFactory + * @factory: a #GstRTSPMediaFactory * @multicast_iface: (transfer none): a multicast interface name * - * configure @multicast_iface to be used for @media_factory. + * configure @multicast_iface to be used for @factory. */ void gst_rtsp_media_factory_set_multicast_iface (GstRTSPMediaFactory * media_factory, @@ -834,11 +834,11 @@ gst_rtsp_media_factory_set_multicast_iface (GstRTSPMediaFactory * media_factory, /** * gst_rtsp_media_factory_get_multicast_iface: - * @media_factory: a #GstRTSPMediaFactory + * @factory: a #GstRTSPMediaFactory * - * Get the multicast interface used for @media_factory. + * Get the multicast interface used for @factory. * - * Returns: (transfer full): the multicast interface for @media_factory. g_free() after + * Returns: (transfer full): the multicast interface for @factory. g_free() after * usage. */ gchar * @@ -1292,7 +1292,7 @@ gst_rtsp_media_factory_get_media_gtype (GstRTSPMediaFactory * factory) /** * gst_rtsp_media_factory_set_clock: * @factory: a #GstRTSPMediaFactory - * @clockd: the clock to be used by the media factory + * @clock: the clock to be used by the media factory * * Configures a specific clock to be used by the pipelines * of all medias created from this factory. diff --git a/gst/rtsp-server/rtsp-media.c b/gst/rtsp-server/rtsp-media.c index a7f3460..996f453 100644 --- a/gst/rtsp-server/rtsp-media.c +++ b/gst/rtsp-server/rtsp-media.c @@ -1494,7 +1494,7 @@ gst_rtsp_media_set_publish_clock_mode (GstRTSPMedia * media, /** * gst_rtsp_media_get_publish_clock_mode: - * @factory: a #GstRTSPMedia + * @media: a #GstRTSPMedia * * Gets if and how the media clock should be published according to RFC7273. * diff --git a/gst/rtsp-server/rtsp-session.c b/gst/rtsp-server/rtsp-session.c index e4ef122..e6faaf5 100644 --- a/gst/rtsp-server/rtsp-session.c +++ b/gst/rtsp-server/rtsp-session.c @@ -617,7 +617,7 @@ gst_rtsp_session_allow_expire (GstRTSPSession * session) /** * gst_rtsp_session_next_timeout_usec: * @session: a #GstRTSPSession - * @now: (transfer none): the current monotonic time + * @now: the current monotonic time * * Get the amount of milliseconds till the session will expire. * @@ -716,7 +716,7 @@ gst_rtsp_session_next_timeout (GstRTSPSession * session, GTimeVal * now) /** * gst_rtsp_session_is_expired_usec: * @session: a #GstRTSPSession - * @now: (transfer none): the current monotonic time + * @now: the current monotonic time * * Check if @session timeout out. * diff --git a/gst/rtsp-server/rtsp-stream.c b/gst/rtsp-server/rtsp-stream.c index 445b924..6bb24df 100644 --- a/gst/rtsp-server/rtsp-stream.c +++ b/gst/rtsp-server/rtsp-stream.c @@ -1416,7 +1416,8 @@ cleanup: * gst_rtsp_stream_allocate_udp_sockets: * @stream: a #GstRTSPStream * @family: protocol family - * @transport_method: transport method + * @transport: transport method + * @use_client_setttings: Whether to use client settings or not * * Allocates RTP and RTCP ports. * @@ -1574,7 +1575,7 @@ gst_rtsp_stream_get_rtpsession (GstRTSPStream * stream) } /** - * gst_rtsp_stream_get_encoder: + * gst_rtsp_stream_get_srtp_encoder: * @stream: a #GstRTSPStream * * Get the SRTP encoder for this stream. @@ -2262,7 +2263,7 @@ gst_rtsp_stream_set_publish_clock_mode (GstRTSPStream * stream, /** * gst_rtsp_stream_get_publish_clock_mode: - * @factory: a #GstRTSPStream + * @stream: a #GstRTSPStream * * Gets if and how the stream clock should be published according to RFC7273. * @@ -2977,7 +2978,7 @@ gst_rtsp_stream_get_joined_bin (GstRTSPStream * stream) * @rtptime: (allow-none): result RTP timestamp * @seq: (allow-none): result RTP seqnum * @clock_rate: (allow-none): the clock rate - * @running_time: (allow-none): result running-time + * @running_time: result running-time * * Retrieve the current rtptime, seq and running-time. This is used to * construct a RTPInfo reply header. -- 2.7.4