[Spice-commits] src/channel-display.c

[GitLab Mirror]

 src/channel-display.c |   14 +++++++-------
 1 file changed, 7 insertions(+), 7 deletions(-)

New commits:
commit b646ac8168922600262dddc78149f04f7c9edec7
Author: Marc-André Lureau <marcandre.lureau at redhat.com>
Date:   Thu Jan 3 20:45:46 2019 +0400

    display: fix SpiceDisplayChannel::gst-video-overlay comment
    
    - the symbol to document should end with colon
    - "Since:" tag must have colon
    - s/gstreamer/GStreamer
    - s/regeister/register
    - s/Return/Returns, update doc
    
    Signed-off-by: Marc-André Lureau <marcandre.lureau at redhat.com>
    Acked-by: Frediano Ziglio <fziglio at redhat.com>

diff --git a/src/channel-display.c b/src/channel-display.c
index 2a1d9d1..8c0fe5a 100644
--- a/src/channel-display.c
+++ b/src/channel-display.c
@@ -456,17 +456,17 @@ static void spice_display_channel_class_init(SpiceDisplayChannelClass *klass)
                      G_TYPE_UINT, G_TYPE_UINT, G_TYPE_UINT, G_TYPE_UINT);
 
     /**
-     * SpiceDisplayChannel::gst-video-overlay
+     * SpiceDisplayChannel::gst-video-overlay:
      * @display: the #SpiceDisplayChannel that emitted the signal
-     * @pipeline: pointer to gstreamer's pipeline
-     *
-     * Return: valid window handle on success
+     * @pipeline: pointer to GStreamer's pipeline
      *
      * The #SpiceDisplayChannel::gst-video-overlay signal is emitted when
-     * pipeline is ready and can be passed to widget to regeister gstreamer
-     * overlay interface and other gstreamer callbacks.
+     * pipeline is ready and can be passed to widget to register GStreamer
+     * overlay interface and other GStreamer callbacks.
+     *
+     * Returns: %TRUE if the overlay is being set
      *
-     * Since 0.36
+     * Since: 0.36
      **/
     signals[SPICE_DISPLAY_OVERLAY] =
         g_signal_new("gst-video-overlay",