From: Jan Schmidt <thaytan@noraisin.net>
Date: Fri, 22 May 2009 08:33:02 +0000 (+0100)
Subject: docs: Fix up some documentation warnings.
X-Git-Tag: RELEASE-0.10.24~234
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=c05e2382cb7a235c6e5eb4223f08c33371e07260;p=platform%2Fupstream%2Fgstreamer.git

docs: Fix up some documentation warnings.

Since: tags should always be the last thing in a doc block, apparently.
Add some Returns: descriptions to some recent functions.
---

diff --git a/gst/gstelement.c b/gst/gstelement.c
index 9a56465..1eb06fc 100644
--- a/gst/gstelement.c
+++ b/gst/gstelement.c
@@ -2199,9 +2199,9 @@ complete:
  * This function is used internally and should normally not be called from
  * plugins or applications.
  *
- * Since: 0.10.24
- *
  * MT safe.
+ *
+ * Since: 0.10.24
  */
 void
 gst_element_lost_state_full (GstElement * element, gboolean new_base_time)
diff --git a/gst/gstmessage.c b/gst/gstmessage.c
index 1775877..f2e166b 100644
--- a/gst/gstmessage.c
+++ b/gst/gstmessage.c
@@ -303,9 +303,9 @@ gst_message_new_custom (GstMessageType type, GstObject * src,
  *
  * Returns: The message's sequence number.
  *
- * Since: 0.10.22
- *
  * MT safe.
+ *
+ * Since: 0.10.22
  */
 guint32
 gst_message_get_seqnum (GstMessage * message)
@@ -326,9 +326,9 @@ gst_message_get_seqnum (GstMessage * message)
  * the message relates to other messages or events. See gst_message_get_seqnum()
  * for more information.
  *
- * Since: 0.10.22
- *
  * MT safe.
+ *
+ * Since: 0.10.22
  */
 void
 gst_message_set_seqnum (GstMessage * message, guint32 seqnum)
@@ -429,9 +429,9 @@ gst_message_new_warning (GstObject * src, GError * error, const gchar * debug)
  *
  * Returns: The new info message.
  *
- * Since: 0.10.12
- *
  * MT safe.
+ *
+ * Since: 0.10.12
  */
 GstMessage *
 gst_message_new_info (GstObject * src, GError * error, const gchar * debug)
@@ -490,9 +490,9 @@ gst_message_new_tag (GstObject * src, GstTagList * tag_list)
  *
  * Returns: The new buffering message.
  *
- * Since: 0.10.11
- *
  * MT safe.
+ *
+ * Since: 0.10.11
  */
 GstMessage *
 gst_message_new_buffering (GstObject * src, gint percent)
@@ -985,9 +985,9 @@ gst_message_parse_tag (GstMessage * message, GstTagList ** tag_list)
  * Extracts the buffering percent from the GstMessage. see also
  * gst_message_new_buffering().
  *
- * Since: 0.10.11
- *
  * MT safe.
+ *
+ * Since: 0.10.11
  */
 void
 gst_message_parse_buffering (GstMessage * message, gint * percent)
@@ -1500,9 +1500,9 @@ gst_message_new_stream_status (GstObject * src, GstStreamStatusType type,
  * owner remains valid for as long as the reference to @message is valid and
  * should thus not be unreffed.
  *
- * Since: 0.10.24.
- *
  * MT safe.
+ *
+ * Since: 0.10.24.
  */
 void
 gst_message_parse_stream_status (GstMessage * message,
diff --git a/gst/gstpad.c b/gst/gstpad.c
index 2dd07f3..a2b996b 100644
--- a/gst/gstpad.c
+++ b/gst/gstpad.c
@@ -4204,9 +4204,9 @@ gst_pad_chain (GstPad * pad, GstBuffer * buffer)
  *
  * Returns: a #GstFlowReturn from the pad.
  *
- * Since: 0.10.24
- *
  * MT safe.
+ *
+ * Since: 0.10.24
  */
 GstFlowReturn
 gst_pad_chain_list (GstPad * pad, GstBufferList * list)
diff --git a/gst/gsttask.c b/gst/gsttask.c
index e51e149..ea20073 100644
--- a/gst/gsttask.c
+++ b/gst/gsttask.c
@@ -481,9 +481,9 @@ gst_task_set_pool (GstTask * task, GstTaskPool * pool)
  * Objects can use custom GThreads or can perform additional configuration of
  * the threads (such as changing the thread priority) by installing callbacks.
  *
- * Since: 0.10.24
- *
  * MT safe.
+ *
+ * Since: 0.10.24
  */
 void
 gst_task_set_thread_callbacks (GstTask * task,
@@ -592,9 +592,9 @@ start_task (GstTask * task)
  *
  * Returns: %TRUE if the state could be changed.
  *
- * Since: 0.10.24
- *
  * MT safe.
+ *
+ * Since: 0.10.24
  */
 gboolean
 gst_task_set_state (GstTask * task, GstTaskState state)
diff --git a/gst/gstutils.h b/gst/gstutils.h
index 010254a..6cac84b 100644
--- a/gst/gstutils.h
+++ b/gst/gstutils.h
@@ -514,6 +514,8 @@ GST_BOILERPLATE_FULL (type, type_as_function, parent_type,              \
  *
  * Swap byte order of a 32-bit floating point value (float).
  *
+ * Returns: @in byte-swapped.
+ *
  * Since: 0.10.22
  *
  */
@@ -541,6 +543,8 @@ GFLOAT_SWAP_LE_BE(gfloat in)
  *
  * Swap byte order of a 64-bit floating point value (double).
  *
+ * Returns: @in byte-swapped.
+ *
  * Since: 0.10.22
  *
  */
@@ -673,6 +677,8 @@ GDOUBLE_SWAP_LE_BE(gdouble in)
  *
  * Read a 32 bit float value in little endian format from the memory buffer.
  *
+ * Returns: The floating point value read from @data
+ *
  * Since: 0.10.22
  *
  */
@@ -699,6 +705,8 @@ GST_READ_FLOAT_LE(const guint8 *data)
  *
  * Read a 32 bit float value in big endian format from the memory buffer.
  *
+ * Returns: The floating point value read from @data
+ *
  * Since: 0.10.22
  *
  */
@@ -725,6 +733,8 @@ GST_READ_FLOAT_BE(const guint8 *data)
  *
  * Read a 64 bit double value in little endian format from the memory buffer.
  *
+ * Returns: The double-precision floating point value read from @data
+ *
  * Since: 0.10.22
  *
  */
@@ -751,6 +761,8 @@ GST_READ_DOUBLE_LE(const guint8 *data)
  *
  * Read a 64 bit double value in big endian format from the memory buffer.
  *
+ * Returns: The double-precision floating point value read from @data
+ *
  * Since: 0.10.22
  *
  */