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).
This commit is contained in:
Tim-Philipp Müller 2006-05-10 16:44:15 +00:00
parent 7ebd6a126d
commit f2cee82949
4 changed files with 24 additions and 1 deletions

View file

@ -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> 2006-05-10 Thomas Vander Stichele <thomas at apestaart dot org>
* libs/gst/check/gstcheck.h: * libs/gst/check/gstcheck.h:

View file

@ -288,13 +288,18 @@ G_STMT_START { \
* Increases the refcount of the given buffer by one. * Increases the refcount of the given buffer by one.
* *
* Note that the refcount affects the writeability * 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 * important to note that keeping additional references to
* GstBuffer instances can potentially increase the number * GstBuffer instances can potentially increase the number
* of memcpy operations in a pipeline. * of memcpy operations in a pipeline.
* *
* Returns: @buf * Returns: @buf
*/ */
#ifdef _FOOL_GTK_DOC_
G_INLINE_FUNC GstBuffer * gst_buffer_ref (GstBuffer * buf);
#endif
static inline GstBuffer * static inline GstBuffer *
gst_buffer_ref (GstBuffer * buf) gst_buffer_ref (GstBuffer * buf)
{ {

View file

@ -326,6 +326,10 @@ GType gst_event_get_type (void);
* *
* Increase the refcount of this event. * Increase the refcount of this event.
*/ */
#ifdef _FOOL_GTK_DOC_
G_INLINE_FUNC GstEvent * gst_event_ref (GstEvent * ev);
#endif
static inline GstEvent * static inline GstEvent *
gst_event_ref (GstEvent * ev) gst_event_ref (GstEvent * ev)
{ {

View file

@ -199,6 +199,10 @@ GQuark gst_message_type_to_quark (GstMessageType type);
* Convenience macro to increase the reference count of the message. Returns the * Convenience macro to increase the reference count of the message. Returns the
* reffed message. * reffed message.
*/ */
#ifdef _FOOL_GTK_DOC_
G_INLINE_FUNC GstMessage * gst_message_ref (GstMessage * msg);
#endif
static inline GstMessage * static inline GstMessage *
gst_message_ref (GstMessage * msg) gst_message_ref (GstMessage * msg)
{ {