gst/: Make gtk-doc generate docs for our inlined gst_buffer_ref(), gst_event_ref...

Original commit message from CVS:
* gst/gstbuffer.h:
* gst/gstevent.h:
* gst/gstmessage.h:
Make gtk-doc generate docs for our inlined gst_buffer_ref(),
gst_event_ref() and gst_message_ref() functions again
(ugly hack, please do fix if there's a better way besides
overrides.txt, which doesn't seem to work).

diff --git a/ChangeLog b/ChangeLog
index 1a4db4cc66881e8e045bba00c5200fe35d720db3..88fe4f9053260aba1d2a4173beb068fabf5624ed 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,13 @@
+2006-05-10  Tim-Philipp Müller  <tim at centricular dot net>
+
+       * gst/gstbuffer.h:
+       * gst/gstevent.h:
+       * gst/gstmessage.h:
+         Make gtk-doc generate docs for our inlined gst_buffer_ref(),
+         gst_event_ref() and gst_message_ref() functions again
+         (ugly hack, please do fix if there's a better way besides
+         overrides.txt, which doesn't seem to work).
+
 2006-05-10  Thomas Vander Stichele  <thomas at apestaart dot org>
 
        * libs/gst/check/gstcheck.h:

diff --git a/gst/gstbuffer.h b/gst/gstbuffer.h
index 77ffd5d3400f0804733b8bb9fb44461576a618ac..70f8cd2cbe7a629d8f2540a60162553819f76e89 100644 (file)
--- a/gst/gstbuffer.h
+++ b/gst/gstbuffer.h
@@ -288,13 +288,18 @@ G_STMT_START {                                            \
  * Increases the refcount of the given buffer by one.
  *
  * Note that the refcount affects the writeability
- * of @buf, see gst_buffer_is_writable(). It is
+ * of @buf and its metadata, see gst_buffer_is_writable() and
+ * gst_buffer_is_metadata_writable(). It is
  * important to note that keeping additional references to
  * GstBuffer instances can potentially increase the number
  * of memcpy operations in a pipeline.
  *
  * Returns: @buf
  */
+#ifdef _FOOL_GTK_DOC_
+G_INLINE_FUNC GstBuffer * gst_buffer_ref (GstBuffer * buf);
+#endif
+
 static inline GstBuffer *
 gst_buffer_ref (GstBuffer * buf)
 {

diff --git a/gst/gstevent.h b/gst/gstevent.h
index 15dbc464de29e7b98bbcbe2cfadbe0a4a705ad7b..439a3d6e5e0381b70e066409a95733260454dc28 100644 (file)
--- a/gst/gstevent.h
+++ b/gst/gstevent.h
@@ -326,6 +326,10 @@ GType              gst_event_get_type              (void);
  *
  * Increase the refcount of this event.
  */
+#ifdef _FOOL_GTK_DOC_
+G_INLINE_FUNC GstEvent * gst_event_ref (GstEvent * ev);
+#endif
+
 static inline GstEvent *
 gst_event_ref (GstEvent * ev)
 {

diff --git a/gst/gstmessage.h b/gst/gstmessage.h
index e2653cf9971e96b75a087e9d6ac8c3d288de444b..5e20a3d8a82d5cc9377e49491fa6fb1a8c416947 100644 (file)
--- a/gst/gstmessage.h
+++ b/gst/gstmessage.h
@@ -199,6 +199,10 @@ GQuark             gst_message_type_to_quark       (GstMessageType type);
  * Convenience macro to increase the reference count of the message. Returns the
  * reffed message.
  */
+#ifdef _FOOL_GTK_DOC_
+G_INLINE_FUNC GstMessage * gst_message_ref (GstMessage * msg);
+#endif
+
 static inline GstMessage *
 gst_message_ref (GstMessage * msg)
 {