Minor docs fixes.

Original commit message from CVS:
* docs/gst/gstreamer-sections.txt:
* gst/gstevent.c:
* gst/gstevent.h:
* gst/gstmessage.h:
Minor docs fixes.

diff --git a/ChangeLog b/ChangeLog
index 8106ade..de1f0eb 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,11 @@
+2006-05-14  Tim-Philipp Müller  <tim at centricular dot net>
+
+       * docs/gst/gstreamer-sections.txt:
+       * gst/gstevent.c:
+       * gst/gstevent.h:
+       * gst/gstmessage.h:
+         Minor docs fixes.
+
 === release 0.10.6 ===
 
 2006-05-14  Jan Schmidt <thaytan@mad.scientist.com>

diff --git a/docs/gst/gstreamer-sections.txt b/docs/gst/gstreamer-sections.txt
index 2e989ce..28100d9 100644 (file)
--- a/docs/gst/gstreamer-sections.txt
+++ b/docs/gst/gstreamer-sections.txt
@@ -629,11 +629,13 @@ gst_event_new_flush_start
 gst_event_new_flush_stop
 gst_event_new_navigation
 gst_event_new_new_segment
+gst_event_new_new_segment_full
 gst_event_new_qos
 gst_event_new_seek
 gst_event_new_tag
 gst_event_parse_buffer_size
 gst_event_parse_new_segment
+gst_event_parse_new_segment_full
 gst_event_parse_qos
 gst_event_parse_seek
 gst_event_parse_tag
@@ -1663,6 +1665,7 @@ gst_segment_free
 gst_segment_set_duration
 gst_segment_set_last_stop
 gst_segment_set_newsegment
+gst_segment_set_newsegment_full
 gst_segment_set_seek
 gst_segment_to_running_time
 gst_segment_to_stream_time
@@ -1792,6 +1795,7 @@ GST_TAG_TRACK_PEAK
 GST_TAG_ALBUM_GAIN
 GST_TAG_ALBUM_PEAK
 GST_TAG_LANGUAGE_CODE
+GST_TAG_IMAGE
 
 gst_tag_register
 gst_tag_merge_use_first

diff --git a/gst/gstevent.c b/gst/gstevent.c
index ab7f6b8..c5d7da6 100644 (file)
--- a/gst/gstevent.c
+++ b/gst/gstevent.c
@@ -422,6 +422,8 @@ gst_event_new_eos (void)
  *
  * This method calls gst_event_new_new_segment_full() passing a default
  * value of 1.0 for applied_rate
+ *
+ * Returns: A new newsegment event.
  */
 GstEvent *
 gst_event_new_new_segment (gboolean update, gdouble rate, GstFormat format,

diff --git a/gst/gstevent.h b/gst/gstevent.h
index 439a3d6..97af1c2 100644 (file)
--- a/gst/gstevent.h
+++ b/gst/gstevent.h
@@ -322,12 +322,14 @@ GType             gst_event_get_type              (void);
 /* refcounting */
 /**
  * gst_event_ref:
- * @ev: The event to refcount
+ * @event: The event to refcount
  *
  * Increase the refcount of this event.
+ *
+ * Returns: @event (for convenience when doing assignments)
  */
 #ifdef _FOOL_GTK_DOC_
-G_INLINE_FUNC GstEvent * gst_event_ref (GstEvent * ev);
+G_INLINE_FUNC GstEvent * gst_event_ref (GstEvent * event);
 #endif
 
 static inline GstEvent *

diff --git a/gst/gstmessage.h b/gst/gstmessage.h
index 5e20a3d..2b3f69b 100644 (file)
--- a/gst/gstmessage.h
+++ b/gst/gstmessage.h
@@ -196,8 +196,9 @@ GQuark              gst_message_type_to_quark       (GstMessageType type);
  * gst_message_ref:
  * @msg: the message to ref
  *
- * Convenience macro to increase the reference count of the message. Returns the
- * reffed message.
+ * Convenience macro to increase the reference count of the message.
+ *
+ * Returns: @msg (for convenience when doing assignments)
  */
 #ifdef _FOOL_GTK_DOC_
 G_INLINE_FUNC GstMessage * gst_message_ref (GstMessage * msg);