gst/gstmessage.*: doc fixes

Original commit message from CVS:
* gst/gstmessage.c:
* gst/gstmessage.h:
doc fixes
This commit is contained in:
Stefan Kost 2005-08-26 22:32:51 +00:00
parent 90b2a570bb
commit 6aa69df224
3 changed files with 23 additions and 0 deletions

View file

@ -1,3 +1,9 @@
2005-08-27 Stefan Kost <ensonic@users.sf.net>
* gst/gstmessage.c:
* gst/gstmessage.h:
doc fixes
2005-08-27 Stefan Kost <ensonic@users.sf.net>
* gst/base/gstbasetransform.c: (gst_base_transform_transform_size):

View file

@ -175,6 +175,7 @@ gst_message_new (GstMessageType type, GstObject * src)
/**
* gst_message_new_eos:
* @src: The object originating the message.
*
* Create a new eos message. This message is generated and posted in
* the sink elements of a GstBin. The bin will only forward the EOS
@ -371,6 +372,7 @@ gst_message_new_segment_done (GstObject * src, GstClockTime timestamp)
/**
* gst_message_new_custom:
* @type: The #GstMessageType to distinguish messages
* @src: The object originating the message.
* @structure: The structure for the message. The message will take ownership of
* the structure.

View file

@ -145,6 +145,21 @@ GstMessage * gst_message_new_segment_done (GstObject * src, GstClockTime timest
GstMessage * gst_message_new_custom (GstMessageType type,
GstObject * src,
GstStructure * structure);
/**
* gst_message_new_application:
* @src: The object originating the message.
* @str: The structure for the message. The message will take ownership of
* the structure.
*
* Create a new application-typed message. This can be used for anything not
* handled by other message-specific functions to pass a message to the
* app. The structure field can be NULL.
*
* Returns: The new message.
*
* MT safe.
*/
#define gst_message_new_application(src, str) \
gst_message_new_custom (GST_MESSAGE_APPLICATION, src, str)