rtpjitterbuffer: fix RTPJitterBufferMode documentation
authorAurélien Zanelli <aurelien.zanelli@parrot.com>
Fri, 17 Jun 2016 11:58:33 +0000 (13:58 +0200)
committerSebastian Dröge <sebastian@centricular.com>
Fri, 17 Jun 2016 12:16:45 +0000 (15:16 +0300)
Documentation lacks '@' before each enum values and there was an extra
line after symbol section which confuses GTK-Doc parser.

https://bugzilla.gnome.org/show_bug.cgi?id=767788

gst/rtpmanager/rtpjitterbuffer.h

index c7115fe..08ce169 100644 (file)
@@ -36,20 +36,19 @@ typedef struct _RTPJitterBufferItem RTPJitterBufferItem;
 
 /**
  * RTPJitterBufferMode:
- *
- * RTP_JITTER_BUFFER_MODE_NONE: don't do any skew correction, outgoing
+ * @RTP_JITTER_BUFFER_MODE_NONE: don't do any skew correction, outgoing
  *    timestamps are calculated directly from the RTP timestamps. This mode is
  *    good for recording but not for real-time applications.
- * RTP_JITTER_BUFFER_MODE_SLAVE: calculate the skew between sender and receiver
+ * @RTP_JITTER_BUFFER_MODE_SLAVE: calculate the skew between sender and receiver
  *    and produce smoothed adjusted outgoing timestamps. This mode is good for
  *    low latency communications.
- * RTP_JITTER_BUFFER_MODE_BUFFER: buffer packets between low/high watermarks.
+ * @RTP_JITTER_BUFFER_MODE_BUFFER: buffer packets between low/high watermarks.
  *    This mode is good for streaming communication.
- * RTP_JITTER_BUFFER_MODE_SYNCED: sender and receiver clocks are synchronized,
+ * @RTP_JITTER_BUFFER_MODE_SYNCED: sender and receiver clocks are synchronized,
  *    like #RTP_JITTER_BUFFER_MODE_SLAVE but skew is assumed to be 0. Good for
  *    low latency communication when sender and receiver clocks are
  *    synchronized and there is thus no clock skew.
- * RTP_JITTER_BUFFER_MODE_LAST: last buffer mode.
+ * @RTP_JITTER_BUFFER_MODE_LAST: last buffer mode.
  *
  * The different buffer modes for a jitterbuffer.
  */