From f2cee8294952207bc9bddb4b5ba390b865b768f5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tim-Philipp=20M=C3=BCller?= Date: Wed, 10 May 2006 16:44:15 +0000 Subject: [PATCH] gst/: Make gtk-doc generate docs for our inlined gst_buffer_ref(), gst_event_ref() and gst_message_ref() functions ag... 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). --- ChangeLog | 10 ++++++++++ gst/gstbuffer.h | 7 ++++++- gst/gstevent.h | 4 ++++ gst/gstmessage.h | 4 ++++ 4 files changed, 24 insertions(+), 1 deletion(-) diff --git a/ChangeLog b/ChangeLog index 1a4db4cc66..88fe4f9053 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,13 @@ +2006-05-10 Tim-Philipp Müller + + * 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 * libs/gst/check/gstcheck.h: diff --git a/gst/gstbuffer.h b/gst/gstbuffer.h index 77ffd5d340..70f8cd2cbe 100644 --- 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 15dbc464de..439a3d6e5e 100644 --- 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 e2653cf997..5e20a3d8a8 100644 --- 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) {