diff options
| author | Evan Nemerson <evan@nemerson.com> | 2014-05-29 14:54:34 -0700 |
|---|---|---|
| committer | Tim-Philipp Müller <tim@centricular.com> | 2014-05-30 00:20:27 +0100 |
| commit | e10266e3f3cf9b05b69198b1ac6faa9a62840e30 (patch) | |
| tree | 997e3fd18b7445cbc561cac1b11219df7e62e0f9 /gst | |
| parent | 88191aa8800da205db510313638ae1be31a59667 (diff) | |
docs: convert NULL, TRUE, and FALSE to %NULL, %TRUE, and %FALSE
This should help improve documentation generated for
languages other than C.
https://bugzilla.gnome.org/show_bug.cgi?id=730961
Diffstat (limited to 'gst')
67 files changed, 599 insertions, 602 deletions
@@ -53,7 +53,7 @@ * </programlisting> * </example> * - * It's allowed to pass two NULL pointers to gst_init() in case you don't want + * It's allowed to pass two %NULL pointers to gst_init() in case you don't want * to pass the command line args to GStreamer. * * You can also use GOption to initialize your own parameters as shown in @@ -400,7 +400,7 @@ gst_init (int *argc, char **argv[]) * Use this function to check if GStreamer has been initialized with gst_init() * or gst_init_check(). * - * Returns: TRUE if initialization has been done, FALSE otherwise. + * Returns: %TRUE if initialization has been done, %FALSE otherwise. */ gboolean gst_is_initialized (void) @@ -693,7 +693,7 @@ init_post (GOptionContext * context, GOptionGroup * group, gpointer data, * gstreamer as being initialized, since it is the case from a plugin point of * view. * - * If anything fails, it will be put back to FALSE in gst_init_check(). + * If anything fails, it will be put back to %FALSE in gst_init_check(). * This allows some special plugins that would call gst_init() to not cause a * looping effect (i.e. initializing GStreamer twice). */ diff --git a/gst/gstallocator.c b/gst/gstallocator.c index a61f2f8b7..6363ba547 100644 --- a/gst/gstallocator.c +++ b/gst/gstallocator.c @@ -25,7 +25,7 @@ * @see_also: #GstMemory * * Memory is usually created by allocators with a gst_allocator_alloc() - * method call. When NULL is used as the allocator, the default allocator will + * method call. When %NULL is used as the allocator, the default allocator will * be used. * * New allocators can be registered with gst_allocator_register(). @@ -218,10 +218,10 @@ gst_allocator_register (const gchar * name, GstAllocator * allocator) * gst_allocator_find: * @name: (allow-none): the name of the allocator * - * Find a previously registered allocator with @name. When @name is NULL, the + * Find a previously registered allocator with @name. When @name is %NULL, the * default allocator will be returned. * - * Returns: (transfer full): a #GstAllocator or NULL when the allocator with @name was not + * Returns: (transfer full): a #GstAllocator or %NULL when the allocator with @name was not * registered. Use gst_object_unref() to release the allocator after usage. */ GstAllocator * @@ -274,13 +274,13 @@ gst_allocator_set_default (GstAllocator * allocator) * @size big. * * The optional @params can specify the prefix and padding for the memory. If - * NULL is passed, no flags, no extra prefix/padding and a default alignment is + * %NULL is passed, no flags, no extra prefix/padding and a default alignment is * used. * * The prefix/padding will be filled with 0 if flags contains * #GST_MEMORY_FLAG_ZERO_PREFIXED and #GST_MEMORY_FLAG_ZERO_PADDED respectively. * - * When @allocator is NULL, the default allocator will be used. + * When @allocator is %NULL, the default allocator will be used. * * The alignment in @params is given as a bitmask so that @align + 1 equals * the amount of bytes to align to. For example, to align to 8 bytes, diff --git a/gst/gstatomicqueue.c b/gst/gstatomicqueue.c index 89bbb33b0..72ad2e378 100644 --- a/gst/gstatomicqueue.c +++ b/gst/gstatomicqueue.c @@ -214,7 +214,7 @@ gst_atomic_queue_unref (GstAtomicQueue * queue) * * Peek the head element of the queue without removing it from the queue. * - * Returns: (transfer none): the head element of @queue or NULL when + * Returns: (transfer none): the head element of @queue or %NULL when * the queue is empty. */ gpointer @@ -264,7 +264,7 @@ gst_atomic_queue_peek (GstAtomicQueue * queue) * * Get the head element of the queue. * - * Returns: (transfer full): the head element of @queue or NULL when + * Returns: (transfer full): the head element of @queue or %NULL when * the queue is empty. */ gpointer diff --git a/gst/gstbin.c b/gst/gstbin.c index d54d35e06..77bbc3e85 100644 --- a/gst/gstbin.c +++ b/gst/gstbin.c @@ -148,8 +148,8 @@ * </variablelist> * * A #GstBin will by default forward any event sent to it to all sink elements. - * If all the sinks return TRUE, the bin will also return TRUE, else FALSE is - * returned. If no sinks are in the bin, the event handler will return TRUE. + * If all the sinks return %TRUE, the bin will also return %TRUE, else %FALSE is + * returned. If no sinks are in the bin, the event handler will return %TRUE. * * </para> * </refsect2> @@ -370,7 +370,7 @@ gst_bin_class_init (GstBinClass * klass) /** * GstBin:async-handling: * - * If set to #TRUE, the bin will handle asynchronous state changes. + * If set to %TRUE, the bin will handle asynchronous state changes. * This should be used only if the bin subclass is modifying the state * of its children on its own. */ @@ -1279,7 +1279,7 @@ had_parent: * * MT safe. * - * Returns: TRUE if the element could be added, FALSE if + * Returns: %TRUE if the element could be added, %FALSE if * the bin does not want to accept the element. */ gboolean @@ -1592,7 +1592,7 @@ not_in_bin: * * MT safe. * - * Returns: TRUE if the element could be removed, FALSE if + * Returns: %TRUE if the element could be removed, %FALSE if * the bin does not want to remove the element. */ gboolean @@ -1633,7 +1633,7 @@ no_function: * * MT safe. Caller owns returned value. * - * Returns: (transfer full): a #GstIterator of #GstElement, or NULL + * Returns: (transfer full): a #GstIterator of #GstElement, or %NULL */ GstIterator * gst_bin_iterate_elements (GstBin * bin) @@ -1673,7 +1673,7 @@ iterate_child_recurse (GstIterator * it, const GValue * item) * * MT safe. Caller owns returned value. * - * Returns: (transfer full): a #GstIterator of #GstElement, or NULL + * Returns: (transfer full): a #GstIterator of #GstElement, or %NULL */ GstIterator * gst_bin_iterate_recurse (GstBin * bin) @@ -1730,7 +1730,7 @@ sink_iterator_filter (const GValue * vchild, GValue * vbin) * * MT safe. Caller owns returned value. * - * Returns: (transfer full): a #GstIterator of #GstElement, or NULL + * Returns: (transfer full): a #GstIterator of #GstElement, or %NULL */ GstIterator * gst_bin_iterate_sinks (GstBin * bin) @@ -1790,7 +1790,7 @@ src_iterator_filter (const GValue * vchild, GValue * vbin) * * MT safe. Caller owns returned value. * - * Returns: (transfer full): a #GstIterator of #GstElement, or NULL + * Returns: (transfer full): a #GstIterator of #GstElement, or %NULL */ GstIterator * gst_bin_iterate_sources (GstBin * bin) @@ -2166,7 +2166,7 @@ gst_bin_sort_iterator_new (GstBin * bin) * * MT safe. Caller owns returned value. * - * Returns: (transfer full): a #GstIterator of #GstElement, or NULL + * Returns: (transfer full): a #GstIterator of #GstElement, or %NULL */ GstIterator * gst_bin_iterate_sorted (GstBin * bin) @@ -4122,11 +4122,11 @@ compare_name (const GValue * velement, const gchar * name) * Gets the element with the given name from a bin. This * function recurses into child bins. * - * Returns NULL if no element with the given name is found in the bin. + * Returns %NULL if no element with the given name is found in the bin. * * MT safe. Caller owns returned reference. * - * Returns: (transfer full): the #GstElement with the given name, or NULL + * Returns: (transfer full): the #GstElement with the given name, or %NULL */ GstElement * gst_bin_get_by_name (GstBin * bin, const gchar * name) @@ -4164,12 +4164,12 @@ gst_bin_get_by_name (GstBin * bin, const gchar * name) * Gets the element with the given name from this bin. If the * element is not found, a recursion is performed on the parent bin. * - * Returns NULL if: + * Returns %NULL if: * - no element with the given name is found in the bin * * MT safe. Caller owns returned reference. * - * Returns: (transfer full): the #GstElement with the given name, or NULL + * Returns: (transfer full): the #GstElement with the given name, or %NULL */ GstElement * gst_bin_get_by_name_recurse_up (GstBin * bin, const gchar * name) @@ -4270,7 +4270,7 @@ gst_bin_get_by_interface (GstBin * bin, GType iface) * MT safe. Caller owns returned value. * * Returns: (transfer full): a #GstIterator of #GstElement for all elements - * in the bin implementing the given interface, or NULL + * in the bin implementing the given interface, or %NULL */ GstIterator * gst_bin_iterate_all_by_interface (GstBin * bin, GType iface) diff --git a/gst/gstbuffer.c b/gst/gstbuffer.c index a70e29fee..8aef1c206 100644 --- a/gst/gstbuffer.c +++ b/gst/gstbuffer.c @@ -635,22 +635,22 @@ gst_buffer_new (void) /** * gst_buffer_new_allocate: - * @allocator: (transfer none) (allow-none): the #GstAllocator to use, or NULL to use the + * @allocator: (transfer none) (allow-none): the #GstAllocator to use, or %NULL to use the * default allocator * @size: the size in bytes of the new buffer's data. * @params: (transfer none) (allow-none): optional parameters * * Tries to create a newly allocated buffer with data of the given size and * extra parameters from @allocator. If the requested amount of memory can't be - * allocated, NULL will be returned. The allocated buffer memory is not cleared. + * allocated, %NULL will be returned. The allocated buffer memory is not cleared. * - * When @allocator is NULL, the default memory allocator will be used. + * When @allocator is %NULL, the default memory allocator will be used. * * Note that when @size == 0, the buffer will not have memory associated with it. * * MT safe. * - * Returns: (transfer full): a new #GstBuffer, or NULL if the memory couldn't + * Returns: (transfer full): a new #GstBuffer, or %NULL if the memory couldn't * be allocated. */ GstBuffer * @@ -1842,7 +1842,7 @@ gst_buffer_memset (GstBuffer * buffer, gsize offset, guint8 val, gsize size) * * MT safe. * - * Returns: (transfer full): the new #GstBuffer or NULL if the arguments were + * Returns: (transfer full): the new #GstBuffer or %NULL if the arguments were * invalid. */ GstBuffer * @@ -1932,7 +1932,7 @@ gst_buffer_append_region (GstBuffer * buf1, GstBuffer * buf2, gssize offset, * @api: the #GType of an API * * Get the metadata for @api on buffer. When there is no such - * metadata, NULL is returned. + * metadata, %NULL is returned. * * Returns: (transfer none): the metadata for @api on @buffer. */ diff --git a/gst/gstbuffer.h b/gst/gstbuffer.h index 713c886e0..0ebf1428b 100644 --- a/gst/gstbuffer.h +++ b/gst/gstbuffer.h @@ -467,9 +467,9 @@ gboolean gst_buffer_copy_into (GstBuffer *dest, GstBuffer *src * in some cases), and the reference counts are updated appropriately (the old * buffer is unreffed, the new is reffed). * - * Either @nbuf or the #GstBuffer pointed to by @obuf may be NULL. + * Either @nbuf or the #GstBuffer pointed to by @obuf may be %NULL. * - * Returns: TRUE when @obuf was different from @nbuf. + * Returns: %TRUE when @obuf was different from @nbuf. */ #ifdef _FOOL_GTK_DOC_ G_INLINE_FUNC gboolean gst_buffer_replace (GstBuffer **obuf, GstBuffer *nbuf); @@ -507,7 +507,7 @@ GstBuffer* gst_buffer_append (GstBuffer *buf1, GstBuffer *buf * When this function returns %TRUE, the next meta will be * returned. When %FALSE is returned, gst_buffer_foreach_meta() will return. * - * When @meta is set to NULL, the item will be removed from the buffer. + * When @meta is set to %NULL, the item will be removed from the buffer. * * Returns: %FALSE when gst_buffer_foreach_meta() should stop */ diff --git a/gst/gstbufferlist.c b/gst/gstbufferlist.c index 8de87eaa1..5f743a1e6 100644 --- a/gst/gstbufferlist.c +++ b/gst/gstbufferlist.c @@ -227,7 +227,7 @@ gst_buffer_list_foreach (GstBufferList * list, GstBufferListFunc func, * * Get the buffer at @idx. * - * Returns: (transfer none): the buffer at @idx in @group or NULL when there + * Returns: (transfer none): the buffer at @idx in @group or %NULL when there * is no buffer. The buffer remains valid as long as @list is valid. */ GstBuffer * diff --git a/gst/gstbufferlist.h b/gst/gstbufferlist.h index e88d4b80b..df8c455e7 100644 --- a/gst/gstbufferlist.h +++ b/gst/gstbufferlist.h @@ -48,7 +48,7 @@ typedef struct _GstBufferList GstBufferList; * When this function returns %TRUE, the next buffer will be * returned. When %FALSE is returned, gst_buffer_list_foreach() will return. * - * When @buffer is set to NULL, the item will be removed from the bufferlist. + * When @buffer is set to %NULL, the item will be removed from the bufferlist. * When @buffer has been made writable, the new buffer reference can be assigned * to @buffer. This function is responsible for unreffing the old buffer when * removing or modifying. diff --git a/gst/gstbufferpool.c b/gst/gstbufferpool.c index 88768be36..6c14ce41c 100644 --- a/gst/gstbufferpool.c +++ b/gst/gstbufferpool.c @@ -608,7 +608,7 @@ wrong_config: * the configuration haven't change, this function will return %TRUE. If the * pool is active, this function will try deactivating it. Buffers allocated * form this pool must be returned or else this function will do nothing and - * return FALSE. + * return %FALSE. * * @config is a #GstStructure that contains the configuration parameters for * the pool. A default and mandatory set of parameters can be configured with diff --git a/gst/gstbus.c b/gst/gstbus.c index 1047fc23e..69cf6b982 100644 --- a/gst/gstbus.c +++ b/gst/gstbus.c @@ -291,7 +291,7 @@ gst_bus_new (void) * Post a message on the given bus. Ownership of the message * is taken by the bus. * - * Returns: TRUE if the message could be posted, FALSE if the bus is flushing. + * Returns: %TRUE if the message could be posted, %FALSE if the bus is flushing. * * MT safe. */ @@ -402,7 +402,7 @@ is_flushing: * Check if there are pending messages on the bus that * should be handled. * - * Returns: TRUE if there are messages on the bus to be handled, FALSE + * Returns: %TRUE if there are messages on the bus to be handled, %FALSE * otherwise. * * MT safe. @@ -427,7 +427,7 @@ gst_bus_have_pending (GstBus * bus) * * If @flushing, flush out and unref any messages queued in the bus. Releases * references to the message origin objects. Will flush future messages until - * gst_bus_set_flushing() sets @flushing to #FALSE. + * gst_bus_set_flushing() sets @flushing to %FALSE. * * MT safe. */ @@ -468,7 +468,7 @@ gst_bus_set_flushing (GstBus * bus, gboolean flushing) * matching message was posted on the bus. * * Returns: (transfer full): a #GstMessage matching the filter in @types, - * or NULL if no matching message was found on the bus until the timeout + * or %NULL if no matching message was found on the bus until the timeout * expired. The message is taken from the bus and needs to be unreffed * with gst_message_unref() after usage. * @@ -569,7 +569,7 @@ beach: * posted on the bus. * * Returns: (transfer full): the #GstMessage that is on the bus after the - * specified timeout or NULL if the bus is empty after the timeout expired. + * specified timeout or %NULL if the bus is empty after the timeout expired. * The message is taken from the bus and needs to be unreffed with * gst_message_unref() after usage. * @@ -595,7 +595,7 @@ gst_bus_timed_pop (GstBus * bus, GstClockTime timeout) * enums beyond #GST_MESSAGE_EXTENDED in the @events mask. * * Returns: (transfer full): the next #GstMessage matching @type that is on - * the bus, or NULL if the bus is empty or there is no message matching + * the bus, or %NULL if the bus is empty or there is no message matching * @type. The message is taken from the bus and needs to be unreffed with * gst_message_unref() after usage. * @@ -616,7 +616,7 @@ gst_bus_pop_filtered (GstBus * bus, GstMessageType types) * * Get a message from the bus. * - * Returns: (transfer full): the #GstMessage that is on the bus, or NULL if the + * Returns: (transfer full): the #GstMessage that is on the bus, or %NULL if the * bus is empty. The message is taken from the bus and needs to be unreffed * with gst_message_unref() after usage. * @@ -638,7 +638,7 @@ gst_bus_pop (GstBus * bus) * on the bus' message queue. A reference is returned, and needs to be unreffed * by the caller. * - * Returns: (transfer full): the #GstMessage that is on the bus, or NULL if the + * Returns: (transfer full): the #GstMessage that is on the bus, or %NULL if the * bus is empty. * * MT safe. @@ -675,7 +675,7 @@ gst_bus_peek (GstBus * bus) * should handle messages asynchronously using the gst_bus watch and poll * functions. * - * You cannot replace an existing sync_handler. You can pass NULL to this + * You cannot replace an existing sync_handler. You can pass %NULL to this * function, which will clear the existing handler. */ void @@ -896,7 +896,7 @@ gst_bus_add_watch_full_unlocked (GstBus * bus, gint priority, * When @func is called, the message belongs to the caller; if you want to * keep a copy of it, call gst_message_ref() before leaving @func. * - * The watch can be removed using g_source_remove() or by returning FALSE + * The watch can be removed using g_source_remove() or by returning %FALSE * from @func. * * MT safe. @@ -935,7 +935,7 @@ gst_bus_add_watch_full (GstBus * bus, gint priority, * There can only be a single bus watch per bus, you must remove it before you * can set a new one. * - * The watch can be removed using g_source_remove() or by returning FALSE + * The watch can be removed using g_source_remove() or by returning %FALSE * from @func. * * Returns: The event source id. @@ -1054,7 +1054,7 @@ poll_destroy_timeout (GstBusPollData * poll_data) * better handled by setting up an asynchronous bus watch and doing things * from there. * - * Returns: (transfer full): the message that was received, or NULL if the + * Returns: (transfer full): the message that was received, or %NULL if the * poll timed out. The message is taken from the bus and needs to be * unreffed with gst_message_unref() after usage. */ @@ -1113,7 +1113,7 @@ gst_bus_poll (GstBus * bus, GstMessageType events, GstClockTime timeout) * A helper #GstBusFunc that can be used to convert all asynchronous messages * into signals. * - * Returns: TRUE + * Returns: %TRUE */ gboolean gst_bus_async_signal_func (GstBus * bus, GstMessage * message, gpointer data) diff --git a/gst/gstbus.h b/gst/gstbus.h index 582177080..92d216015 100644 --- a/gst/gstbus.h +++ b/gst/gstbus.h @@ -99,7 +99,7 @@ typedef GstBusSyncReply (*GstBusSyncHandler) (GstBus * bus, GstMessage * mess * function so it should not be freed in the function. * * Note that this function is used as a GSourceFunc which means that returning - * FALSE will remove the GSource from the mainloop. + * %FALSE will remove the GSource from the mainloop. * * Returns: %FALSE if the event source should be removed. */ diff --git a/gst/gstcaps.c b/gst/gstcaps.c index b729b7973..ea0718cbb 100644 --- a/gst/gstcaps.c +++ b/gst/gstcaps.c @@ -327,7 +327,7 @@ gst_caps_new_simple (const char *media_type, const char *fieldname, ...) * @...: additional structures to add * * Creates a new #GstCaps and adds all the structures listed as - * arguments. The list must be NULL-terminated. The structures + * arguments. The list must be %NULL-terminated. The structures * are not copied; the returned #GstCaps owns the structures. * * Returns: (transfer full): the new #GstCaps @@ -351,7 +351,7 @@ gst_caps_new_full (GstStructure * struct1, ...) * @var_args: additional structures to add * * Creates a new #GstCaps and adds all the structures listed as - * arguments. The list must be NULL-terminated. The structures + * arguments. The list must be %NULL-terminated. The structures * are not copied; the returned #GstCaps owns the structures. * * Returns: (transfer full): the new #GstCaps @@ -999,7 +999,7 @@ gst_caps_set_value (GstCaps * caps, const char *field, const GValue * value) * @varargs: additional parameters * * Sets fields in a #GstCaps. The arguments must be passed in the same - * manner as gst_structure_set(), and be NULL-terminated. + * manner as gst_structure_set(), and be %NULL-terminated. */ void gst_caps_set_simple_valist (GstCaps * caps, const char *field, va_list varargs) @@ -1036,7 +1036,7 @@ gst_caps_set_simple_valist (GstCaps * caps, const char *field, va_list varargs) * @...: additional parameters * * Sets fields in a #GstCaps. The arguments must be passed in the same - * manner as gst_structure_set(), and be NULL-terminated. + * manner as gst_structure_set(), and be %NULL-terminated. */ void gst_caps_set_simple (GstCaps * caps, const char *field, ...) @@ -1059,7 +1059,7 @@ gst_caps_set_simple (GstCaps * caps, const char *field, ...) * * Determines if @caps represents any media format. * - * Returns: TRUE if @caps represents any format. + * Returns: %TRUE if @caps represents any format. */ gboolean gst_caps_is_any (const GstCaps * caps) @@ -1075,7 +1075,7 @@ gst_caps_is_any (const GstCaps * caps) * * Determines if @caps represents no media formats. * - * Returns: TRUE if @caps represents no formats. + * Returns: %TRUE if @caps represents no formats. */ gboolean gst_caps_is_empty (const GstCaps * caps) @@ -1103,7 +1103,7 @@ gst_caps_is_fixed_foreach (GQuark field_id, const GValue * value, * one structure, and each field in the structure describes a fixed type. * Examples of non-fixed types are GST_TYPE_INT_RANGE and GST_TYPE_LIST. * - * Returns: TRUE if @caps is fixed + * Returns: %TRUE if @caps is fixed */ gboolean gst_caps_is_fixed (const GstCaps * caps) @@ -1133,7 +1133,7 @@ gst_caps_is_fixed (const GstCaps * caps) * Tests if two #GstCaps are equal. This function only works on fixed * #GstCaps. * - * Returns: TRUE if the arguments represent the same format + * Returns: %TRUE if the arguments represent the same format */ gboolean gst_caps_is_equal_fixed (const GstCaps * caps1, const GstCaps * caps2) @@ -1166,7 +1166,7 @@ gst_caps_is_equal_fixed (const GstCaps * caps1, const GstCaps * caps2) * every media format that is in the first is also contained in the * second. That is, @caps1 is a subset of @caps2. * - * Returns: TRUE if @caps1 is a subset of @caps2. + * Returns: %TRUE if @caps1 is a subset of @caps2. */ gboolean gst_caps_is_always_compatible (const GstCaps * caps1, const GstCaps * caps2) @@ -1322,7 +1322,7 @@ gst_caps_is_subset_structure_full (const GstCaps * caps, * * Checks if the given caps represent the same set of caps. * - * Returns: TRUE if both caps are equal. + * Returns: %TRUE if both caps are equal. */ gboolean gst_caps_is_equal (const GstCaps * caps1, const GstCaps * caps2) @@ -1346,7 +1346,7 @@ gst_caps_is_equal (const GstCaps * caps1, const GstCaps * caps2) * * Checks if the given caps are exactly the same set of caps. * - * Returns: TRUE if both caps are strictly equal. + * Returns: %TRUE if both caps are strictly equal. */ gboolean gst_caps_is_strictly_equal (const GstCaps * caps1, const GstCaps * caps2) diff --git a/gst/gstcaps.h b/gst/gstcaps.h index 8df249984..e29da343a 100644 --- a/gst/gstcaps.h +++ b/gst/gstcaps.h @@ -298,9 +298,9 @@ gst_caps_copy (const GstCaps * caps) * in some cases), and the reference counts are updated appropriately (the old * caps is unreffed, the new is reffed). * - * Either @ncaps or the #GstCaps pointed to by @ocaps may be NULL. + * Either @ncaps or the #GstCaps pointed to by @ocaps may be %NULL. * - * Returns: TRUE if @new_caps was different from @old_caps + * Returns: %TRUE if @new_caps was different from @old_caps */ #ifdef _FOOL_GTK_DOC_ G_INLINE_FUNC gboolean gst_caps_replace (GstCaps **old_caps, GstCaps *new_caps); @@ -323,7 +323,7 @@ gst_caps_replace (GstCaps **old_caps, GstCaps *new_caps) * function is similar to gst_caps_replace() except that it takes ownership * of @new_caps. * - * Returns: TRUE if @new_caps was different from @old_caps + * Returns: %TRUE if @new_caps was different from @old_caps */ #ifdef _FOOL_GTK_DOC_ G_INLINE_FUNC gboolean gst_caps_take (GstCaps **old_caps, GstCaps *new_caps); diff --git a/gst/gstcapsfeatures.c b/gst/gstcapsfeatures.c index 38fcef747..e1e8f907e 100644 --- a/gst/gstcapsfeatures.c +++ b/gst/gstcapsfeatures.c @@ -203,7 +203,7 @@ gst_caps_features_new_any (void) * @...: additional features * * Creates a new #GstCapsFeatures with the given features. - * The last argument must be NULL. + * The last argument must be %NULL. * * Free-function: gst_caps_features_free * @@ -471,7 +471,7 @@ priv_gst_caps_features_append_to_gstring (const GstCapsFeatures * features, * * Free-function: gst_caps_features_free * - * Returns: (transfer full): a new #GstCapsFeatures or NULL when the string could + * Returns: (transfer full): a new #GstCapsFeatures or %NULL when the string could * not be parsed. Free with gst_caps_features_free() after use. * * Since: 1.2 diff --git a/gst/gstchildproxy.c b/gst/gstchildproxy.c index 1cd411646..a83356a54 100644 --- a/gst/gstchildproxy.c +++ b/gst/gstchildproxy.c @@ -174,7 +174,7 @@ gst_child_proxy_get_children_count (GstChildProxy * parent) * * MT safe. * - * Returns: TRUE if @target and @pspec could be found. FALSE otherwise. In that + * Returns: %TRUE if @target and @pspec could be found. %FALSE otherwise. In that * case the values for @pspec and @target are not modified. Unref @target after * usage. For plain GObjects @target is the same as @object. */ @@ -274,7 +274,7 @@ not_found: * gst_child_proxy_get_valist: * @object: the object to query * @first_property_name: name of the first property to get - * @var_args: return location for the first property, followed optionally by more name/return location pairs, followed by NULL + * @var_args: return location for the first property, followed optionally by more name/return location pairs, followed by %NULL * * Gets properties of the parent object and its children. */ @@ -328,7 +328,7 @@ cant_copy: * gst_child_proxy_get: * @object: the parent object * @first_property_name: name of the first property to get - * @...: return location for the first property, followed optionally by more name/return location pairs, followed by NULL + * @...: return location for the first property, followed optionally by more name/return location pairs, followed by %NULL * * Gets properties of the parent object and its children. */ @@ -383,7 +383,7 @@ not_found: * gst_child_proxy_set_valist: * @object: the parent object * @first_property_name: name of the first property to set - * @var_args: value for the first property, followed optionally by more name/value pairs, followed by NULL + * @var_args: value for the first property, followed optionally by more name/value pairs, followed by %NULL * * Sets properties of the parent object and its children. */ @@ -440,7 +440,7 @@ cant_copy: * gst_child_proxy_set: * @object: the parent object * @first_property_name: name of the first property to set - * @...: value for the first property, followed optionally by more name/value pairs, followed by NULL + * @...: value for the first property, followed optionally by more name/value pairs, followed by %NULL * * Sets properties of the parent object and its children. */ diff --git a/gst/gstcontext.h b/gst/gstcontext.h index 9dd091475..a0aa8705e 100644 --- a/gst/gstcontext.h +++ b/gst/gstcontext.h @@ -130,9 +130,9 @@ gst_context_copy (const GstContext * context) * in some cases), and the reference counts are updated appropriately (the old * context is unreffed, the new one is reffed). * - * Either @new_context or the #GstContext pointed to by @old_context may be NULL. + * Either @new_context or the #GstContext pointed to by @old_context may be %NULL. * - * Returns: TRUE if @new_context was different from @old_context + * Returns: %TRUE if @new_context was different from @old_context */ #ifdef _FOOL_GTK_DOC_ G_INLINE_FUNC gboolean gst_context_replace (GstContext **old_context, GstContext *new_context); diff --git a/gst/gstcontrolsource.c b/gst/gstcontrolsource.c index 02926f3f7..1b280c01f 100644 --- a/gst/gstcontrolsource.c +++ b/gst/gstcontrolsource.c @@ -96,7 +96,7 @@ gst_control_source_constructor (GType type, guint n_construct_params, * * Gets the value for this #GstControlSource at a given timestamp. * - * Returns: FALSE if the value couldn't be returned, TRUE otherwise. + * Returns: %FALSE if the value couldn't be returned, %TRUE otherwise. */ gboolean gst_control_source_get_value (GstControlSource * self, GstClockTime timestamp, diff --git a/gst/gstdatetime.c b/gst/gstdatetime.c index 821af0f44..083b5daf5 100644 --- a/gst/gstdatetime.c +++ b/gst/gstdatetime.c @@ -70,7 +70,7 @@ struct _GstDateTime * * Free-function: gst_date_time_unref * - * Returns: (transfer full): a newly created #GstDateTime, or NULL on error + * Returns: (transfer full): a newly created #GstDateTime, or %NULL on error */ GstDateTime * gst_date_time_new_from_g_date_time (GDateTime * dt) @@ -95,7 +95,7 @@ gst_date_time_new_from_g_date_time (GDateTime * dt) * * Free-function: g_date_time_unref * - * Returns: (transfer full): a newly created #GDateTime, or NULL on error + * Returns: (transfer full): a newly created #GDateTime, or %NULL on error */ GDateTime * gst_date_time_to_g_date_time (GstDateTime * datetime) @@ -112,8 +112,8 @@ gst_date_time_to_g_date_time (GstDateTime * datetime) * gst_date_time_has_year: * @datetime: a #GstDateTime * - * Returns: TRUE if @datetime<!-- -->'s year field is set (which should always - * be the case), otherwise FALSE + * Returns: %TRUE if @datetime<!-- -->'s year field is set (which should always + * be the case), otherwise %FALSE */ gboolean gst_date_time_has_year (const GstDateTime * datetime) @@ -127,7 +127,7 @@ gst_date_time_has_year (const GstDateTime * datetime) * gst_date_time_has_month: * @datetime: a #GstDateTime * - * Returns: TRUE if @datetime<!-- -->'s month field is set, otherwise FALSE + * Returns: %TRUE if @datetime<!-- -->'s month field is set, otherwise %FALSE */ gboolean gst_date_time_has_month (const GstDateTime * datetime) @@ -141,7 +141,7 @@ gst_date_time_has_month (const GstDateTime * datetime) * gst_date_time_has_day: * @datetime: a #GstDateTime * - * Returns: TRUE if @datetime<!-- -->'s day field is set, otherwise FALSE + * Returns: %TRUE if @datetime<!-- -->'s day field is set, otherwise %FALSE */ gboolean gst_date_time_has_day (const GstDateTime * datetime) @@ -155,8 +155,8 @@ gst_date_time_has_day (const GstDateTime * datetime) * gst_date_time_has_time: * @datetime: a #GstDateTime * - * Returns: TRUE if @datetime<!-- -->'s hour and minute fields are set, - * otherwise FALSE + * Returns: %TRUE if @datetime<!-- -->'s hour and minute fields are set, + * otherwise %FALSE */ gboolean gst_date_time_has_time (const GstDateTime * datetime) @@ -170,7 +170,7 @@ gst_date_time_has_time (const GstDateTime * datetime) * gst_date_time_has_second: * @datetime: a #GstDateTime * - * Returns: TRUE if @datetime<!-- -->'s second field is set, otherwise FALSE + * Returns: %TRUE if @datetime<!-- -->'s second field is set, otherwise %FALSE */ gboolean gst_date_time_has_second (const GstDateTime * datetime) @@ -717,7 +717,7 @@ done: * 2012-06-23T23:30+0100, 2012-06-23T23:30:59Z, 2012-06-23T23:30:59+0100 * * Returns: a newly allocated string formatted according to ISO 8601 and - * only including the datetime fields that are valid, or NULL in case + * only including the datetime fields that are valid, or %NULL in case * there was an error. The string should be freed with g_free(). */ gchar * @@ -740,7 +740,7 @@ gst_date_time_to_iso8601_string (GstDateTime * datetime) * * Free-function: gst_date_time_unref * - * Returns: (transfer full): a newly created #GstDateTime, or NULL on error + * Returns: (transfer full): a newly created #GstDateTime, or %NULL on error */ GstDateTime * gst_date_time_new_from_iso8601_string (const gchar * string) diff --git a/gst/gstdevice.c b/gst/gstdevice.c index 269dd5338..e394aec59 100644 --- a/gst/gstdevice.c +++ b/gst/gstdevice.c @@ -160,7 +160,7 @@ gst_device_set_property (GObject * object, guint prop_id, /** * gst_device_create_element: * @device: a #GstDevice - * @name: (allow-none): name of new element, or NULL to automatically + * @name: (allow-none): name of new element, or %NULL to automatically * create a unique name. * * Returns: (transfer full): a new #GstElement configured to use this device diff --git a/gst/gstdevicemonitorfactory.c b/gst/gstdevicemonitorfactory.c index e562a35b8..182059969 100644 --- a/gst/gstdevicemonitorfactory.c +++ b/gst/gstdevicemonitorfactory.c @@ -105,7 +105,7 @@ gst_device_monitor_factory_finalize (GObject * object) * Search for an device monitor factory of the given name. Refs the returned * device monitor factory; caller is responsible for unreffing. * - * Returns: (transfer full): #GstDeviceMonitorFactory if found, NULL otherwise + * Returns: (transfer full): #GstDeviceMonitorFactory if found, %NULL otherwise * * Since: 1.4 */ @@ -151,7 +151,7 @@ gst_device_monitor_factory_cleanup (GstDeviceMonitorFactory * factory) /** * gst_device_monitor_register: - * @plugin: (allow-none): #GstPlugin to register the device monitor with, or NULL for + * @plugin: (allow-none): #GstPlugin to register the device monitor with, or %NULL for * a static device monitor. * @name: name of device monitors of this type * @rank: rank of device monitor (higher rank means more importance when autoplugging) @@ -160,7 +160,7 @@ gst_device_monitor_factory_cleanup (GstDeviceMonitorFactory * factory) * Create a new device monitorfactory capable of instantiating objects of the * @type and add the factory to @plugin. * - * Returns: TRUE, if the registering succeeded, FALSE on error + * Returns: %TRUE, if the registering succeeded, %FALSE on error * * Since: 1.4 */ @@ -244,7 +244,7 @@ detailserror: * Returns the device monitor of the type defined by the given device * monitorfactory. * - * Returns: (transfer full): the #GstDeviceMonitor or NULL if the + * Returns: (transfer full): the #GstDeviceMonitor or %NULL if the * device monitor couldn't be created * * Since: 1.4 @@ -336,7 +336,7 @@ no_device_monitor: * Returns the device monitor of the type defined by the given device * monitor factory. * - * Returns: (transfer full): a #GstDeviceMonitor or NULL if unable to + * Returns: (transfer full): a #GstDeviceMonitor or %NULL if unable to * create device monitor * * Since: 1.4 diff --git a/gst/gstelement.c b/gst/gstelement.c index a01a2908f..25870f59d 100644 --- a/gst/gstelement.c +++ b/gst/gstelement.c @@ -1641,7 +1641,7 @@ gst_element_default_query (GstElement * element, GstQuery * query) * * Please note that some queries might need a running pipeline to work. * - * Returns: TRUE if the query could be performed. + * Returns: %TRUE if the query could be performed. * * MT safe. */ @@ -1873,7 +1873,7 @@ void gst_element_message_full * * MT safe. * - * Returns: TRUE, if the element's state is locked. + * Returns: %TRUE, if the element's state is locked. */ gboolean gst_element_is_locked_state (GstElement * element) @@ -1892,14 +1892,14 @@ gst_element_is_locked_state (GstElement * element) /** * gst_element_set_locked_state: * @element: a #GstElement - * @locked_state: TRUE to lock the element's state + * @locked_state: %TRUE to lock the element's state * * Locks the state of an element, so state changes of the parent don't affect * this element anymore. * * MT safe. * - * Returns: TRUE if the state was changed, FALSE if bad parameters were given + * Returns: %TRUE if the state was changed, %FALSE if bad parameters were given * or the elements state-locking needed no change. */ gboolean @@ -1944,9 +1944,9 @@ was_ok: * @element: a #GstElement. * * Tries to change the state of the element to the same as its parent. - * If this function returns FALSE, the state of element is undefined. + * If this function returns %FALSE, the state of element is undefined. * - * Returns: TRUE, if the element's state could be synced to the parent's state. + * Returns: %TRUE, if the element's state could be synced to the parent's state. * * MT safe. */ diff --git a/gst/gstelement.h b/gst/gstelement.h index b0184ea3e..408d10ca4 100644 --- a/gst/gstelement.h +++ b/gst/gstelement.h @@ -691,7 +691,7 @@ GType gst_element_get_type (void); * * Returns a copy of the name of @elem. * Caller should g_free() the return value after usage. - * For a nameless element, this returns NULL, which you can safely g_free() + * For a nameless element, this returns %NULL, which you can safely g_free() * as well. * * Returns: (transfer full): the name of @elem. g_free() after usage. MT safe. diff --git a/gst/gstelementfactory.c b/gst/gstelementfactory.c index a69035514..aa0c5afcd 100644 --- a/gst/gstelementfactory.c +++ b/gst/gstelementfactory.c @@ -123,7 +123,7 @@ gst_element_factory_finalize (GObject * object) * Search for an element factory of the given name. Refs the returned * element factory; caller is responsible for unreffing. * - * Returns: (transfer full): #GstElementFactory if found, NULL otherwise + * Returns: (transfer full): #GstElementFactory if found, %NULL otherwise */ GstElementFactory * gst_element_factory_find (const gchar * name) @@ -186,7 +186,7 @@ gst_element_factory_cleanup (GstElementFactory * factory) /** * gst_element_register: - * @plugin: (allow-none): #GstPlugin to register the element with, or NULL for + * @plugin: (allow-none): #GstPlugin to register the element with, or %NULL for * a static element. * @name: name of elements of this type * @rank: rank of element (higher rank means more importance when autoplugging) @@ -195,7 +195,7 @@ gst_element_factory_cleanup (GstElementFactory * factory) * Create a new elementfactory capable of instantiating objects of the * @type and add the factory to @plugin. * - * Returns: TRUE, if the registering succeeded, FALSE on error + * Returns: %TRUE, if the registering succeeded, %FALSE on error */ gboolean gst_element_register (GstPlugin * plugin, const gchar * name, guint rank, @@ -328,14 +328,14 @@ detailserror: /** * gst_element_factory_create: * @factory: factory to instantiate - * @name: (allow-none): name of new element, or NULL to automatically create + * @name: (allow-none): name of new element, or %NULL to automatically create * a unique name * * Create a new element of the type defined by the given elementfactory. * It will be given the name supplied, since all elements require a name as * their first argument. * - * Returns: (transfer floating): new #GstElement or NULL if the element couldn't + * Returns: (transfer floating): new #GstElement or %NULL if the element couldn't * be created */ GstElement * @@ -414,15 +414,15 @@ no_element: /** * gst_element_factory_make: * @factoryname: a named factory to instantiate - * @name: (allow-none): name of new element, or NULL to automatically create + * @name: (allow-none): name of new element, or %NULL to automatically create * a unique name * * Create a new element of the type defined by the given element factory. - * If name is NULL, then the element will receive a guaranteed unique name, + * If name is %NULL, then the element will receive a guaranteed unique name, * consisting of the element factory name and a number. * If name is given, it will be given the name supplied. * - * Returns: (transfer floating): new #GstElement or NULL if unable to create element + * Returns: (transfer floating): new #GstElement or %NULL if unable to create element */ GstElement * gst_element_factory_make (const gchar * factoryname, const gchar * name) @@ -619,13 +619,13 @@ gst_element_factory_get_uri_type (GstElementFactory * factory) * gst_element_factory_get_uri_protocols: * @factory: a #GstElementFactory * - * Gets a NULL-terminated array of protocols this element supports or NULL if + * Gets a %NULL-terminated array of protocols this element supports or %NULL if * no protocols are supported. You may not change the contents of the returned * array, as it is still owned by the element factory. Use g_strdupv() to * make a copy of the protocol string array if you need to. * * Returns: (transfer none) (array zero-terminated=1): the supported protocols - * or NULL + * or %NULL */ const gchar *const * gst_element_factory_get_uri_protocols (GstElementFactory * factory) @@ -642,7 +642,7 @@ gst_element_factory_get_uri_protocols (GstElementFactory * factory) * * Check if @factory implements the interface with name @interfacename. * - * Returns: #TRUE when @factory implement the interface. + * Returns: %TRUE when @factory implement the interface. */ gboolean gst_element_factory_has_interface (GstElementFactory * factory, diff --git a/gst/gsterror.c b/gst/gsterror.c index 0618ef268..0cf5285da 100644 --- a/gst/gsterror.c +++ b/gst/gsterror.c @@ -80,7 +80,7 @@ * currently provided should be enough. If you find your type of error * does not fit the current codes, you should use FAILED.</para></listitem> * <listitem><para>Don't provide a message if the default one suffices. - * this keeps messages more uniform. Use (NULL) - not forgetting the + * this keeps messages more uniform. Use (%NULL) - not forgetting the * parentheses.</para></listitem> * <listitem><para>If you do supply a custom message, it should be * marked for translation. The message should start with a capital @@ -89,7 +89,7 @@ * A user interface will present this message as the first thing a user * sees. Details, technical info, ... should go in the debug string. * </para></listitem> - * <listitem><para>The debug string can be as you like. Again, use (NULL) + * <listitem><para>The debug string can be as you like. Again, use (%NULL) * if there's nothing to add - file and line number will still be * passed. #GST_ERROR_SYSTEM can be used as a shortcut to give * debug information on a system call error.</para></listitem> diff --git a/gst/gstevent.c b/gst/gstevent.c index da43f7409..386a1eb8d 100644 --- a/gst/gstevent.c +++ b/gst/gstevent.c @@ -351,7 +351,7 @@ gst_event_get_structure (GstEvent * event) * Returns: The structure of the event. The structure is still * owned by the event, which means that you should not free it and * that the pointer becomes invalid when you free the event. - * This function checks if @event is writable and will never return NULL. + * This function checks if @event is writable and will never return %NULL. * * MT safe. */ @@ -1719,8 +1719,8 @@ gst_event_new_segment_done (GstFormat format, gint64 position) /** * gst_event_parse_segment_done: * @event: A valid #GstEvent of type GST_EVENT_SEGMENT_DONE. - * @format: (out) (allow-none): Result location for the format, or NULL - * @position: (out) (allow-none): Result location for the position, or NULL + * @format: (out) (allow-none): Result location for the format, or %NULL + * @position: (out) (allow-none): Result location for the position, or %NULL * * Extracts the position and format from the segment done message. * diff --git a/gst/gstevent.h b/gst/gstevent.h index a61f08054..2ee38eb73 100644 --- a/gst/gstevent.h +++ b/gst/gstevent.h @@ -285,9 +285,9 @@ GST_EXPORT GType _gst_event_type; * in some cases), and the reference counts are updated appropriately (the old * event is unreffed, the new one is reffed). * - * Either @new_event or the #GstEvent pointed to by @old_event may be NULL. + * Either @new_event or the #GstEvent pointed to by @old_event may be %NULL. * - * Returns: TRUE if @new_event was different from @old_event + * Returns: %TRUE if @new_event was different from @old_event */ #ifdef _FOOL_GTK_DOC_ G_INLINE_FUNC gboolean gst_event_replace (GstEvent **old_event, GstEvent *new_event); @@ -304,7 +304,7 @@ gst_event_replace (GstEvent **old_event, GstEvent *new_event) * @old_event: (inout) (transfer full): pointer to a pointer to a #GstEvent * to be stolen. * - * Atomically replace the #GstEvent pointed to by @old_event with NULL and + * Atomically replace the #GstEvent pointed to by @old_event with %NULL and * return the original event. * * Returns: the #GstEvent that was in @old_event @@ -330,9 +330,9 @@ gst_event_steal (GstEvent **old_event) * function is similar to gst_event_replace() except that it takes ownership of * @new_event. * - * Either @new_event or the #GstEvent pointed to by @old_event may be NULL. + * Either @new_event or the #GstEvent pointed to by @old_event may be %NULL. * - * Returns: TRUE if @new_event was different from @old_event + * Returns: %TRUE if @new_event was different from @old_event */ #ifdef _FOOL_GTK_DOC_ G_INLINE_FUNC gboolean gst_event_take (GstEvent **old_event, GstEvent *new_event); diff --git a/gst/gstformat.c b/gst/gstformat.c index 311b4bd77..69600cd28 100644 --- a/gst/gstformat.c +++ b/gst/gstformat.c @@ -85,7 +85,7 @@ _priv_gst_format_initialize (void) * * Get a printable name for the given format. Do not modify or free. * - * Returns: a reference to the static name of the format or NULL if + * Returns: a reference to the static name of the format or %NULL if * the format is unknown. */ const gchar * @@ -201,7 +201,7 @@ gst_format_get_by_nick (const gchar * nick) * * See if the given format is inside the format array. * - * Returns: TRUE if the format is found inside the array + * Returns: %TRUE if the format is found inside the array */ gboolean gst_formats_contains (const GstFormat * formats, GstFormat format) @@ -225,7 +225,7 @@ gst_formats_contains (const GstFormat * formats, GstFormat format) * * Get details about the given format. * - * Returns: The #GstFormatDefinition for @format or NULL on failure. + * Returns: The #GstFormatDefinition for @format or %NULL on failure. * * MT safe. */ diff --git a/gst/gstghostpad.c b/gst/gstghostpad.c index 5aac0eb99..cac0d51b7 100644 --- a/gst/gstghostpad.c +++ b/gst/gstghostpad.c @@ -75,11 +75,11 @@ static GstPad *gst_proxy_pad_get_target (GstPad * pad); /** * gst_proxy_pad_iterate_internal_links_default: * @pad: the #GstPad to get the internal links of. - * @parent: (allow-none): the parent of @pad or NULL + * @parent: (allow-none): the parent of @pad or %NULL * * Invoke the default iterate internal links function of the proxy pad. * - * Returns: a #GstIterator of #GstPad, or NULL if @pad has no parent. Unref each + * Returns: a #GstIterator of #GstPad, or %NULL if @pad has no parent. Unref each * returned pad with gst_object_unref(). */ GstIterator * @@ -104,7 +104,7 @@ gst_proxy_pad_iterate_internal_links_default (GstPad * pad, GstObject * parent) /** * gst_proxy_pad_chain_default: * @pad: a sink #GstPad, returns GST_FLOW_ERROR if not. - * @parent: (allow-none): the parent of @pad or NULL + * @parent: (allow-none): the parent of @pad or %NULL * @buffer: (transfer full): the #GstBuffer to send, return GST_FLOW_ERROR * if not. * @@ -132,7 +132,7 @@ gst_proxy_pad_chain_default (GstPad * pad, GstObject * parent, /** * gst_proxy_pad_chain_list_default: * @pad: a sink #GstPad, returns GST_FLOW_ERROR if not. - * @parent: (allow-none): the parent of @pad or NULL + * @parent: (allow-none): the parent of @pad or %NULL * @list: (transfer full): the #GstBufferList to send, return GST_FLOW_ERROR * if not. * @@ -208,7 +208,7 @@ gst_proxy_pad_get_target (GstPad * pad) * The internal pad of a #GstGhostPad is the internally used * pad of opposite direction, which is used to link to the target. * - * Returns: (transfer full): the target #GstProxyPad, can be NULL. + * Returns: (transfer full): the target #GstProxyPad, can be %NULL. * Unref target pad after usage. */ GstProxyPad * @@ -330,7 +330,7 @@ gst_ghost_pad_internal_activate_pull_default (GstPad * pad, GstObject * parent, /** * gst_ghost_pad_internal_activate_mode_default: * @pad: the #GstPad to activate or deactivate. - * @parent: (allow-none): the parent of @pad or NULL + * @parent: (allow-none): the parent of @pad or %NULL * @mode: the requested activation mode * @active: whether the pad should be active or not. * @@ -418,7 +418,7 @@ gst_ghost_pad_activate_pull_default (GstPad * pad, GstObject * parent, /** * gst_ghost_pad_activate_mode_default: * @pad: the #GstPad to activate or deactivate. - * @parent: (allow-none): the parent of @pad or NULL + * @parent: (allow-none): the parent of @pad or %NULL * @mode: the requested activation mode * @active: whether the pad should be active or not. * @@ -644,7 +644,7 @@ construct_failed: /** * gst_ghost_pad_new_no_target: - * @name: (allow-none): the name of the new pad, or NULL to assign a default name. + * @name: (allow-none): the name of the new pad, or %NULL to assign a default name. * @dir: the direction of the ghostpad * * Create a new ghostpad without a target with the given direction. @@ -653,7 +653,7 @@ construct_failed: * * The created ghostpad will not have a padtemplate. * - * Returns: (transfer full): a new #GstPad, or NULL in case of an error. + * Returns: (transfer full): a new #GstPad, or %NULL in case of an error. */ GstPad * gst_ghost_pad_new_no_target (const gchar * name, GstPadDirection dir) @@ -671,7 +671,7 @@ gst_ghost_pad_new_no_target (const gchar * name, GstPadDirection dir) /** * gst_ghost_pad_new: - * @name: (allow-none): the name of the new pad, or NULL to assign a default name + * @name: (allow-none): the name of the new pad, or %NULL to assign a default name * @target: (transfer none): the pad to ghost. * * Create a new ghostpad with @target as the target. The direction will be taken @@ -679,7 +679,7 @@ gst_ghost_pad_new_no_target (const gchar * name, GstPadDirection dir) * * Will ref the target. * - * Returns: (transfer floating): a new #GstPad, or NULL in case of an error. + * Returns: (transfer floating): a new #GstPad, or %NULL in case of an error. */ GstPad * gst_ghost_pad_new (const gchar * name, GstPad * target) @@ -710,7 +710,7 @@ set_target_failed: /** * gst_ghost_pad_new_from_template: - * @name: (allow-none): the name of the new pad, or NULL to assign a default name. + * @name: (allow-none): the name of the new pad, or %NULL to assign a default name. * @target: (transfer none): the pad to ghost. * @templ: (transfer none): the #GstPadTemplate to use on the ghostpad. * @@ -719,7 +719,7 @@ set_target_failed: * * Will ref the target. * - * Returns: (transfer full): a new #GstPad, or NULL in case of an error. + * Returns: (transfer full): a new #GstPad, or %NULL in case of an error. */ GstPad * @@ -755,13 +755,13 @@ set_target_failed: /** * gst_ghost_pad_new_no_target_from_template: - * @name: (allow-none): the name of the new pad, or NULL to assign a default name + * @name: (allow-none): the name of the new pad, or %NULL to assign a default name * @templ: (transfer none): the #GstPadTemplate to create the ghostpad from. * * Create a new ghostpad based on @templ, without setting a target. The * direction will be taken from the @templ. * - * Returns: (transfer full): a new #GstPad, or NULL in case of an error. + * Returns: (transfer full): a new #GstPad, or %NULL in case of an error. */ GstPad * gst_ghost_pad_new_no_target_from_template (const gchar * name, @@ -783,7 +783,7 @@ gst_ghost_pad_new_no_target_from_template (const gchar * name, * * Get the target pad of @gpad. Unref target pad after usage. * - * Returns: (transfer full): the target #GstPad, can be NULL if the ghostpad + * Returns: (transfer full): the target #GstPad, can be %NULL if the ghostpad * has no target set. Unref target pad after usage. */ GstPad * @@ -807,10 +807,10 @@ gst_ghost_pad_get_target (GstGhostPad * gpad) * * Set the new target of the ghostpad @gpad. Any existing target * is unlinked and links to the new target are established. if @newtarget is - * NULL the target will be cleared. + * %NULL the target will be cleared. * - * Returns: (transfer full): TRUE if the new target could be set. This function - * can return FALSE when the internal pads could not be linked. + * Returns: (transfer full): %TRUE if the new target could be set. This function + * can return %FALSE when the internal pads could not be linked. */ gboolean gst_ghost_pad_set_target (GstGhostPad * gpad, GstPad * newtarget) diff --git a/gst/gstinfo.c b/gst/gstinfo.c index 1d05cac06..0b36abef4 100644 --- a/gst/gstinfo.c +++ b/gst/gstinfo.c @@ -429,7 +429,7 @@ _priv_gst_debug_init (void) * @function: the function that emitted the message * @line: the line from that the message was emitted, usually __LINE__ * @object: (transfer none) (allow-none): the object this message relates to, - * or NULL if none + * or %NULL if none * @format: a printf style format string * @...: optional arguments for the format * @@ -481,7 +481,7 @@ gst_path_basename (const gchar * file_name) * @function: the function that emitted the message * @line: the line from that the message was emitted, usually __LINE__ * @object: (transfer none) (allow-none): the object this message relates to, - * or NULL if none + * or %NULL if none * @format: a printf style format string * @args: optional arguments for the format * @@ -961,7 +961,7 @@ static const gchar *levelcolormap[GST_LEVEL_COUNT] = { * @line: the line from that the message was emitted, usually __LINE__ * @message: the actual message * @object: (transfer none) (allow-none): the object this message relates to, - * or NULL if none + * or %NULL if none * @unused: an unused variable, reserved for some user_data. * * The default logging handler used by GStreamer. Logging functions get called @@ -1318,7 +1318,7 @@ gst_debug_set_color_mode_from_string (const gchar * mode) * * Checks if the debugging output should be colored. * - * Returns: TRUE, if the debug output should be colored. + * Returns: %TRUE, if the debug output should be colored. */ gboolean gst_debug_is_colored (void) @@ -1367,7 +1367,7 @@ gst_debug_set_active (gboolean active) * * Checks if debugging output is activated. * - * Returns: TRUE, if debugging is activated + * Returns: %TRUE, if debugging is activated */ gboolean gst_debug_is_active (void) diff --git a/gst/gstinfo.h b/gst/gstinfo.h index 25c69daf6..319e8416a 100644 --- a/gst/gstinfo.h +++ b/gst/gstinfo.h @@ -199,9 +199,9 @@ struct _GstDebugCategory { * GST_STR_NULL: * @str: The string to check. * - * Macro to use when a string must not be NULL, but may be NULL. If the string - * is NULL, "(NULL)" is printed instead. - * In GStreamer printf string arguments may not be NULL, because on some + * Macro to use when a string must not be %NULL, but may be %NULL. If the string + * is %NULL, "(NULL)" is printed instead. + * In GStreamer printf string arguments may not be %NULL, because on some * platforms (ie Solaris) the libc crashes in that case. This includes debugging * strings. */ @@ -470,7 +470,7 @@ G_STMT_START{ \ * * Looks up an existing #GstDebugCategory by its @name and sets @cat. If the * category is not found, but GST_CAT_DEFAULT is defined, that is assigned to - * @cat. Otherwise @cat will be NULL. + * @cat. Otherwise @cat will be %NULL. * * |[ * GST_DEBUG_CATEGORY_STATIC (gst_myplugin_debug); @@ -511,7 +511,7 @@ GST_EXPORT GstDebugLevel _gst_debug_min; * GST_CAT_LEVEL_LOG: * @cat: category to use * @level: the severity of the message - * @object: (allow-none): the #GObject the message belongs to or NULL if none + * @object: (allow-none): the #GObject the message belongs to or %NULL if none * @...: A printf-style message to output * * Outputs a debugging message. This is the most general macro for outputting diff --git a/gst/gstiterator.c b/gst/gstiterator.c index 92e3dd444..4e5b1f54d 100644 --- a/gst/gstiterator.c +++ b/gst/gstiterator.c @@ -586,8 +586,8 @@ gst_iterator_filter (GstIterator * it, GCompareFunc func, * This procedure can be used (and is used internally) to implement the * gst_iterator_foreach() and gst_iterator_find_custom() operations. * - * The fold will proceed as long as @func returns TRUE. When the iterator has no - * more arguments, %GST_ITERATOR_DONE will be returned. If @func returns FALSE, + * The fold will proceed as long as @func returns %TRUE. When the iterator has no + * more arguments, %GST_ITERATOR_DONE will be returned. If @func returns %FALSE, * the fold will stop, and %GST_ITERATOR_OK will be returned. Errors or resyncs * will cause fold to return %GST_ITERATOR_ERROR or %GST_ITERATOR_RESYNC as * appropriate. @@ -703,10 +703,10 @@ find_custom_fold_func (const GValue * item, GValue * ret, * * The iterator will not be freed. * - * This function will return FALSE if an error happened to the iterator + * This function will return %FALSE if an error happened to the iterator * or if the element wasn't found. * - * Returns: Returns TRUE if the element was found, else FALSE. + * Returns: Returns %TRUE if the element was found, else %FALSE. * * MT safe. */ diff --git a/gst/gstiterator.h b/gst/gstiterator.h index 7ad54ee21..264f197ec 100644 --- a/gst/gstiterator.h +++ b/gst/gstiterator.h @@ -146,7 +146,7 @@ typedef void (*GstIteratorForeachFunction) (const GValue * item, gpo * * A function to be passed to gst_iterator_fold(). * - * Returns: TRUE if the fold should continue, FALSE if it should stop. + * Returns: %TRUE if the fold should continue, %FALSE if it should stop. */ typedef gboolean (*GstIteratorFoldFunction) (const GValue * item, GValue * ret, gpointer user_data); diff --git a/gst/gstmemory.c b/gst/gstmemory.c index 863d2e6be..d5811f681 100644 --- a/gst/gstmemory.c +++ b/gst/gstmemory.c @@ -33,7 +33,7 @@ * in the allocated region. * * Memory is usually created by allocators with a gst_allocator_alloc() - * method call. When NULL is used as the allocator, the default allocator will + * method call. When %NULL is used as the allocator, the default allocator will * be used. * * New allocators can be registered with gst_allocator_register(). @@ -59,7 +59,7 @@ * memory with an existing memory block at a custom offset and with a custom * size. * - * Memory can be efficiently merged when gst_memory_is_span() returns TRUE. + * Memory can be efficiently merged when gst_memory_is_span() returns %TRUE. */ #ifdef HAVE_CONFIG_H @@ -224,7 +224,7 @@ gst_memory_resize (GstMemory * mem, gssize offset, gsize size) * This function takes ownership of old @mem and returns a reference to a new * #GstMemory. * - * Returns: (transfer full): a #GstMemory object mapped with @flags or NULL when + * Returns: (transfer full): a #GstMemory object mapped with @flags or %NULL when * a mapping is not possible. */ GstMemory * diff --git a/gst/gstmessage.c b/gst/gstmessage.c index 359a7b2dd..9a790d381 100644 --- a/gst/gstmessage.c +++ b/gst/gstmessage.c @@ -261,7 +261,7 @@ gst_message_init (GstMessageImpl * message, GstMessageType type, * * Create a new custom-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. + * app. The structure field can be %NULL. * * Returns: (transfer full): The new message. * @@ -582,7 +582,7 @@ gst_message_new_state_dirty (GstObject * src) * gst_message_new_clock_provide: * @src: (transfer none): the object originating the message. * @clock: (transfer none): the clock it provides - * @ready: TRUE if the sender can provide a clock + * @ready: %TRUE if the sender can provide a clock * * Create a clock provide message. This message is posted whenever an * element is ready to provide a clock or lost its ability to provide @@ -791,7 +791,7 @@ gst_message_new_application (GstObject * src, GstStructure * structure) * Create a new element-specific message. This is meant as a generic way of * allowing one-way communication from an element to an application, for example * "the firewire cable was unplugged". The format of the message should be - * documented in the element's documentation. The structure field can be NULL. + * documented in the element's documentation. The structure field can be %NULL. * * Returns: (transfer full): The new element message. * @@ -1056,11 +1056,11 @@ gst_message_set_buffering_stats (GstMessage * message, GstBufferingMode mode, /** * gst_message_parse_buffering_stats: * @message: A valid #GstMessage of type GST_MESSAGE_BUFFERING. - * @mode: (out) (allow-none): a buffering mode, or NULL - * @avg_in: (out) (allow-none): the average input rate, or NULL - * @avg_out: (out) (allow-none): the average output rate, or NULL + * @mode: (out) (allow-none): a buffering mode, or %NULL + * @avg_in: (out) (allow-none): the average input rate, or %NULL + * @avg_out: (out) (allow-none): the average output rate, or %NULL * @buffering_left: (out) (allow-none): amount of buffering time left in - * milliseconds, or NULL + * milliseconds, or %NULL * * Extracts the buffering stats values from @message. */ @@ -1093,9 +1093,9 @@ gst_message_parse_buffering_stats (GstMessage * message, /** * gst_message_parse_state_changed: * @message: a valid #GstMessage of type GST_MESSAGE_STATE_CHANGED - * @oldstate: (out) (allow-none): the previous state, or NULL - * @newstate: (out) (allow-none): the new (current) state, or NULL - * @pending: (out) (allow-none): the pending (target) state, or NULL + * @oldstate: (out) (allow-none): the previous state, or %NULL + * @newstate: (out) (allow-none): the new (current) state, or %NULL + * @pending: (out) (allow-none): the pending (target) state, or %NULL * * Extracts the old and new states from the GstMessage. * @@ -1148,8 +1148,8 @@ gst_message_parse_state_changed (GstMessage * message, * gst_message_parse_clock_provide: * @message: A valid #GstMessage of type GST_MESSAGE_CLOCK_PROVIDE. * @clock: (out) (allow-none) (transfer none): a pointer to hold a clock - * object, or NULL - * @ready: (out) (allow-none): a pointer to hold the ready flag, or NULL + * object, or %NULL + * @ready: (out) (allow-none): a pointer to hold the ready flag, or %NULL * * Extracts the clock and ready flag from the GstMessage. * The clock object returned remains valid until the message is freed. @@ -1281,7 +1281,7 @@ gst_message_parse_structure_change (GstMessage * message, * @message: A valid #GstMessage of type GST_MESSAGE_ERROR. * @gerror: (out) (allow-none) (transfer full): location for the GError * @debug: (out) (allow-none) (transfer full): location for the debug message, - * or NULL + * or %NULL * * Extracts the GError and debug string from the GstMessage. The values returned * in the output arguments are copies; the caller must free them when done. @@ -1325,7 +1325,7 @@ gst_message_parse_error (GstMessage * message, GError ** gerror, gchar ** debug) * @message: A valid #GstMessage of type GST_MESSAGE_WARNING. * @gerror: (out) (allow-none) (transfer full): location for the GError * @debug: (out) (allow-none) (transfer full): location for the debug message, - * or NULL + * or %NULL * * Extracts the GError and debug string from the GstMessage. The values returned * in the output arguments are copies; the caller must free them when done. @@ -1349,7 +1349,7 @@ gst_message_parse_warning (GstMessage * message, GError ** gerror, * @message: A valid #GstMessage of type GST_MESSAGE_INFO. * @gerror: (out) (allow-none) (transfer full): location for the GError * @debug: (out) (allow-none) (transfer full): location for the debug message, - * or NULL + * or %NULL * * Extracts the GError and debug string from the GstMessage. The values returned * in the output arguments are copies; the caller must free them when done. @@ -1370,8 +1370,8 @@ gst_message_parse_info (GstMessage * message, GError ** gerror, gchar ** debug) /** * gst_message_parse_segment_start: * @message: A valid #GstMessage of type GST_MESSAGE_SEGMENT_START. - * @format: (out) (allow-none): Result location for the format, or NULL - * @position: (out) (allow-none): Result location for the position, or NULL + * @format: (out) (allow-none): Result location for the format, or %NULL + * @position: (out) (allow-none): Result location for the position, or %NULL * * Extracts the position and format from the segment start message. * @@ -1400,8 +1400,8 @@ gst_message_parse_segment_start (GstMessage * message, GstFormat * format, /** * gst_message_parse_segment_done: * @message: A valid #GstMessage of type GST_MESSAGE_SEGMENT_DONE. - * @format: (out) (allow-none): Result location for the format, or NULL - * @position: (out) (allow-none): Result location for the position, or NULL + * @format: (out) (allow-none): Result location for the format, or %NULL + * @position: (out) (allow-none): Result location for the position, or %NULL * * Extracts the position and format from the segment done message. * @@ -1430,7 +1430,7 @@ gst_message_parse_segment_done (GstMessage * message, GstFormat * format, /** * gst_message_parse_async_done: * @message: A valid #GstMessage of type GST_MESSAGE_ASYNC_DONE. - * @running_time: (out) (allow-none): Result location for the running_time or NULL + * @running_time: (out) (allow-none): Result location for the running_time or %NULL * * Extract the running_time from the async_done message. * @@ -1454,7 +1454,7 @@ gst_message_parse_async_done (GstMessage * message, GstClockTime * running_time) /** * gst_message_parse_request_state: * @message: A valid #GstMessage of type GST_MESSAGE_REQUEST_STATE. - * @state: (out) (allow-none): Result location for the requested state or NULL + * @state: (out) (allow-none): Result location for the requested state or %NULL * * Extract the requested state from the request_state message. * @@ -1596,7 +1596,7 @@ gst_message_get_stream_status_object (GstMessage * message) * @eos: the step caused EOS * * This message is posted by elements when they complete a part, when @intermediate set - * to TRUE, or a complete step operation. + * to %TRUE, or a complete step operation. * * @duration will contain the amount of time (in GST_FORMAT_TIME) of the stepped * @amount of media in format @format. @@ -1675,10 +1675,10 @@ gst_message_parse_step_done (GstMessage * message, GstFormat * format, * This message is posted by elements when they accept or activate a new step * event for @amount in @format. * - * @active is set to FALSE when the element accepted the new step event and has + * @active is set to %FALSE when the element accepted the new step event and has * queued it for execution in the streaming threads. * - * @active is set to TRUE when the element has activated the step operation and + * @active is set to %TRUE when the element has activated the step operation and * is now ready to start executing the step in the streaming thread. After this * message is emitted, the application can queue a new step operation in the * element. @@ -2107,7 +2107,7 @@ gst_message_new_reset_time (GstObject * src, GstClockTime running_time) * gst_message_parse_reset_time: * @message: A valid #GstMessage of type GST_MESSAGE_RESET_TIME. * @running_time: (out) (allow-none): Result location for the running_time or - * NULL + * %NULL * * Extract the running-time from the RESET_TIME message. * @@ -2188,7 +2188,7 @@ gst_message_set_group_id (GstMessage * message, guint group_id) * gst_message_parse_group_id: * @message: A valid #GstMessage of type GST_MESSAGE_STREAM_START. * @group_id: (out) (allow-none): Result location for the group id or - * NULL + * %NULL * * Extract the group from the STREAM_START message. * @@ -2252,7 +2252,7 @@ gst_message_new_need_context (GstObject * src, const gchar * context_type) /** * gst_message_parse_context_type: * @message: a GST_MESSAGE_NEED_CONTEXT type message - * @context_type: (out) (allow-none): the context type, or NULL + * @context_type: (out) (allow-none): the context type, or %NULL * * Parse a context type from an existing GST_MESSAGE_NEED_CONTEXT message. * @@ -2311,7 +2311,7 @@ gst_message_new_have_context (GstObject * src, GstContext * context) * gst_message_parse_have_context: * @message: A valid #GstMessage of type GST_MESSAGE_HAVE_CONTEXT. * @context: (out) (transfer full) (allow-none): Result location for the - * context or NULL + * context or %NULL * * Extract the context from the HAVE_CONTEXT message. * diff --git a/gst/gstmessage.h b/gst/gstmessage.h index c9da762c4..72b426006 100644 --- a/gst/gstmessage.h +++ b/gst/gstmessage.h @@ -412,9 +412,9 @@ gst_message_copy (const GstMessage * msg) * in some cases), and the reference counts are updated appropriately (the old * message is unreffed, the new one is reffed). * - * Either @new_message or the #GstMessage pointed to by @old_message may be NULL. + * Either @new_message or the #GstMessage pointed to by @old_message may be %NULL. * - * Returns: TRUE if @new_message was different from @old_message + * Returns: %TRUE if @new_message was different from @old_message */ #ifdef _FOOL_GTK_DOC_ G_INLINE_FUNC gboolean gst_message_replace (GstMessage **old_message, GstMessage *new_message); diff --git a/gst/gstmeta.c b/gst/gstmeta.c index 954ff5956..0e0aca1aa 100644 --- a/gst/gstmeta.c +++ b/gst/gstmeta.c @@ -205,7 +205,7 @@ gst_meta_register (GType api, const gchar * impl, gsize size, * Lookup a previously registered meta info structure by its implementation name * @impl. * - * Returns: (transfer none): a #GstMetaInfo with @impl, or #NULL when no such + * Returns: (transfer none): a #GstMetaInfo with @impl, or %NULL when no such * metainfo exists. */ const GstMetaInfo * diff --git a/gst/gstminiobject.c b/gst/gstminiobject.c index 5e8b11cc4..bece06ad8 100644 --- a/gst/gstminiobject.c +++ b/gst/gstminiobject.c @@ -104,9 +104,9 @@ _priv_gst_mini_object_initialize (void) * @mini_object: a #GstMiniObject * @flags: initial #GstMiniObjectFlags * @type: the #GType of the mini-object to create - * @copy_func: (allow-none): the copy function, or NULL - * @dispose_func: (allow-none): the dispose function, or NULL - * @free_func: (allow-none): the free function or NULL + * @copy_func: (allow-none): the copy function, or %NULL + * @dispose_func: (allow-none): the dispose function, or %NULL + * @free_func: (allow-none): the free function or %NULL * * Initializes a mini-object with the desired type and copy/dispose/free * functions. @@ -279,7 +279,7 @@ gst_mini_object_unlock (GstMiniObject * object, GstLockFlags flags) * Modification of a mini-object should only be done after verifying that it * is writable. * - * Returns: TRUE if the object is writable. + * Returns: %TRUE if the object is writable. */ gboolean gst_mini_object_is_writable (const GstMiniObject * mini_object) @@ -477,9 +477,9 @@ gst_mini_object_unref (GstMiniObject * mini_object) * The reference count of @olddata is decreased and the reference count of * @newdata is increased. * - * Either @newdata and the value pointed to by @olddata may be NULL. + * Either @newdata and the value pointed to by @olddata may be %NULL. * - * Returns: TRUE if @newdata was different from @olddata + * Returns: %TRUE if @newdata was different from @olddata */ gboolean gst_mini_object_replace (GstMiniObject ** olddata, GstMiniObject * newdata) @@ -518,7 +518,7 @@ gst_mini_object_replace (GstMiniObject ** olddata, GstMiniObject * newdata) * @olddata: (inout) (transfer full): pointer to a pointer to a mini-object to * be stolen * - * Replace the current #GstMiniObject pointer to by @olddata with NULL and + * Replace the current #GstMiniObject pointer to by @olddata with %NULL and * return the old value. * * Returns: the #GstMiniObject at @oldata @@ -554,9 +554,9 @@ gst_mini_object_steal (GstMiniObject ** olddata) * except that it does not increase the refcount of @newdata and thus * takes ownership of @newdata. * - * Either @newdata and the value pointed to by @olddata may be NULL. + * Either @newdata and the value pointed to by @olddata may be %NULL. * - * Returns: TRUE if @newdata was different from @olddata + * Returns: %TRUE if @newdata was different from @olddata */ gboolean gst_mini_object_take (GstMiniObject ** olddata, GstMiniObject * newdata) @@ -648,7 +648,7 @@ gst_mini_object_weak_unref (GstMiniObject * object, * can be gotten back from the @object with gst_mini_object_get_qdata() * until the @object is disposed. * Setting a previously set user data pointer, overrides (frees) - * the old pointer set, using #NULL as pointer essentially + * the old pointer set, using %NULL as pointer essentially * removes the data stored. * * @destroy may be specified which is called with @data as argument diff --git a/gst/gstobject.c b/gst/gstobject.c index cab13e156..b997db6f7 100644 --- a/gst/gstobject.c +++ b/gst/gstobject.c @@ -318,9 +318,9 @@ gst_object_ref_sink (gpointer object) * The reference count of @oldobj is decreased and the reference count of * @newobj is increased. * - * Either @newobj and the value pointed to by @oldobj may be NULL. + * Either @newobj and the value pointed to by @oldobj may be %NULL. * - * Returns: TRUE if @newobj was different from @oldobj + * Returns: %TRUE if @newobj was different from @oldobj */ gboolean gst_object_replace (GstObject ** oldobj, GstObject * newobj) @@ -481,7 +481,7 @@ gst_object_dispatch_properties_changed (GObject * object, * @orig: a #GstObject that initiated the notify. * @pspec: a #GParamSpec of the property. * @excluded_props: (array zero-terminated=1) (element-type gchar*) (allow-none): - * a set of user-specified properties to exclude or NULL to show + * a set of user-specified properties to exclude or %NULL to show * all changes. * * A default deep_notify signal callback for an object. The user data @@ -591,12 +591,12 @@ had_parent: * @name: new name of object * * Sets the name of @object, or gives @object a guaranteed unique - * name (if @name is NULL). + * name (if @name is %NULL). * This function makes a copy of the provided name, so the caller * retains ownership of the name it sent. * - * Returns: TRUE if the name could be set. Since Objects that have - * a parent cannot be renamed, this function returns FALSE in those + * Returns: %TRUE if the name could be set. Since Objects that have + * a parent cannot be renamed, this function returns %FALSE in those * cases. * * MT safe. This function grabs and releases @object's LOCK. @@ -644,7 +644,7 @@ had_parent: * * Returns a copy of the name of @object. * Caller should g_free() the return value after usage. - * For a nameless object, this returns NULL, which you can safely g_free() + * For a nameless object, this returns %NULL, which you can safely g_free() * as well. * * Free-function: g_free @@ -675,7 +675,7 @@ gst_object_get_name (GstObject * object) * Sets the parent of @object to @parent. The object's reference count will * be incremented, and any floating reference will be removed (see gst_object_ref_sink()). * - * Returns: TRUE if @parent could be set or FALSE when @object + * Returns: %TRUE if @parent could be set or %FALSE when @object * already had a parent or @object and @parent are the same. * * MT safe. Grabs and releases @object's LOCK. @@ -724,7 +724,7 @@ had_parent: * Returns the parent of @object. This function increases the refcount * of the parent object so you should gst_object_unref() it after usage. * - * Returns: (transfer full): parent of @object, this can be NULL if @object + * Returns: (transfer full): parent of @object, this can be %NULL if @object * has no parent. unref after usage. * * MT safe. Grabs and releases @object's LOCK. @@ -785,7 +785,7 @@ gst_object_unparent (GstObject * object) * Check if @object has an ancestor @ancestor somewhere up in * the hierarchy. One can e.g. check if a #GstElement is inside a #GstPipeline. * - * Returns: TRUE if @ancestor is an ancestor of @object. + * Returns: %TRUE if @ancestor is an ancestor of @object. * * MT safe. Grabs and releases @object's locks. */ @@ -824,8 +824,8 @@ gst_object_has_ancestor (GstObject * object, GstObject * ancestor) * will lock each #GstObject in the list to compare the name, so be * careful when passing a list with a locked object. * - * Returns: TRUE if a #GstObject named @name does not appear in @list, - * FALSE if it does. + * Returns: %TRUE if a #GstObject named @name does not appear in @list, + * %FALSE if it does. * * MT safe. Grabs and releases the LOCK of each object in the list. */ diff --git a/gst/gstobject.h b/gst/gstobject.h index adc8e46e1..86c571542 100644 --- a/gst/gstobject.h +++ b/gst/gstobject.h @@ -89,7 +89,7 @@ typedef enum * @obj: a #GstObject. * * This macro will try to obtain a lock on the object, but will return with - * FALSE if it can't get it immediately. + * %FALSE if it can't get it immediately. */ #define GST_OBJECT_TRYLOCK(obj) g_mutex_trylock(GST_OBJECT_GET_LOCK(obj)) /** diff --git a/gst/gstpad.c b/gst/gstpad.c index f98083c09..09ce750a1 100644 --- a/gst/gstpad.c +++ b/gst/gstpad.c @@ -38,7 +38,7 @@ * application requests. * * Pads without pad templates can be created with gst_pad_new(), - * which takes a direction and a name as an argument. If the name is NULL, + * which takes a direction and a name as an argument. If the name is %NULL, * then a guaranteed unique name will be assigned to it. * * A #GstElement creating a pad will typically use the various @@ -123,7 +123,7 @@ enum /* we have a pending and an active event on the pad. On source pads only the * active event is used. On sinkpads, events are copied to the pending entry and - * moved to the active event when the eventfunc returned TRUE. */ + * moved to the active event when the eventfunc returned %TRUE. */ typedef struct { gboolean received; @@ -504,7 +504,7 @@ remove_event_by_type (GstPad * pad, GstEventType type) } /* check all events on srcpad against those on sinkpad. All events that are not - * on sinkpad are marked as received=FALSE and the PENDING_EVENTS is set on the + * on sinkpad are marked as received=%FALSE and the PENDING_EVENTS is set on the * srcpad so that the events will be sent next time */ /* should be called with srcpad and sinkpad LOCKS */ static void @@ -770,11 +770,11 @@ gst_pad_get_property (GObject * object, guint prop_id, * @direction: the #GstPadDirection of the pad. * * Creates a new pad with the given name in the given direction. - * If name is NULL, a guaranteed unique name (across all pads) + * If name is %NULL, a guaranteed unique name (across all pads) * will be assigned. * This function makes a copy of the name so you can safely free the name. * - * Returns: (transfer floating): a new #GstPad, or NULL in case of an error. + * Returns: (transfer floating): a new #GstPad, or %NULL in case of an error. * * MT safe. */ @@ -791,11 +791,11 @@ gst_pad_new (const gchar * name, GstPadDirection direction) * @name: the name of the element * * Creates a new pad with the given name from the given template. - * If name is NULL, a guaranteed unique name (across all pads) + * If name is %NULL, a guaranteed unique name (across all pads) * will be assigned. * This function makes a copy of the name so you can safely free the name. * - * Returns: (transfer floating): a new #GstPad, or NULL in case of an error. + * Returns: (transfer floating): a new #GstPad, or %NULL in case of an error. */ GstPad * gst_pad_new_from_template (GstPadTemplate * templ, const gchar * name) @@ -812,11 +812,11 @@ gst_pad_new_from_template (GstPadTemplate * templ, const gchar * name) * @name: the name of the element * * Creates a new pad with the given name from the given static template. - * If name is NULL, a guaranteed unique name (across all pads) + * If name is %NULL, a guaranteed unique name (across all pads) * will be assigned. * This function makes a copy of the name so you can safely free the name. * - * Returns: (transfer floating): a new #GstPad, or NULL in case of an error. + * Returns: (transfer floating): a new #GstPad, or %NULL in case of an error. */ GstPad * gst_pad_new_from_static_template (GstStaticPadTemplate * templ, @@ -981,9 +981,9 @@ post_activate (GstPad * pad, GstPadMode new_mode) * function to perform the actual activation. * * If not @active, calls gst_pad_activate_mode() with the pad's current mode - * and a FALSE argument. + * and a %FALSE argument. * - * Returns: #TRUE if the operation was successful. + * Returns: %TRUE if the operation was successful. * * MT safe. */ @@ -1064,7 +1064,7 @@ failed: * * If you don't know what this is, you probably don't want to call it. * - * Returns: TRUE if the operation was successful. + * Returns: %TRUE if the operation was successful. * * MT safe. */ @@ -1216,7 +1216,7 @@ failure: * * Query if a pad is active * - * Returns: TRUE if the pad is active. + * Returns: %TRUE if the pad is active. * * MT safe. */ @@ -1436,7 +1436,7 @@ not_found: * last requested state of the pad. It is not certain that the pad * is actually blocking at this point (see gst_pad_is_blocking()). * - * Returns: TRUE if the pad is blocked. + * Returns: %TRUE if the pad is blocked. * * MT safe. */ @@ -1461,7 +1461,7 @@ gst_pad_is_blocked (GstPad * pad) * Checks if the pad is blocking or not. This is a guaranteed state * of whether the pad is actually blocking on a #GstBuffer or a #GstEvent. * - * Returns: TRUE if the pad is blocking. + * Returns: %TRUE if the pad is blocking. * * MT safe. */ @@ -1553,7 +1553,7 @@ gst_pad_mark_reconfigure (GstPad * pad) * @p: a #GstPad. * @f: the #GstPadActivateFunction to set. * - * Calls gst_pad_set_activate_function_full() with NULL for the user_data and + * Calls gst_pad_set_activate_function_full() with %NULL for the user_data and * notify. */ /** @@ -1590,7 +1590,7 @@ gst_pad_set_activate_function_full (GstPad * pad, * @p: a #GstPad. * @f: the #GstPadActivateModeFunction to set. * - * Calls gst_pad_set_activatemode_function_full() with NULL for the user_data and + * Calls gst_pad_set_activatemode_function_full() with %NULL for the user_data and * notify. */ /** @@ -1625,7 +1625,7 @@ gst_pad_set_activatemode_function_full (GstPad * pad, * @p: a sink #GstPad. * @f: the #GstPadChainFunction to set. * - * Calls gst_pad_set_chain_function_full() with NULL for the user_data and + * Calls gst_pad_set_chain_function_full() with %NULL for the user_data and * notify. */ /** @@ -1660,7 +1660,7 @@ gst_pad_set_chain_function_full (GstPad * pad, GstPadChainFunction chain, * @p: a sink #GstPad. * @f: the #GstPadChainListFunction to set. * - * Calls gst_pad_set_chain_list_function_full() with NULL for the user_data and + * Calls gst_pad_set_chain_list_function_full() with %NULL for the user_data and * notify. */ /** @@ -1697,7 +1697,7 @@ gst_pad_set_chain_list_function_full (GstPad * pad, * @p: a source #GstPad. * @f: the #GstPadGetRangeFunction to set. * - * Calls gst_pad_set_getrange_function_full() with NULL for the user_data and + * Calls gst_pad_set_getrange_function_full() with %NULL for the user_data and * notify. */ /** @@ -1733,7 +1733,7 @@ gst_pad_set_getrange_function_full (GstPad * pad, GstPadGetRangeFunction get, * @p: a #GstPad of either direction. * @f: the #GstPadEventFunction to set. * - * Calls gst_pad_set_event_function_full() with NULL for the user_data and + * Calls gst_pad_set_event_function_full() with %NULL for the user_data and * notify. */ /** @@ -1766,7 +1766,7 @@ gst_pad_set_event_function_full (GstPad * pad, GstPadEventFunction event, * @p: a #GstPad of either direction. * @f: the #GstPadQueryFunction to set. * - * Calls gst_pad_set_query_function_full() with NULL for the user_data and + * Calls gst_pad_set_query_function_full() with %NULL for the user_data and * notify. */ /** @@ -1799,7 +1799,7 @@ gst_pad_set_query_function_full (GstPad * pad, GstPadQueryFunction query, * @p: a #GstPad of either direction. * @f: the #GstPadIterIntLinkFunction to set. * - * Calls gst_pad_set_iterate_internal_links_function_full() with NULL + * Calls gst_pad_set_iterate_internal_links_function_full() with %NULL * for the user_data and notify. */ /** @@ -1833,7 +1833,7 @@ gst_pad_set_iterate_internal_links_function_full (GstPad * pad, * @p: a #GstPad. * @f: the #GstPadLinkFunction to set. * - * Calls gst_pad_set_link_function_full() with NULL + * Calls gst_pad_set_link_function_full() with %NULL * for the user_data and notify. */ /** @@ -1876,7 +1876,7 @@ gst_pad_set_link_function_full (GstPad * pad, GstPadLinkFunction link, * @p: a #GstPad. * @f: the #GstPadUnlinkFunction to set. * - * Calls gst_pad_set_unlink_function_full() with NULL + * Calls gst_pad_set_unlink_function_full() with %NULL * for the user_data and notify. */ /** @@ -1913,7 +1913,7 @@ gst_pad_set_unlink_function_full (GstPad * pad, GstPadUnlinkFunction unlink, * Unlinks the source pad from the sink pad. Will emit the #GstPad::unlinked * signal on both pads. * - * Returns: TRUE if the pads were unlinked. This function returns FALSE if + * Returns: %TRUE if the pads were unlinked. This function returns %FALSE if * the pads were not linked together. * * MT safe. @@ -2015,7 +2015,7 @@ not_linked_together: * * Checks if a @pad is linked to another pad or not. * - * Returns: TRUE if the pad is linked, FALSE otherwise. + * Returns: %TRUE if the pad is linked, %FALSE otherwise. * * MT safe. */ @@ -2079,7 +2079,7 @@ gst_pad_link_check_compatible_unlocked (GstPad * src, GstPad * sink, sinkcaps); /* if we have caps on both pads we can check the intersection. If one - * of the caps is NULL, we return TRUE. */ + * of the caps is %NULL, we return %TRUE. */ if (G_UNLIKELY (srccaps == NULL || sinkcaps == NULL)) { if (srccaps) gst_caps_unref (srccaps); @@ -2245,7 +2245,7 @@ no_format: * Checks if the source pad and the sink pad are compatible so they can be * linked. * - * Returns: TRUE if the pads can be linked. + * Returns: %TRUE if the pads can be linked. */ gboolean gst_pad_can_link (GstPad * srcpad, GstPad * sinkpad) @@ -2480,7 +2480,7 @@ gst_pad_get_pad_template (GstPad * pad) * * Check if @pad has caps set on it with a #GST_EVENT_CAPS event. * - * Returns: TRUE when @pad has caps associated with it. + * Returns: %TRUE when @pad has caps associated with it. */ gboolean gst_pad_has_current_caps (GstPad * pad) @@ -2585,7 +2585,7 @@ gst_pad_get_peer (GstPad * pad) * on the resulting caps. * * Returns: (transfer full): the allowed #GstCaps of the pad link. Unref the - * caps when you no longer need it. This function returns NULL when @pad + * caps when you no longer need it. This function returns %NULL when @pad * has no peer. * * MT safe. @@ -2632,7 +2632,7 @@ no_peer: /** * gst_pad_iterate_internal_links_default: * @pad: the #GstPad to get the internal links of. - * @parent: (allow-none): the parent of @pad or NULL + * @parent: (allow-none): the parent of @pad or %NULL * * Iterate the list of pads to which the given pad is linked to inside of * the parent element. @@ -2641,7 +2641,7 @@ no_peer: * * The caller must free this iterator after use with gst_iterator_free(). * - * Returns: a #GstIterator of #GstPad, or NULL if @pad has no parent. Unref each + * Returns: a #GstIterator of #GstPad, or %NULL if @pad has no parent. Unref each * returned pad with gst_object_unref(). */ GstIterator * @@ -2749,9 +2749,9 @@ no_parent: * dynamically changing internal pads and will make sure that the @forward * function is only called once for each pad. * - * When @forward returns TRUE, no further pads will be processed. + * When @forward returns %TRUE, no further pads will be processed. * - * Returns: TRUE if one of the dispatcher functions returned TRUE. + * Returns: %TRUE if one of the dispatcher functions returned %TRUE. */ gboolean gst_pad_forward (GstPad * pad, GstPadForwardFunction forward, @@ -2841,7 +2841,7 @@ event_forward_func (GstPad * pad, EventData * data) /** * gst_pad_event_default: * @pad: a #GstPad to call the default event handler on. - * @parent: (allow-none): the parent of @pad or NULL + * @parent: (allow-none): the parent of @pad or %NULL * @event: (transfer full): the #GstEvent to handle. * * Invokes the default event handler for the given pad. @@ -2852,7 +2852,7 @@ event_forward_func (GstPad * pad, EventData * data) * The the event is sent to all pads internally linked to @pad. This function * takes ownership of @event. * - * Returns: TRUE if the event was sent successfully. + * Returns: %TRUE if the event was sent successfully. */ gboolean gst_pad_event_default (GstPad * pad, GstObject * parent, GstEvent * event) @@ -3039,7 +3039,7 @@ query_forward_func (GstPad * pad, QueryData * data) /** * gst_pad_query_default: * @pad: a #GstPad to call the default query handler on. - * @parent: (allow-none): the parent of @pad or NULL + * @parent: (allow-none): the parent of @pad or %NULL * @query: (transfer none): the #GstQuery to handle. * * Invokes the default query handler for the given pad. @@ -3048,7 +3048,7 @@ query_forward_func (GstPad * pad, QueryData * data) * @pad, only one will be sent the query. * Multi-sinkpad elements should implement custom query handlers. * - * Returns: TRUE if the query was performed successfully. + * Returns: %TRUE if the query was performed successfully. */ gboolean gst_pad_query_default (GstPad * pad, GstObject * parent, GstQuery * query) @@ -3529,7 +3529,7 @@ check_sticky (GstPad * pad, GstEvent * event) * * Please also note that some queries might need a running pipeline to work. * - * Returns: TRUE if the query could be performed. + * Returns: %TRUE if the query could be performed. */ gboolean gst_pad_query (GstPad * pad, GstQuery * query) @@ -3654,7 +3654,7 @@ probe_stopped: * The caller is responsible for both the allocation and deallocation of * the query structure. * - * Returns: TRUE if the query could be performed. This function returns %FALSE + * Returns: %TRUE if the query could be performed. This function returns %FALSE * if @pad has no peer. */ gboolean @@ -4380,7 +4380,7 @@ get_range_failed: * installed (see gst_pad_set_getrange_function()) this function returns * #GST_FLOW_NOT_SUPPORTED. * - * If @buffer points to a variable holding NULL, a valid new #GstBuffer will be + * If @buffer points to a variable holding %NULL, a valid new #GstBuffer will be * placed in @buffer when this function returns #GST_FLOW_OK. The new buffer * must be freed with gst_buffer_unref() after usage. * @@ -4434,10 +4434,10 @@ gst_pad_get_range (GstPad * pad, guint64 offset, guint size, * See gst_pad_get_range() for a list of return values and for the * semantics of the arguments of this function. * - * If @buffer points to a variable holding NULL, a valid new #GstBuffer will be + * If @buffer points to a variable holding %NULL, a valid new #GstBuffer will be * placed in @buffer when this function returns #GST_FLOW_OK. The new buffer * must be freed with gst_buffer_unref() after usage. When this function - * returns any other result value, @buffer will still point to NULL. + * returns any other result value, @buffer will still point to %NULL. * * When @buffer points to a variable that points to a valid #GstBuffer, the * buffer will be filled with the result data when this function returns @@ -4900,7 +4900,7 @@ idle_probe_stopped: * This function takes ownership of the provided event so you should * gst_event_ref() it if you want to reuse the event after this call. * - * Returns: TRUE if the event was handled. + * Returns: %TRUE if the event was handled. * * MT safe. */ @@ -5264,7 +5264,7 @@ precheck_failed: * This function takes ownership of the provided event so you should * gst_event_ref() it if you want to reuse the event after this call. * - * Returns: TRUE if the event was handled. + * Returns: %TRUE if the event was handled. */ gboolean gst_pad_send_event (GstPad * pad, GstEvent * event) @@ -5348,7 +5348,7 @@ gst_pad_get_element_private (GstPad * pad) * Returns a new reference of the sticky event of type @event_type * from the event. * - * Returns: (transfer full): a #GstEvent of type @event_type or NULL when no + * Returns: (transfer full): a #GstEvent of type @event_type or %NULL when no * event of @event_type was on @pad. Unref after usage. */ GstEvent * @@ -5544,7 +5544,7 @@ concurrent_stop: * function executed by the task is finished if this function is not * called from the task function. * - * Returns: a TRUE if the task could be paused or FALSE when the pad + * Returns: a %TRUE if the task could be paused or %FALSE when the pad * has no task. */ gboolean @@ -5593,7 +5593,7 @@ no_task: * Regardless of whether the pad has a task, the stream lock is acquired and * released so as to ensure that streaming through this pad has finished. * - * Returns: a TRUE if the task could be stopped or FALSE on error. + * Returns: a %TRUE if the task could be stopped or %FALSE on error. */ gboolean gst_pad_stop_task (GstPad * pad) diff --git a/gst/gstpad.h b/gst/gstpad.h index 67ec70d9a..bfb8b1a29 100644 --- a/gst/gstpad.h +++ b/gst/gstpad.h @@ -229,7 +229,7 @@ typedef enum { * activate function that puts the pad in push mode but elements can * override this function to activate the pad in pull mode if they wish. * - * Returns: TRUE if the pad could be activated. + * Returns: %TRUE if the pad could be activated. */ typedef gboolean (*GstPadActivateFunction) (GstPad *pad, GstObject *parent); /** @@ -241,7 +241,7 @@ typedef gboolean (*GstPadActivateFunction) (GstPad *pad, GstObject *parent); * * The prototype of the push and pull activate functions. * - * Returns: TRUE if the pad could be activated or deactivated. + * Returns: %TRUE if the pad could be activated or deactivated. */ typedef gboolean (*GstPadActivateModeFunction) (GstPad *pad, GstObject *parent, GstPadMode mode, gboolean active); @@ -252,7 +252,7 @@ typedef gboolean (*GstPadActivateModeFunction) (GstPad *pad, GstObject *parent, * GstPadChainFunction: * @pad: the sink #GstPad that performed the chain. * @parent: the parent of @pad. If the #GST_PAD_FLAG_NEED_PARENT flag is set, - * @parent is guaranteed to be not-NULL and remain valid during the + * @parent is guaranteed to be not-%NULL and remain valid during the * execution of this function. * @buffer: the #GstBuffer that is chained, not %NULL. * @@ -275,7 +275,7 @@ typedef GstFlowReturn (*GstPadChainFunction) (GstPad *pad, GstObject *parent, * GstPadChainListFunction: * @pad: the sink #GstPad that performed the chain. * @parent: the parent of @pad. If the #GST_PAD_FLAG_NEED_PARENT flag is set, - * @parent is guaranteed to be not-NULL and remain valid during the + * @parent is guaranteed to be not-%NULL and remain valid during the * execution of this function. * @list: the #GstBufferList that is chained, not %NULL. * @@ -298,11 +298,11 @@ typedef GstFlowReturn (*GstPadChainListFunction) (GstPad *pad, GstObject *paren * GstPadGetRangeFunction: * @pad: the src #GstPad to perform the getrange on. * @parent: the parent of @pad. If the #GST_PAD_FLAG_NEED_PARENT flag is set, - * @parent is guaranteed to be not-NULL and remain valid during the + * @parent is guaranteed to be not-%NULL and remain valid during the * execution of this function. * @offset: the offset of the range * @length: the length of the range - * @buffer: a memory location to hold the result buffer, cannot be NULL. + * @buffer: a memory location to hold the result buffer, cannot be %NULL. * * This function will be called on source pads when a peer element * request a buffer at the specified @offset and @length. If this function @@ -349,13 +349,13 @@ typedef GstFlowReturn (*GstPadGetRangeFunction) (GstPad *pad, GstObject *parent * GstPadEventFunction: * @pad: the #GstPad to handle the event. * @parent: the parent of @pad. If the #GST_PAD_FLAG_NEED_PARENT flag is set, - * @parent is guaranteed to be not-NULL and remain valid during the + * @parent is guaranteed to be not-%NULL and remain valid during the * execution of this function. * @event: the #GstEvent to handle. * * Function signature to handle an event for the pad. * - * Returns: TRUE if the pad could handle the event. + * Returns: %TRUE if the pad could handle the event. */ typedef gboolean (*GstPadEventFunction) (GstPad *pad, GstObject *parent, GstEvent *event); @@ -366,7 +366,7 @@ typedef gboolean (*GstPadEventFunction) (GstPad *pad, GstObject *parent, * GstPadIterIntLinkFunction: * @pad: The #GstPad to query. * @parent: the parent of @pad. If the #GST_PAD_FLAG_NEED_PARENT flag is set, - * @parent is guaranteed to be not-NULL and remain valid during the + * @parent is guaranteed to be not-%NULL and remain valid during the * execution of this function. * * The signature of the internal pad link iterator function. @@ -383,13 +383,13 @@ typedef GstIterator* (*GstPadIterIntLinkFunction) (GstPad *pad, Gst * GstPadQueryFunction: * @pad: the #GstPad to query. * @parent: the parent of @pad. If the #GST_PAD_FLAG_NEED_PARENT flag is set, - * @parent is guaranteed to be not-NULL and remain valid during the + * @parent is guaranteed to be not-%NULL and remain valid during the * execution of this function. * @query: the #GstQuery object to execute * * The signature of the query function. * - * Returns: TRUE if the query could be performed. + * Returns: %TRUE if the query could be performed. */ typedef gboolean (*GstPadQueryFunction) (GstPad *pad, GstObject *parent, GstQuery *query); @@ -400,7 +400,7 @@ typedef gboolean (*GstPadQueryFunction) (GstPad *pad, GstObject *parent, * GstPadLinkFunction: * @pad: the #GstPad that is linked. * @parent: the parent of @pad. If the #GST_PAD_FLAG_NEED_PARENT flag is set, - * @parent is guaranteed to be not-NULL and remain valid during the + * @parent is guaranteed to be not-%NULL and remain valid during the * execution of this function. * @peer: the peer #GstPad of the link * @@ -413,7 +413,7 @@ typedef GstPadLinkReturn (*GstPadLinkFunction) (GstPad *pad, GstObject *parent, * GstPadUnlinkFunction: * @pad: the #GstPad that is linked. * @parent: the parent of @pad. If the #GST_PAD_FLAG_NEED_PARENT flag is set, - * @parent is guaranteed to be not-NULL and remain valid during the + * @parent is guaranteed to be not-%NULL and remain valid during the * execution of this function. * * Function signature to handle a unlinking the pad prom its peer. @@ -430,7 +430,7 @@ typedef void (*GstPadUnlinkFunction) (GstPad *pad, GstObject *parent); * A forward function is called for all internally linked pads, see * gst_pad_forward(). * - * Returns: TRUE if the dispatching procedure has to be stopped. + * Returns: %TRUE if the dispatching procedure has to be stopped. */ typedef gboolean (*GstPadForwardFunction) (GstPad *pad, gpointer user_data); @@ -525,7 +525,7 @@ typedef enum * @type: the current probe type * @id: the id of the probe * @data: type specific data, check the @type field to know the datatype. - * This field can be NULL. + * This field can be %NULL. * @offset: offset of pull probe, this field is valid when @type contains * #GST_PAD_PROBE_TYPE_PULL * @size: size of pull probe, this field is valid when @type contains @@ -589,7 +589,7 @@ typedef GstPadProbeReturn (*GstPadProbeCallback) (GstPad *pad, GstPadProbeIn * When this function returns %TRUE, the next event will be * returned. When %FALSE is returned, gst_pad_sticky_events_foreach() will return. * - * When @event is set to NULL, the item will be removed from the list of sticky events. + * When @event is set to %NULL, the item will be removed from the list of sticky events. * @event can be replaced by assigning a new reference to it. * This function is responsible for unreffing the old event when * removing or modifying. @@ -898,21 +898,21 @@ struct _GstPadClass { * GST_PAD_IS_SRC: * @pad: a #GstPad * - * Returns: TRUE if the pad is a source pad (i.e. produces data). + * Returns: %TRUE if the pad is a source pad (i.e. produces data). */ #define GST_PAD_IS_SRC(pad) (GST_PAD_DIRECTION(pad) == GST_PAD_SRC) /** * GST_PAD_IS_SINK: * @pad: a #GstPad * - * Returns: TRUE if the pad is a sink pad (i.e. consumes data). + * Returns: %TRUE if the pad is a sink pad (i.e. consumes data). */ #define GST_PAD_IS_SINK(pad) (GST_PAD_DIRECTION(pad) == GST_PAD_SINK) /** * GST_PAD_IS_LINKED: * @pad: a #GstPad * - * Returns: TRUE if the pad is linked to another pad. Use gst_pad_is_linked() + * Returns: %TRUE if the pad is linked to another pad. Use gst_pad_is_linked() * instead. */ #define GST_PAD_IS_LINKED(pad) (GST_PAD_PEER(pad) != NULL) @@ -920,7 +920,7 @@ struct _GstPadClass { * GST_PAD_IS_ACTIVE: * @pad: a #GstPad * - * Returns: TRUE if the pad has been activated. + * Returns: %TRUE if the pad has been activated. */ #define GST_PAD_IS_ACTIVE(pad) (GST_PAD_MODE(pad) != GST_PAD_MODE_NONE) /** @@ -1134,8 +1134,8 @@ struct _GstPadClass { * GST_PAD_STREAM_TRYLOCK: * @pad: a #GstPad * - * Try to take the pad's stream lock, and return TRUE if the lock could be - * taken, and otherwise FALSE. + * Try to take the pad's stream lock, and return %TRUE if the lock could be + * taken, and otherwise %FALSE. */ #define GST_PAD_STREAM_TRYLOCK(pad) g_rec_mutex_trylock(GST_PAD_GET_STREAM_LOCK(pad)) /** @@ -1183,7 +1183,7 @@ GstPad* gst_pad_new_from_static_template (GstStaticPadTemplate *templ, const g * * Get the parent of @pad. This function increases the refcount * of the parent object so you should gst_object_unref() it after usage. - * Can return NULL if the pad did not have a parent. + * Can return %NULL if the pad did not have a parent. * * MT safe. */ diff --git a/gst/gstparse.c b/gst/gstparse.c index f036befe4..dd22113d4 100644 --- a/gst/gstparse.c +++ b/gst/gstparse.c @@ -139,7 +139,7 @@ gst_parse_context_free (GstParseContext * context) * of %GST_PARSE_ERROR_NO_SUCH_ELEMENT was returned. * * Returns: (transfer full) (array zero-terminated=1) (element-type gchar*): a - * NULL-terminated array of element factory name strings of missing + * %NULL-terminated array of element factory name strings of missing * elements. Free with g_strfreev() when no longer needed. */ gchar ** diff --git a/gst/gstparse.h b/gst/gstparse.h index 578fead2f..b1ec83d8a 100644 --- a/gst/gstparse.h +++ b/gst/gstparse.h @@ -61,7 +61,7 @@ typedef enum /** * GstParseFlags: * @GST_PARSE_FLAG_NONE: Do not use any special parsing options. - * @GST_PARSE_FLAG_FATAL_ERRORS: Always return NULL when an error occurs + * @GST_PARSE_FLAG_FATAL_ERRORS: Always return %NULL when an error occurs * (default behaviour is to return partially constructed bins or elements * in some cases) * @GST_PARSE_FLAG_NO_SINGLE_ELEMENT_BINS: If a bin only has a single element, diff --git a/gst/gstpipeline.c b/gst/gstpipeline.c index 63120e5f3..21e0620fa 100644 --- a/gst/gstpipeline.c +++ b/gst/gstpipeline.c @@ -652,7 +652,7 @@ gst_pipeline_get_clock (GstPipeline * pipeline) * always use the given clock even if new clock providers are added * to this pipeline. * - * If @clock is NULL all clocking will be disabled which will make + * If @clock is %NULL all clocking will be disabled which will make * the pipeline run as fast as possible. * * MT safe. @@ -683,7 +683,7 @@ gst_pipeline_use_clock (GstPipeline * pipeline, GstClock * clock) * Set the clock for @pipeline. The clock will be distributed * to all the elements managed by the pipeline. * - * Returns: TRUE if the clock could be set on the pipeline. FALSE if + * Returns: %TRUE if the clock could be set on the pipeline. %FALSE if * some element did not accept the clock. * * MT safe. diff --git a/gst/gstplugin.c b/gst/gstplugin.c index 6251b147f..9bfacc14f 100644 --- a/gst/gstplugin.c +++ b/gst/gstplugin.c @@ -193,7 +193,7 @@ gst_plugin_error_quark (void) * You must make sure that GStreamer has been initialised (with gst_init() or * via gst_init_get_option_group()) before calling this function. * - * Returns: TRUE if the plugin was registered correctly, otherwise FALSE. + * Returns: %TRUE if the plugin was registered correctly, otherwise %FALSE. */ gboolean gst_plugin_register_static (gint major_version, gint minor_version, @@ -258,7 +258,7 @@ gst_plugin_register_static (gint major_version, gint minor_version, * You must make sure that GStreamer has been initialised (with gst_init() or * via gst_init_get_option_group()) before calling this function. * - * Returns: TRUE if the plugin was registered correctly, otherwise FALSE. + * Returns: %TRUE if the plugin was registered correctly, otherwise %FALSE. */ gboolean gst_plugin_register_static_full (gint major_version, gint minor_version, @@ -666,12 +666,12 @@ static GMutex gst_plugin_loading_mutex; /** * gst_plugin_load_file: * @filename: the plugin filename to load - * @error: pointer to a NULL-valued GError + * @error: pointer to a %NULL-valued GError * * Loads the given plugin and refs it. Caller needs to unref after use. * * Returns: (transfer full): a reference to the existing loaded GstPlugin, a - * reference to the newly-loaded GstPlugin, or NULL if an error occurred. + * reference to the newly-loaded GstPlugin, or %NULL if an error occurred. */ GstPlugin * gst_plugin_load_file (const gchar * filename, GError ** error) @@ -1022,7 +1022,7 @@ gst_plugin_get_release_date_string (GstPlugin * plugin) * * queries if the plugin is loaded into memory * - * Returns: TRUE is loaded, FALSE otherwise + * Returns: %TRUE is loaded, %FALSE otherwise */ gboolean gst_plugin_is_loaded (GstPlugin * plugin) @@ -1165,7 +1165,7 @@ gst_plugin_list_feature_filter (GList * list, * * Find a feature of the given name and type in the given plugin. * - * Returns: a GstPluginFeature or NULL if the feature was not found. + * Returns: a GstPluginFeature or %NULL if the feature was not found. */ GstPluginFeature * gst_plugin_find_feature (GstPlugin * plugin, const gchar * name, GType type) @@ -1209,7 +1209,7 @@ gst_plugin_feature_name_filter (GstPluginFeature * feature, const gchar * name) * * Find a feature of the given name in the given plugin. * - * Returns: a GstPluginFeature or NULL if the feature was not found. + * Returns: a GstPluginFeature or %NULL if the feature was not found. */ GstPluginFeature * gst_plugin_find_feature_by_name (GstPlugin * plugin, const gchar * name) @@ -1239,7 +1239,7 @@ gst_plugin_find_feature_by_name (GstPlugin * plugin, const gchar * name) * * Load the named plugin. Refs the plugin. * - * Returns: (transfer full): a reference to a loaded plugin, or NULL on error. + * Returns: (transfer full): a reference to a loaded plugin, or %NULL on error. */ GstPlugin * gst_plugin_load_by_name (const gchar * name) @@ -1282,7 +1282,7 @@ gst_plugin_load_by_name (const gchar * name) * plugin = loaded_plugin; * </programlisting> * - * Returns: (transfer full): a reference to a loaded plugin, or NULL on error. + * Returns: (transfer full): a reference to a loaded plugin, or %NULL on error. */ GstPlugin * gst_plugin_load (GstPlugin * plugin) @@ -1711,18 +1711,18 @@ gst_plugin_ext_dep_equals (GstPluginDep * dep, const gchar ** env_vars, /** * gst_plugin_add_dependency: * @plugin: a #GstPlugin - * @env_vars: (allow-none): NULL-terminated array of environment variables affecting the + * @env_vars: (allow-none): %NULL-terminated array of environment variables affecting the * feature set of the plugin (e.g. an environment variable containing * paths where to look for additional modules/plugins of a library), - * or NULL. Environment variable names may be followed by a path component + * or %NULL. Environment variable names may be followed by a path component * which will be added to the content of the environment variable, e.g. * "HOME/.mystuff/plugins". - * @paths: (allow-none): NULL-terminated array of directories/paths where dependent files - * may be, or NULL. - * @names: (allow-none): NULL-terminated array of file names (or file name suffixes, + * @paths: (allow-none): %NULL-terminated array of directories/paths where dependent files + * may be, or %NULL. + * @names: (allow-none): %NULL-terminated array of file names (or file name suffixes, * depending on @flags) to be used in combination with the paths from * @paths and/or the paths extracted from the environment variables in - * @env_vars, or NULL. + * @env_vars, or %NULL. * @flags: optional flags, or #GST_PLUGIN_DEPENDENCY_FLAG_NONE * * Make GStreamer aware of external dependencies which affect the feature @@ -1783,13 +1783,13 @@ gst_plugin_add_dependency (GstPlugin * plugin, const gchar ** env_vars, * gst_plugin_add_dependency_simple: * @plugin: the #GstPlugin * @env_vars: (allow-none): one or more environment variables (separated by ':', ';' or ','), - * or NULL. Environment variable names may be followed by a path component + * or %NULL. Environment variable names may be followed by a path component * which will be added to the content of the environment variable, e.g. * "HOME/.mystuff/plugins:MYSTUFF_PLUGINS_PATH" * @paths: (allow-none): one ore more directory paths (separated by ':' or ';' or ','), - * or NULL. Example: "/usr/lib/mystuff/plugins" + * or %NULL. Example: "/usr/lib/mystuff/plugins" * @names: (allow-none): one or more file names or file name suffixes (separated by commas), - * or NULL + * or %NULL * @flags: optional flags, or #GST_PLUGIN_DEPENDENCY_FLAG_NONE * * Make GStreamer aware of external dependencies which affect the feature diff --git a/gst/gstplugin.h b/gst/gstplugin.h index 64f80986e..500be30de 100644 --- a/gst/gstplugin.h +++ b/gst/gstplugin.h @@ -146,7 +146,7 @@ typedef gboolean (*GstPluginInitFullFunc) (GstPlugin *plugin, gpointer user_data * @package: shipped package plugin belongs to * @origin: URL to provider of plugin * @release_datetime: date time string in ISO 8601 format (or rather, a - * subset thereof), or NULL. Allowed are the following formats: + * subset thereof), or %NULL. Allowed are the following formats: * "YYYY-MM-DD" and "YYY-MM-DDTHH:MMZ" (with 'T' a separator and 'Z' * indicating UTC/Zulu time). This field should be set via the * GST_PACKAGE_RELEASE_DATETIME preprocessor macro. @@ -291,7 +291,7 @@ G_END_DECLS * A function that can be used with e.g. gst_registry_plugin_filter() * to get a list of plugins that match certain criteria. * - * Returns: TRUE for a positive match, FALSE otherwise + * Returns: %TRUE for a positive match, %FALSE otherwise */ typedef gboolean (*GstPluginFilter) (GstPlugin *plugin, gpointer user_data); diff --git a/gst/gstpluginfeature.c b/gst/gstpluginfeature.c index 27debb4d8..6672f7bc7 100644 --- a/gst/gstpluginfeature.c +++ b/gst/gstpluginfeature.c @@ -90,7 +90,7 @@ gst_plugin_feature_finalize (GObject * object) * feature = loaded_feature; * ]| * - * Returns: (transfer full): a reference to the loaded feature, or NULL on error + * Returns: (transfer full): a reference to the loaded feature, or %NULL on error */ GstPluginFeature * gst_plugin_feature_load (GstPluginFeature * feature) @@ -307,8 +307,8 @@ gst_plugin_feature_list_debug (GList * list) * Checks whether the given plugin feature is at least * the required version * - * Returns: #TRUE if the plugin feature has at least - * the required version, otherwise #FALSE. + * Returns: %TRUE if the plugin feature has at least + * the required version, otherwise %FALSE. */ gboolean gst_plugin_feature_check_version (GstPluginFeature * feature, diff --git a/gst/gstpluginfeature.h b/gst/gstpluginfeature.h index ca9f0d3ec..bc0196919 100644 --- a/gst/gstpluginfeature.h +++ b/gst/gstpluginfeature.h @@ -73,7 +73,7 @@ typedef enum { * @feature: a #GstPluginFeature to get the name of @feature. * * Returns the name of @feature. - * For a nameless plugin feature, this returns NULL. + * For a nameless plugin feature, this returns %NULL. * * Returns: (transfer none): the name of @feature. MT safe. * diff --git a/gst/gstpreset.c b/gst/gstpreset.c index b1b672039..19f0fbb1f 100644 --- a/gst/gstpreset.c +++ b/gst/gstpreset.c @@ -956,7 +956,7 @@ no_presets: * gst_preset_get_preset_names: * @preset: a #GObject that implements #GstPreset * - * Get a copy of preset names as a NULL terminated string array. + * Get a copy of preset names as a %NULL terminated string array. * * Returns: (transfer full) (array zero-terminated=1) (element-type gchar*): * list with names, use g_strfreev() after usage. diff --git a/gst/gstquery.c b/gst/gstquery.c index adce934cf..076b8dca9 100644 --- a/gst/gstquery.c +++ b/gst/gstquery.c @@ -268,11 +268,11 @@ gst_query_set_position (GstQuery * query, GstFormat format, gint64 cur) * gst_query_parse_position: * @query: a #GstQuery * @format: (out) (allow-none): the storage for the #GstFormat of the - * position values (may be NULL) - * @cur: (out) (allow-none): the storage for the current position (may be NULL) + * position values (may be %NULL) + * @cur: (out) (allow-none): the storage for the current position (may be %NULL) * * Parse a position query, writing the format into @format, and the position - * into @cur, if the respective parameters are non-NULL. + * into @cur, if the respective parameters are non-%NULL. */ void gst_query_parse_position (GstQuery * query, GstFormat * format, gint64 * cur) @@ -345,11 +345,11 @@ gst_query_set_duration (GstQuery * query, GstFormat format, gint64 duration) * gst_query_parse_duration: * @query: a #GstQuery * @format: (out) (allow-none): the storage for the #GstFormat of the duration - * value, or NULL. - * @duration: (out) (allow-none): the storage for the total duration, or NULL. + * value, or %NULL. + * @duration: (out) (allow-none): the storage for the total duration, or %NULL. * * Parse a duration query answer. Write the format of the duration into @format, - * and the value into @duration, if the respective variables are non-NULL. + * and the value into @duration, if the respective variables are non-%NULL. */ void gst_query_parse_duration (GstQuery * query, GstFormat * format, @@ -424,9 +424,9 @@ gst_query_set_latency (GstQuery * query, gboolean live, /** * gst_query_parse_latency: * @query: a #GstQuery - * @live: (out) (allow-none): storage for live or NULL - * @min_latency: (out) (allow-none): the storage for the min latency or NULL - * @max_latency: (out) (allow-none): the storage for the max latency or NULL + * @live: (out) (allow-none): storage for live or %NULL + * @min_latency: (out) (allow-none): the storage for the min latency or %NULL + * @max_latency: (out) (allow-none): the storage for the max latency or %NULL * * Parse a latency query answer. */ @@ -513,15 +513,15 @@ gst_query_set_convert (GstQuery * query, GstFormat src_format, gint64 src_value, * gst_query_parse_convert: * @query: a #GstQuery * @src_format: (out) (allow-none): the storage for the #GstFormat of the - * source value, or NULL - * @src_value: (out) (allow-none): the storage for the source value, or NULL + * source value, or %NULL + * @src_value: (out) (allow-none): the storage for the source value, or %NULL * @dest_format: (out) (allow-none): the storage for the #GstFormat of the - * destination value, or NULL + * destination value, or %NULL * @dest_value: (out) (allow-none): the storage for the destination value, - * or NULL + * or %NULL * * Parse a convert query answer. Any of @src_format, @src_value, @dest_format, - * and @dest_value may be NULL, in which case that value is omitted. + * and @dest_value may be %NULL, in which case that value is omitted. */ void gst_query_parse_convert (GstQuery * query, GstFormat * src_format, @@ -616,14 +616,14 @@ gst_query_set_segment (GstQuery * query, gdouble rate, GstFormat format, /** * gst_query_parse_segment: * @query: a #GstQuery - * @rate: (out) (allow-none): the storage for the rate of the segment, or NULL + * @rate: (out) (allow-none): the storage for the rate of the segment, or %NULL * @format: (out) (allow-none): the storage for the #GstFormat of the values, - * or NULL - * @start_value: (out) (allow-none): the storage for the start value, or NULL - * @stop_value: (out) (allow-none): the storage for the stop value, or NULL + * or %NULL + * @start_value: (out) (allow-none): the storage for the start value, or %NULL + * @stop_value: (out) (allow-none): the storage for the stop value, or %NULL * * Parse a segment query answer. Any of @rate, @format, @start_value, and - * @stop_value may be NULL, which will cause this value to be omitted. + * @stop_value may be %NULL, which will cause this value to be omitted. * * See gst_query_set_segment() for an explanation of the function arguments. */ @@ -794,14 +794,14 @@ gst_query_set_seeking (GstQuery * query, GstFormat format, * gst_query_parse_seeking: * @query: a GST_QUERY_SEEKING type query #GstQuery * @format: (out) (allow-none): the format to set for the @segment_start - * and @segment_end values, or NULL - * @seekable: (out) (allow-none): the seekable flag to set, or NULL - * @segment_start: (out) (allow-none): the segment_start to set, or NULL - * @segment_end: (out) (allow-none): the segment_end to set, or NULL + * and @segment_end values, or %NULL + * @seekable: (out) (allow-none): the seekable flag to set, or %NULL + * @segment_start: (out) (allow-none): the segment_start to set, or %NULL + * @segment_end: (out) (allow-none): the segment_end to set, or %NULL * * Parse a seeking query, writing the format into @format, and * other results into the passed parameters, if the respective parameters - * are non-NULL + * are non-%NULL */ void gst_query_parse_seeking (GstQuery * query, GstFormat * format, @@ -1074,8 +1074,8 @@ gst_query_set_buffering_percent (GstQuery * query, gboolean busy, gint percent) /** * gst_query_parse_buffering_percent: * @query: A valid #GstQuery of type GST_QUERY_BUFFERING. - * @busy: (out) (allow-none): if buffering is busy, or NULL - * @percent: (out) (allow-none): a buffering percent, or NULL + * @busy: (out) (allow-none): if buffering is busy, or %NULL + * @percent: (out) (allow-none): a buffering percent, or %NULL * * Get the percentage of buffered data. This is a value between 0 and 100. * The @busy indicator is %TRUE when the buffering is in progress. @@ -1127,11 +1127,11 @@ gst_query_set_buffering_stats (GstQuery * query, GstBufferingMode mode, /** * gst_query_parse_buffering_stats: * @query: A valid #GstQuery of type GST_QUERY_BUFFERING. - * @mode: (out) (allow-none): a buffering mode, or NULL - * @avg_in: (out) (allow-none): the average input rate, or NULL - * @avg_out: (out) (allow-none): the average output rat, or NULL + * @mode: (out) (allow-none): a buffering mode, or %NULL + * @avg_in: (out) (allow-none): the average input rate, or %NULL + * @avg_out: (out) (allow-none): the average output rat, or %NULL * @buffering_left: (out) (allow-none): amount of buffering time left in - * milliseconds, or NULL + * milliseconds, or %NULL * * Extracts the buffering stats values from @query. */ @@ -1193,15 +1193,15 @@ gst_query_set_buffering_range (GstQuery * query, GstFormat format, * gst_query_parse_buffering_range: * @query: a GST_QUERY_BUFFERING type query #GstQuery * @format: (out) (allow-none): the format to set for the @segment_start - * and @segment_end values, or NULL - * @start: (out) (allow-none): the start to set, or NULL - * @stop: (out) (allow-none): the stop to set, or NULL + * and @segment_end values, or %NULL + * @start: (out) (allow-none): the start to set, or %NULL + * @stop: (out) (allow-none): the stop to set, or %NULL * @estimated_total: (out) (allow-none): estimated total amount of download - * time remaining in milliseconds, or NULL + * time remaining in milliseconds, or %NULL * * Parse an available query, writing the format into @format, and * other results into the passed parameters, if the respective parameters - * are non-NULL + * are non-%NULL */ void gst_query_parse_buffering_range (GstQuery * query, GstFormat * format, @@ -1308,8 +1308,8 @@ gst_query_get_n_buffering_ranges (GstQuery * query) * gst_query_parse_nth_buffering_range: * @query: a GST_QUERY_BUFFERING type query #GstQuery * @index: position in the buffered-ranges array to read - * @start: (out) (allow-none): the start position to set, or NULL - * @stop: (out) (allow-none): the stop position to set, or NULL + * @start: (out) (allow-none): the start position to set, or %NULL + * @stop: (out) (allow-none): the stop position to set, or %NULL * * Parse an available query and get the start and stop values stored * at the @index of the buffered ranges array. @@ -1392,10 +1392,10 @@ gst_query_set_uri (GstQuery * query, const gchar * uri) * gst_query_parse_uri: * @query: a #GstQuery * @uri: (out) (transfer full) (allow-none): the storage for the current URI - * (may be NULL) + * (may be %NULL) * * Parse an URI query, writing the URI into @uri as a newly - * allocated string, if the respective parameters are non-NULL. + * allocated string, if the respective parameters are non-%NULL. * Free the string with g_free() after usage. */ void @@ -1438,10 +1438,10 @@ gst_query_set_uri_redirection (GstQuery * query, const gchar * uri) * gst_query_parse_uri_redirection: * @query: a #GstQuery * @uri: (out) (transfer full) (allow-none): the storage for the redirect URI - * (may be NULL) + * (may be %NULL) * * Parse an URI query, writing the URI into @uri as a newly - * allocated string, if the respective parameters are non-NULL. + * allocated string, if the respective parameters are non-%NULL. * Free the string with g_free() after usage. * * Since: 1.2 @@ -1488,7 +1488,7 @@ gst_query_set_uri_redirection_permanent (GstQuery * query, gboolean permanent) * gst_query_parse_uri_redirection_permanent: * @query: a #GstQuery * @permanent: (out) (allow-none): if the URI redirection is permanent - * (may be NULL) + * (may be %NULL) * * Parse an URI query, and set @permanent to %TRUE if there is a redirection * and it should be considered permanent. If a redirection is permanent, @@ -1547,7 +1547,7 @@ gst_query_new_allocation (GstCaps * caps, gboolean need_pool) * * Parse an allocation query, writing the requested caps in @caps and * whether a pool is needed in @need_pool, if the respective parameters - * are non-NULL. + * are non-%NULL. */ void gst_query_parse_allocation (GstQuery * query, GstCaps ** caps, @@ -1883,11 +1883,11 @@ gst_query_remove_nth_allocation_meta (GstQuery * query, guint index) * @api: the metadata API * @index: (out) (transfer none) (allow-none): the index * - * Check if @query has metadata @api set. When this function returns TRUE, + * Check if @query has metadata @api set. When this function returns %TRUE, * @index will contain the index where the requested API and the flags can be * found. * - * Returns: TRUE when @api is in the list of metadata. + * Returns: %TRUE when @api is in the list of metadata. */ gboolean gst_query_find_allocation_meta (GstQuery * query, GType api, guint * index) @@ -2260,7 +2260,7 @@ gst_query_parse_nth_scheduling_mode (GstQuery * query, guint index) * </para> * </note> * - * Returns: TRUE when @mode is in the list of scheduling modes. + * Returns: %TRUE when @mode is in the list of scheduling modes. */ gboolean gst_query_has_scheduling_mode (GstQuery * query, GstPadMode mode) @@ -2292,7 +2292,7 @@ gst_query_has_scheduling_mode (GstQuery * query, GstPadMode mode) * Check if @query has scheduling mode set and @flags is set in * query scheduling flags. * - * Returns: TRUE when @mode is in the list of scheduling modes + * Returns: %TRUE when @mode is in the list of scheduling modes * and @flags are compatible with query flags. */ gboolean @@ -2616,7 +2616,7 @@ gst_query_parse_context (GstQuery * query, GstContext ** context) /** * gst_query_parse_context_type: * @query: a GST_QUERY_CONTEXT type query - * @context_type: (out) (transfer none) (allow-none): the context type, or NULL + * @context_type: (out) (transfer none) (allow-none): the context type, or %NULL * * Parse a context type from an existing GST_QUERY_CONTEXT query. * diff --git a/gst/gstquery.h b/gst/gstquery.h index 58e53f411..cee72b254 100644 --- a/gst/gstquery.h +++ b/gst/gstquery.h @@ -284,9 +284,9 @@ gst_query_copy (const GstQuery * q) * in some cases), and the reference counts are updated appropriately (the old * query is unreffed, the new one is reffed). * - * Either @new_query or the #GstQuery pointed to by @old_query may be NULL. + * Either @new_query or the #GstQuery pointed to by @old_query may be %NULL. * - * Returns: TRUE if @new_query was different from @old_query + * Returns: %TRUE if @new_query was different from @old_query */ #ifdef _FOOL_GTK_DOC_ G_INLINE_FUNC gboolean gst_query_replace (GstQuery **old_query, GstQuery *new_query); diff --git a/gst/gstregistry.c b/gst/gstregistry.c index cb5af83f2..2838737ee 100644 --- a/gst/gstregistry.c +++ b/gst/gstregistry.c @@ -430,7 +430,7 @@ gst_registry_get_path_list (GstRegistry * registry) * Add the plugin to the registry. The plugin-added signal will be emitted. * This function will sink @plugin. * - * Returns: TRUE on success. + * Returns: %TRUE on success. * * MT safe. */ @@ -556,7 +556,7 @@ gst_registry_remove_plugin (GstRegistry * registry, GstPlugin * plugin) * Add the feature to the registry. The feature-added signal will be emitted. * This function sinks @feature. * - * Returns: TRUE on success. + * Returns: %TRUE on success. * * MT safe. */ @@ -801,8 +801,8 @@ gst_registry_get_device_monitor_factory_list (GstRegistry * registry) /* Return reffed copy */ list = - gst_plugin_feature_list_copy (registry->priv-> - device_monitor_factory_list); + gst_plugin_feature_list_copy (registry-> + priv->device_monitor_factory_list); GST_OBJECT_UNLOCK (registry); @@ -868,7 +868,7 @@ gst_registry_plugin_name_filter (GstPlugin * plugin, const gchar * name) * Find the plugin with the given name in the registry. * The plugin will be reffed; caller is responsible for unreffing. * - * Returns: (transfer full): the plugin with the given name or NULL if the + * Returns: (transfer full): the plugin with the given name or %NULL if the * plugin was not found. gst_object_unref() after usage. * * MT safe. @@ -903,7 +903,7 @@ gst_registry_find_plugin (GstRegistry * registry, const gchar * name) * Find the pluginfeature with the given name and type in the registry. * * Returns: (transfer full): the pluginfeature with the given name and type - * or NULL if the plugin was not found. gst_object_unref() after usage. + * or %NULL if the plugin was not found. gst_object_unref() after usage. * * MT safe. */ @@ -1055,7 +1055,7 @@ gst_registry_lookup_bn (GstRegistry * registry, const char *basename) * Look up a plugin in the given registry with the given filename. * If found, plugin is reffed. * - * Returns: (transfer full): the #GstPlugin if found, or NULL if not. + * Returns: (transfer full): the #GstPlugin if found, or %NULL if not. * gst_object_unref() after usage. */ GstPlugin * @@ -1452,8 +1452,8 @@ _priv_gst_registry_cleanup (void) * @registry and whether its version is at least the * version required. * - * Returns: #TRUE if the feature could be found and the version is - * the same as the required version or newer, and #FALSE otherwise. + * Returns: %TRUE if the feature could be found and the version is + * the same as the required version or newer, and %FALSE otherwise. */ gboolean gst_registry_check_feature_version (GstRegistry * registry, @@ -1508,7 +1508,7 @@ load_plugin_func (gpointer data, gpointer user_data) #ifndef GST_DISABLE_REGISTRY /* Unref all plugins marked 'cached', to clear old plugins that no - * longer exist. Returns TRUE if any plugins were removed */ + * longer exist. Returns %TRUE if any plugins were removed */ static gboolean gst_registry_remove_cache_plugins (GstRegistry * registry) { @@ -1640,14 +1640,11 @@ scan_and_update_registry (GstRegistry * default_registry, g_win32_get_package_installation_directory_of_module (_priv_gst_dll_handle); - dir = - g_build_filename (base_dir, + dir = g_build_filename (base_dir, #ifdef _DEBUG - "debug" + "debug" #endif - "lib", - "gstreamer-" GST_API_VERSION, - NULL); + "lib", "gstreamer-" GST_API_VERSION, NULL); GST_DEBUG ("scanning DLL dir %s", dir); changed |= gst_registry_scan_path_internal (&context, dir); diff --git a/gst/gstsample.c b/gst/gstsample.c index 8bdde7d7c..76b76bd98 100644 --- a/gst/gstsample.c +++ b/gst/gstsample.c @@ -85,10 +85,10 @@ _gst_sample_free (GstSample * sample) /** * gst_sample_new: - * @buffer: (transfer none) (allow-none): a #GstBuffer, or NULL - * @caps: (transfer none) (allow-none): a #GstCaps, or NULL - * @segment: (transfer none) (allow-none): a #GstSegment, or NULL - * @info: (transfer full) (allow-none): a #GstStructure, or NULL + * @buffer: (transfer none) (allow-none): a #GstBuffer, or %NULL + * @caps: (transfer none) (allow-none): a #GstCaps, or %NULL + * @segment: (transfer none) (allow-none): a #GstSegment, or %NULL + * @info: (transfer full) (allow-none): a #GstStructure, or %NULL * * Create a new #GstSample with the provided details. * @@ -143,7 +143,7 @@ had_parent: * * Get the buffer associated with @sample * - * Returns: (transfer none): the buffer of @sample or NULL when there + * Returns: (transfer none): the buffer of @sample or %NULL when there * is no buffer. The buffer remains valid as long as @sample is valid. * If you need to hold on to it for longer than that, take a ref to * the buffer with gst_buffer_ref(). @@ -162,7 +162,7 @@ gst_sample_get_buffer (GstSample * sample) * * Get the caps associated with @sample * - * Returns: (transfer none): the caps of @sample or NULL when there + * Returns: (transfer none): the caps of @sample or %NULL when there * is no caps. The caps remain valid as long as @sample is valid. * If you need to hold on to the caps for longer than that, take a ref to * the caps with gst_caps_ref(). diff --git a/gst/gstsegment.c b/gst/gstsegment.c index 241b3a77f..3c4081b60 100644 --- a/gst/gstsegment.c +++ b/gst/gstsegment.c @@ -216,8 +216,8 @@ gst_segment_init (GstSegment * segment, GstFormat format) * If the caller can apply a rate change, it should update @segment * rate and applied_rate after calling this function. * - * @update will be set to TRUE if a seek should be performed to the segment - * position field. This field can be FALSE if, for example, only the @rate + * @update will be set to %TRUE if a seek should be performed to the segment + * position field. This field can be %FALSE if, for example, only the @rate * has been changed but not the playback position. * * Returns: %TRUE if the seek could be performed. @@ -551,18 +551,18 @@ gst_segment_to_running_time (const GstSegment * segment, GstFormat format, * in @segment. @start and @stop are compared and clipped to @segment * start and stop values. * - * If the function returns FALSE, @start and @stop are known to fall + * If the function returns %FALSE, @start and @stop are known to fall * outside of @segment and @clip_start and @clip_stop are not updated. * - * When the function returns TRUE, @clip_start and @clip_stop will be + * When the function returns %TRUE, @clip_start and @clip_stop will be * updated. If @clip_start or @clip_stop are different from @start or @stop * respectively, the region fell partially in the segment. * * Note that when @stop is -1, @clip_stop will be set to the end of the * segment. Depending on the use case, this may or may not be what you want. * - * Returns: TRUE if the given @start and @stop times fall partially or - * completely in @segment, FALSE if the values are completely outside + * Returns: %TRUE if the given @start and @stop times fall partially or + * completely in @segment, %FALSE if the values are completely outside * of the segment. */ gboolean diff --git a/gst/gststructure.c b/gst/gststructure.c index 36fb0116e..9930629f8 100644 --- a/gst/gststructure.c +++ b/gst/gststructure.c @@ -51,7 +51,7 @@ * gst_structure_remove_fields(). * * Strings in structures must be ASCII or UTF-8 encoded. Other encodings are - * not allowed. Strings may be NULL however. + * not allowed. Strings may be %NULL however. * * Be aware that the current #GstCaps / #GstStructure serialization into string * has limited support for nested #GstCaps / #GstStructure fields. It can only @@ -237,7 +237,7 @@ gst_structure_new_empty (const gchar * name) * Creates a new #GstStructure with the given name. Parses the * list of variable arguments and sets fields to the values listed. * Variable arguments should be passed as field name, field type, - * and value. Last variable argument should be NULL. + * and value. Last variable argument should be %NULL. * * Free-function: gst_structure_free * @@ -415,7 +415,7 @@ gst_structure_get_name (const GstStructure * structure) * * Checks if the structure has the given name * - * Returns: TRUE if @name matches the name of the structure. + * Returns: %TRUE if @name matches the name of the structure. */ gboolean gst_structure_has_name (const GstStructure * structure, const gchar * name) @@ -621,7 +621,7 @@ gst_structure_set_valist_internal (GstStructure * structure, * * Parses the variable arguments and sets fields accordingly. * Variable arguments should be in the form field name, field type - * (as a GType), value(s). The last variable argument should be NULL. + * (as a GType), value(s). The last variable argument should be %NULL. */ void gst_structure_set (GstStructure * structure, const gchar * field, ...) @@ -694,7 +694,7 @@ gst_structure_id_set_valist_internal (GstStructure * structure, * passed using the GQuark for the field name. This allows more efficient * setting of the structure if the caller already knows the associated * quark values. - * The last variable argument must be NULL. + * The last variable argument must be %NULL. */ void gst_structure_id_set (GstStructure * structure, GQuark field, ...) @@ -737,7 +737,7 @@ gst_structure_id_set_valist (GstStructure * structure, * gst_structure_id_set(). Basically a convenience wrapper around * gst_structure_new_id_empty() and gst_structure_id_set(). * - * The last variable argument must be NULL (or 0). + * The last variable argument must be %NULL (or 0). * * Free-function: gst_structure_free * @@ -960,7 +960,7 @@ gst_structure_remove_field (GstStructure * structure, const gchar * fieldname) * gst_structure_remove_fields: * @structure: a #GstStructure * @fieldname: the name of the field to remove - * @...: NULL-terminated list of more fieldnames to remove + * @...: %NULL-terminated list of more fieldnames to remove * * Removes the fields with the given names. If a field does not exist, the * argument is ignored. @@ -984,7 +984,7 @@ gst_structure_remove_fields (GstStructure * structure, * gst_structure_remove_fields_valist: * @structure: a #GstStructure * @fieldname: the name of the field to remove - * @varargs: NULL-terminated list of more fieldnames to remove + * @varargs: %NULL-terminated list of more fieldnames to remove * * va_list form of gst_structure_remove_fields(). */ @@ -1104,8 +1104,8 @@ gst_structure_nth_field_name (const GstStructure * structure, guint index) * Calls the provided function once for each field in the #GstStructure. The * function must not modify the fields. Also see gst_structure_map_in_place(). * - * Returns: TRUE if the supplied function returns TRUE For each of the fields, - * FALSE otherwise. + * Returns: %TRUE if the supplied function returns %TRUE For each of the fields, + * %FALSE otherwise. */ gboolean gst_structure_foreach (const GstStructure * structure, @@ -1141,8 +1141,8 @@ gst_structure_foreach (const GstStructure * structure, * contrast to gst_structure_foreach(), the function may modify but not delete the * fields. The structure must be mutable. * - * Returns: TRUE if the supplied function returns TRUE For each of the fields, - * FALSE otherwise. + * Returns: %TRUE if the supplied function returns %TRUE For each of the fields, + * %FALSE otherwise. */ gboolean gst_structure_map_in_place (GstStructure * structure, @@ -1175,7 +1175,7 @@ gst_structure_map_in_place (GstStructure * structure, * * Check if @structure contains a field named @field. * - * Returns: TRUE if the structure contains a field with the given name + * Returns: %TRUE if the structure contains a field with the given name */ gboolean gst_structure_id_has_field (const GstStructure * structure, GQuark field) @@ -1197,7 +1197,7 @@ gst_structure_id_has_field (const GstStructure * structure, GQuark field) * * Check if @structure contains a field named @fieldname. * - * Returns: TRUE if the structure contains a field with the given name + * Returns: %TRUE if the structure contains a field with the given name */ gboolean gst_structure_has_field (const GstStructure * structure, @@ -1218,7 +1218,7 @@ gst_structure_has_field (const GstStructure * structure, * * Check if @structure contains a field named @field and with GType @type. * - * Returns: TRUE if the structure contains a field with the given name and type + * Returns: %TRUE if the structure contains a field with the given name and type */ gboolean gst_structure_id_has_field_typed (const GstStructure * structure, @@ -1244,7 +1244,7 @@ gst_structure_id_has_field_typed (const GstStructure * structure, * * Check if @structure contains a field named @fieldname and with GType @type. * - * Returns: TRUE if the structure contains a field with the given name and type + * Returns: %TRUE if the structure contains a field with the given name and type */ gboolean gst_structure_has_field_typed (const GstStructure * structure, @@ -1269,9 +1269,9 @@ gst_structure_has_field_typed (const GstStructure * structure, * given field. Caller is responsible for making sure the field exists * and has the correct type. * - * Returns: TRUE if the value could be set correctly. If there was no field + * Returns: %TRUE if the value could be set correctly. If there was no field * with @fieldname or the existing field did not contain a boolean, this - * function returns FALSE. + * function returns %FALSE. */ gboolean gst_structure_get_boolean (const GstStructure * structure, @@ -1457,9 +1457,9 @@ gst_structure_get_uint64 (const GstStructure * structure, * inconsistent with e.g. gst_structure_get_string() which doesn't return a * copy of the string). * - * Returns: TRUE if the value could be set correctly. If there was no field + * Returns: %TRUE if the value could be set correctly. If there was no field * with @fieldname or the existing field did not contain a data, this function - * returns FALSE. + * returns %FALSE. */ gboolean gst_structure_get_date (const GstStructure * structure, const gchar * fieldname, @@ -1499,9 +1499,9 @@ gst_structure_get_date (const GstStructure * structure, const gchar * fieldname, * (note: this is inconsistent with e.g. gst_structure_get_string() * which doesn't return a copy of the string). * - * Returns: TRUE if the value could be set correctly. If there was no field + * Returns: %TRUE if the value could be set correctly. If there was no field * with @fieldname or the existing field did not contain a data, this function - * returns FALSE. + * returns %FALSE. */ gboolean gst_structure_get_date_time (const GstStructure * structure, @@ -1536,9 +1536,9 @@ gst_structure_get_date_time (const GstStructure * structure, * of the given field. Caller is responsible for making sure the field exists * and has the correct type. * - * Returns: TRUE if the value could be set correctly. If there was no field + * Returns: %TRUE if the value could be set correctly. If there was no field * with @fieldname or the existing field did not contain a #GstClockTime, this - * function returns FALSE. + * function returns %FALSE. */ gboolean gst_structure_get_clock_time (const GstStructure * structure, @@ -1557,9 +1557,9 @@ gst_structure_get_clock_time (const GstStructure * structure, * given field. Caller is responsible for making sure the field exists * and has the correct type. * - * Returns: TRUE if the value could be set correctly. If there was no field + * Returns: %TRUE if the value could be set correctly. If there was no field * with @fieldname or the existing field did not contain a double, this - * function returns FALSE. + * function returns %FALSE. */ gboolean gst_structure_get_double (const GstStructure * structure, @@ -1595,7 +1595,7 @@ gst_structure_get_double (const GstStructure * structure, * The string should not be modified, and remains valid until the next * call to a gst_structure_*() function with the given structure. * - * Returns: a pointer to the string or NULL when the field did not exist + * Returns: a pointer to the string or %NULL when the field did not exist * or did not contain a string. */ const gchar * @@ -1628,9 +1628,9 @@ gst_structure_get_string (const GstStructure * structure, * given field. Caller is responsible for making sure the field exists, * has the correct type and that the enumtype is correct. * - * Returns: TRUE if the value could be set correctly. If there was no field + * Returns: %TRUE if the value could be set correctly. If there was no field * with @fieldname or the existing field did not contain an enum of the given - * type, this function returns FALSE. + * type, this function returns %FALSE. */ gboolean gst_structure_get_enum (const GstStructure * structure, @@ -1666,9 +1666,9 @@ gst_structure_get_enum (const GstStructure * structure, * corresponding to the value of the given field. Caller is responsible * for making sure the field exists and has the correct type. * - * Returns: TRUE if the values could be set correctly. If there was no field + * Returns: %TRUE if the values could be set correctly. If there was no field * with @fieldname or the existing field did not contain a GstFraction, this - * function returns FALSE. + * function returns %FALSE. */ gboolean gst_structure_get_fraction (const GstStructure * structure, @@ -2380,7 +2380,7 @@ priv_gst_structure_parse_fields (gchar * str, gchar ** end, * @string: a string representation of a #GstStructure * * Creates a #GstStructure from a string representation. - * If end is not NULL, a pointer to the place inside the given string + * If end is not %NULL, a pointer to the place inside the given string * where parsing ended will be returned. * * The current implementation of serialization will lead to unexpected results @@ -2388,7 +2388,7 @@ priv_gst_structure_parse_fields (gchar * str, gchar ** end, * * Free-function: gst_structure_free * - * Returns: (transfer full): a new #GstStructure or NULL when the string could + * Returns: (transfer full): a new #GstStructure or %NULL when the string could * not be parsed. Free with gst_structure_free() after use. * * Since: 1.2 @@ -2405,12 +2405,12 @@ gst_structure_new_from_string (const gchar * string) * @end: (out) (allow-none) (transfer none) (skip): pointer to store the end of the string in. * * Creates a #GstStructure from a string representation. - * If end is not NULL, a pointer to the place inside the given string + * If end is not %NULL, a pointer to the place inside the given string * where parsing ended will be returned. * * Free-function: gst_structure_free * - * Returns: (transfer full): a new #GstStructure or NULL when the string could + * Returns: (transfer full): a new #GstStructure or %NULL when the string could * not be parsed. Free with gst_structure_free() after use. */ GstStructure * @@ -2488,7 +2488,7 @@ gst_structure_copy_conditional (const GstStructure * structure) * Fixates a #GstStructure by changing the given field to the nearest * integer to @target that is a subset of the existing field. * - * Returns: TRUE if the structure could be fixated + * Returns: %TRUE if the structure could be fixated */ gboolean gst_structure_fixate_field_nearest_int (GstStructure * structure, @@ -2552,7 +2552,7 @@ gst_structure_fixate_field_nearest_int (GstStructure * structure, * Fixates a #GstStructure by changing the given field to the nearest * double to @target that is a subset of the existing field. * - * Returns: TRUE if the structure could be fixated + * Returns: %TRUE if the structure could be fixated */ gboolean gst_structure_fixate_field_nearest_double (GstStructure * structure, @@ -2617,7 +2617,7 @@ gst_structure_fixate_field_nearest_double (GstStructure * structure, * Fixates a #GstStructure by changing the given @field_name field to the given * @target boolean if that field is not fixed yet. * - * Returns: TRUE if the structure could be fixated + * Returns: %TRUE if the structure could be fixated */ gboolean gst_structure_fixate_field_boolean (GstStructure * structure, @@ -2670,7 +2670,7 @@ gst_structure_fixate_field_boolean (GstStructure * structure, * Fixates a #GstStructure by changing the given @field_name field to the given * @target string if that field is not fixed yet. * - * Returns: TRUE if the structure could be fixated + * Returns: %TRUE if the structure could be fixated */ gboolean gst_structure_fixate_field_string (GstStructure * structure, @@ -2725,7 +2725,7 @@ gst_structure_fixate_field_string (GstStructure * structure, * fraction to @target_numerator/@target_denominator that is a subset * of the existing field. * - * Returns: TRUE if the structure could be fixated + * Returns: %TRUE if the structure could be fixated */ gboolean gst_structure_fixate_field_nearest_fraction (GstStructure * structure, @@ -2827,7 +2827,7 @@ default_fixate (GQuark field_id, const GValue * value, gpointer data) * * Fixates a #GstStructure by changing the given field with its fixated value. * - * Returns: TRUE if the structure field could be fixated + * Returns: %TRUE if the structure field could be fixated */ gboolean gst_structure_fixate_field (GstStructure * structure, const char *field_name) @@ -2845,7 +2845,7 @@ gst_structure_fixate_field (GstStructure * structure, const char *field_name) /* our very own version of G_VALUE_LCOPY that allows NULL return locations * (useful for message parsing functions where the return location is user - * supplied and the user may pass NULL if the value isn't of interest) */ + * supplied and the user may pass %NULL if the value isn't of interest) */ #define GST_VALUE_LCOPY(value, var_args, flags, __error, fieldname) \ G_STMT_START { \ const GValue *_value = (value); \ @@ -2879,7 +2879,7 @@ G_STMT_START { \ * valist-variant of gst_structure_get(). Look at the documentation of * gst_structure_get() for more details. * - * Returns: TRUE, or FALSE if there was a problem reading any of the fields + * Returns: %TRUE, or %FALSE if there was a problem reading any of the fields */ gboolean gst_structure_get_valist (const GstStructure * structure, @@ -2946,7 +2946,7 @@ wrong_type: * valist-variant of gst_structure_id_get(). Look at the documentation of * gst_structure_id_get() for more details. * - * Returns: TRUE, or FALSE if there was a problem reading any of the fields + * Returns: %TRUE, or %FALSE if there was a problem reading any of the fields */ gboolean gst_structure_id_get_valist (const GstStructure * structure, @@ -3013,16 +3013,16 @@ wrong_type: * Parses the variable arguments and reads fields from @structure accordingly. * Variable arguments should be in the form field name, field type * (as a GType), pointer(s) to a variable(s) to hold the return value(s). - * The last variable argument should be NULL. + * The last variable argument should be %NULL. * * For refcounted (mini)objects you will receive a new reference which * you must release with a suitable _unref() when no longer needed. For * strings and boxed types you will receive a copy which you will need to * release with either g_free() or the suitable function for the boxed type. * - * Returns: FALSE if there was a problem reading any of the fields (e.g. + * Returns: %FALSE if there was a problem reading any of the fields (e.g. * because the field requested did not exist, or was of a type other - * than the type specified), otherwise TRUE. + * than the type specified), otherwise %TRUE. */ gboolean gst_structure_get (const GstStructure * structure, const char *first_fieldname, @@ -3050,9 +3050,9 @@ gst_structure_get (const GstStructure * structure, const char *first_fieldname, * Parses the variable arguments and reads fields from @structure accordingly. * Variable arguments should be in the form field id quark, field type * (as a GType), pointer(s) to a variable(s) to hold the return value(s). - * The last variable argument should be NULL (technically it should be a - * 0 quark, but we require NULL so compilers that support it can check for - * the NULL terminator and warn if it's not there). + * The last variable argument should be %NULL (technically it should be a + * 0 quark, but we require %NULL so compilers that support it can check for + * the %NULL terminator and warn if it's not there). * * This function is just like gst_structure_get() only that it is slightly * more efficient since it saves the string-to-quark lookup in the global @@ -3063,9 +3063,9 @@ gst_structure_get (const GstStructure * structure, const char *first_fieldname, * strings and boxed types you will receive a copy which you will need to * release with either g_free() or the suitable function for the boxed type. * - * Returns: FALSE if there was a problem reading any of the fields (e.g. + * Returns: %FALSE if there was a problem reading any of the fields (e.g. * because the field requested did not exist, or was of a type other - * than the type specified), otherwise TRUE. + * than the type specified), otherwise %TRUE. */ gboolean gst_structure_id_get (const GstStructure * structure, GQuark first_field_id, @@ -3107,7 +3107,7 @@ gst_structure_is_equal_foreach (GQuark field_id, const GValue * val2, * * Tests if the two #GstStructure are equal. * - * Returns: TRUE if the two structures have the same name and field. + * Returns: %TRUE if the two structures have the same name and field. **/ gboolean gst_structure_is_equal (const GstStructure * structure1, diff --git a/gst/gststructure.h b/gst/gststructure.h index 684f5586d..6687970d8 100644 --- a/gst/gststructure.h +++ b/gst/gststructure.h @@ -47,8 +47,8 @@ typedef struct _GstStructure GstStructure; * A function that will be called in gst_structure_foreach(). The function may * not modify @value. * - * Returns: TRUE if the foreach operation should continue, FALSE if - * the foreach operation should stop with FALSE. + * Returns: %TRUE if the foreach operation should continue, %FALSE if + * the foreach operation should stop with %FALSE. */ typedef gboolean (*GstStructureForeachFunc) (GQuark field_id, const GValue * value, @@ -63,8 +63,8 @@ typedef gboolean (*GstStructureForeachFunc) (GQuark field_id, * A function that will be called in gst_structure_map_in_place(). The function * may modify @value. * - * Returns: TRUE if the map operation should continue, FALSE if - * the map operation should stop with FALSE. + * Returns: %TRUE if the map operation should continue, %FALSE if + * the map operation should stop with %FALSE. */ typedef gboolean (*GstStructureMapFunc) (GQuark field_id, GValue * value, diff --git a/gst/gsttaglist.c b/gst/gsttaglist.c index f8f8f04a9..0eac36d80 100644 --- a/gst/gsttaglist.c +++ b/gst/gsttaglist.c @@ -26,7 +26,7 @@ * List of tags and values used to describe media metadata. * * Strings in structures must be ASCII or UTF-8 encoded. Other encodings are - * not allowed. Strings must not be empty or NULL. + * not allowed. Strings must not be empty or %NULL. */ #ifdef HAVE_CONFIG_H @@ -465,7 +465,7 @@ gst_tag_lookup (const gchar * tag_name) * @type: the type this data is in * @nick: human-readable name * @blurb: a human-readable description about this tag - * @func: (allow-none): function for merging multiple values of this tag, or NULL + * @func: (allow-none): function for merging multiple values of this tag, or %NULL * * Registers a new tag type for the use with GStreamer's type system. If a type * with that name is already registered, that one is used. @@ -509,7 +509,7 @@ gst_tag_register (const gchar * name, GstTagFlag flag, GType type, * @type: the type this data is in * @nick: human-readable name or short description (string constant) * @blurb: a human-readable description for this tag (string constant) - * @func: (allow-none): function for merging multiple values of this tag, or NULL + * @func: (allow-none): function for merging multiple values of this tag, or %NULL * * Registers a new tag type for the use with GStreamer's type system. * @@ -555,7 +555,7 @@ gst_tag_register_static (const gchar * name, GstTagFlag flag, GType type, * * Checks if the given type is already registered. * - * Returns: TRUE if the type is already registered + * Returns: %TRUE if the type is already registered */ gboolean gst_tag_exists (const gchar * tag) @@ -654,7 +654,7 @@ gst_tag_get_flag (const gchar * tag) * Checks if the given tag is fixed. A fixed tag can only contain one value. * Unfixed tags can contain lists of values. * - * Returns: TRUE, if the given tag is fixed. + * Returns: %TRUE, if the given tag is fixed. */ gboolean gst_tag_is_fixed (const gchar * tag) @@ -740,10 +740,10 @@ gst_tag_list_new_empty (void) /** * gst_tag_list_new: * @tag: tag - * @...: NULL-terminated list of values to set + * @...: %NULL-terminated list of values to set * * Creates a new taglist and appends the values for the given tags. It expects - * tag-value pairs like gst_tag_list_add(), and a NULL terminator after the + * tag-value pairs like gst_tag_list_add(), and a %NULL terminator after the * last pair. The type of the values is implicit and is documented in the API * reference, but can also be queried at runtime with gst_tag_get_type(). It * is an error to pass a value of a type not matching the tag type into this @@ -841,7 +841,7 @@ gst_tag_list_get_scope (const GstTagList * list) * * Serializes a tag list to a string. * - * Returns: a newly-allocated string, or NULL in case of an error. The + * Returns: a newly-allocated string, or %NULL in case of an error. The * string must be freed with g_free() when no longer needed. */ gchar * @@ -858,7 +858,7 @@ gst_tag_list_to_string (const GstTagList * list) * * Deserializes a tag list. * - * Returns: a new #GstTagList, or NULL in case of an error. + * Returns: a new #GstTagList, or %NULL in case of an error. */ GstTagList * gst_tag_list_new_from_string (const gchar * str) @@ -919,7 +919,7 @@ gst_tag_list_nth_tag_name (const GstTagList * list, guint index) * * Checks if the given taglist is empty. * - * Returns: TRUE if the taglist is empty, otherwise FALSE. + * Returns: %TRUE if the taglist is empty, otherwise %FALSE. */ gboolean gst_tag_list_is_empty (const GstTagList * list) @@ -958,7 +958,7 @@ gst_tag_list_fields_equal (const GValue * value1, const GValue * value2) * * Checks if the two given taglists are equal. * - * Returns: TRUE if the taglists are equal, otherwise FALSE + * Returns: %TRUE if the taglists are equal, otherwise %FALSE */ gboolean gst_tag_list_is_equal (const GstTagList * list1, const GstTagList * list2) @@ -1132,8 +1132,8 @@ gst_tag_list_insert (GstTagList * into, const GstTagList * from, * @list2: second list to merge * @mode: the mode to use * - * Merges the two given lists into a new list. If one of the lists is NULL, a - * copy of the other is returned. If both lists are NULL, NULL is returned. + * Merges the two given lists into a new list. If one of the lists is %NULL, a + * copy of the other is returned. If both lists are %NULL, %NULL is returned. * * Free-function: gst_tag_list_unref * @@ -1197,7 +1197,7 @@ gst_tag_list_get_tag_size (const GstTagList * list, const gchar * tag) * @list: list to set tags in * @mode: the mode to use * @tag: tag - * @...: NULL-terminated list of values to set + * @...: %NULL-terminated list of values to set * * Sets the values for the given tags using the specified mode. */ @@ -1421,7 +1421,7 @@ gst_tag_list_foreach (const GstTagList * list, GstTagForeachFunc func, * Gets the value that is at the given index for the given tag in the given * list. * - * Returns: (transfer none): The GValue for the specified entry or NULL if the + * Returns: (transfer none): The GValue for the specified entry or %NULL if the * tag wasn't available or the tag doesn't have as many entries */ const GValue * @@ -1459,7 +1459,7 @@ gst_tag_list_get_value_index (const GstTagList * list, const gchar * tag, * with the tag. * You must g_value_unset() the value after use. * - * Returns: TRUE, if a value was copied, FALSE if the tag didn't exist in the + * Returns: %TRUE, if a value was copied, %FALSE if the tag didn't exist in the * given list. */ gboolean @@ -1549,7 +1549,7 @@ gst_tag_list_get_ ## name ## _index (const GstTagList *list, \ * Copies the contents for the given tag into the value, merging multiple values * into one if multiple values are associated with the tag. * - * Returns: TRUE, if a value was copied, FALSE if the tag didn't exist in the + * Returns: %TRUE, if a value was copied, %FALSE if the tag didn't exist in the * given list. */ /** @@ -1562,7 +1562,7 @@ gst_tag_list_get_ ## name ## _index (const GstTagList *list, \ * Gets the value that is at the given index for the given tag in the given * list. * - * Returns: TRUE, if a value was copied, FALSE if the tag didn't exist in the + * Returns: %TRUE, if a value was copied, %FALSE if the tag didn't exist in the * given list. */ TAG_MERGE_FUNCS (boolean, gboolean, TRUE); @@ -1575,7 +1575,7 @@ TAG_MERGE_FUNCS (boolean, gboolean, TRUE); * Copies the contents for the given tag into the value, merging multiple values * into one if multiple values are associated with the tag. * - * Returns: TRUE, if a value was copied, FALSE if the tag didn't exist in the + * Returns: %TRUE, if a value was copied, %FALSE if the tag didn't exist in the * given list. */ /** @@ -1588,7 +1588,7 @@ TAG_MERGE_FUNCS (boolean, gboolean, TRUE); * Gets the value that is at the given index for the given tag in the given * list. * - * Returns: TRUE, if a value was copied, FALSE if the tag didn't exist in the + * Returns: %TRUE, if a value was copied, %FALSE if the tag didn't exist in the * given list. */ TAG_MERGE_FUNCS (int, gint, TRUE); @@ -1601,7 +1601,7 @@ TAG_MERGE_FUNCS (int, gint, TRUE); * Copies the contents for the given tag into the value, merging multiple values * into one if multiple values are associated with the tag. * - * Returns: TRUE, if a value was copied, FALSE if the tag didn't exist in the + * Returns: %TRUE, if a value was copied, %FALSE if the tag didn't exist in the * given list. */ /** @@ -1614,7 +1614,7 @@ TAG_MERGE_FUNCS (int, gint, TRUE); * Gets the value that is at the given index for the given tag in the given * list. * - * Returns: TRUE, if a value was copied, FALSE if the tag didn't exist in the + * Returns: %TRUE, if a value was copied, %FALSE if the tag didn't exist in the * given list. */ TAG_MERGE_FUNCS (uint, guint, TRUE); @@ -1628,7 +1628,7 @@ TAG_MERGE_FUNCS (uint, guint, TRUE); * Gets the value that is at the given index for the given tag in the given * list. * - * Returns: TRUE, if a value was copied, FALSE if the tag didn't exist in the + * Returns: %TRUE, if a value was copied, %FALSE if the tag didn't exist in the * given list. */ TAG_MERGE_FUNCS (int64, gint64, TRUE); @@ -1641,7 +1641,7 @@ TAG_MERGE_FUNCS (int64, gint64, TRUE); * Copies the contents for the given tag into the value, merging multiple values * into one if multiple values are associated with the tag. * - * Returns: TRUE, if a value was copied, FALSE if the tag didn't exist in the + * Returns: %TRUE, if a value was copied, %FALSE if the tag didn't exist in the * given list. */ /** @@ -1654,7 +1654,7 @@ TAG_MERGE_FUNCS (int64, gint64, TRUE); * Gets the value that is at the given index for the given tag in the given * list. * - * Returns: TRUE, if a value was copied, FALSE if the tag didn't exist in the + * Returns: %TRUE, if a value was copied, %FALSE if the tag didn't exist in the * given list. */ TAG_MERGE_FUNCS (uint64, guint64, TRUE); @@ -1667,7 +1667,7 @@ TAG_MERGE_FUNCS (uint64, guint64, TRUE); * Copies the contents for the given tag into the value, merging multiple values * into one if multiple values are associated with the tag. * - * Returns: TRUE, if a value was copied, FALSE if the tag didn't exist in the + * Returns: %TRUE, if a value was copied, %FALSE if the tag didn't exist in the * given list. */ /** @@ -1680,7 +1680,7 @@ TAG_MERGE_FUNCS (uint64, guint64, TRUE); * Gets the value that is at the given index for the given tag in the given * list. * - * Returns: TRUE, if a value was copied, FALSE if the tag didn't exist in the + * Returns: %TRUE, if a value was copied, %FALSE if the tag didn't exist in the * given list. */ TAG_MERGE_FUNCS (float, gfloat, TRUE); @@ -1693,7 +1693,7 @@ TAG_MERGE_FUNCS (float, gfloat, TRUE); * Copies the contents for the given tag into the value, merging multiple values * into one if multiple values are associated with the tag. * - * Returns: TRUE, if a value was copied, FALSE if the tag didn't exist in the + * Returns: %TRUE, if a value was copied, %FALSE if the tag didn't exist in the * given list. */ /** @@ -1706,7 +1706,7 @@ TAG_MERGE_FUNCS (float, gfloat, TRUE); * Gets the value that is at the given index for the given tag in the given * list. * - * Returns: TRUE, if a value was copied, FALSE if the tag didn't exist in the + * Returns: %TRUE, if a value was copied, %FALSE if the tag didn't exist in the * given list. */ TAG_MERGE_FUNCS (double, gdouble, TRUE); @@ -1719,7 +1719,7 @@ TAG_MERGE_FUNCS (double, gdouble, TRUE); * Copies the contents for the given tag into the value, merging multiple values * into one if multiple values are associated with the tag. * - * Returns: TRUE, if a value was copied, FALSE if the tag didn't exist in the + * Returns: %TRUE, if a value was copied, %FALSE if the tag didn't exist in the * given list. */ /** @@ -1732,7 +1732,7 @@ TAG_MERGE_FUNCS (double, gdouble, TRUE); * Gets the value that is at the given index for the given tag in the given * list. * - * Returns: TRUE, if a value was copied, FALSE if the tag didn't exist in the + * Returns: %TRUE, if a value was copied, %FALSE if the tag didn't exist in the * given list. */ TAG_MERGE_FUNCS (pointer, gpointer, (*value != NULL)); @@ -1763,11 +1763,11 @@ _gst_strdup0 (const gchar * s) * * The resulting string in @value will be in UTF-8 encoding and should be * freed by the caller using g_free when no longer needed. The - * returned string is also guaranteed to be non-NULL and non-empty. + * returned string is also guaranteed to be non-%NULL and non-empty. * * Free-function: g_free * - * Returns: TRUE, if a value was copied, FALSE if the tag didn't exist in the + * Returns: %TRUE, if a value was copied, %FALSE if the tag didn't exist in the * given list. */ /** @@ -1782,11 +1782,11 @@ _gst_strdup0 (const gchar * s) * * The resulting string in @value will be in UTF-8 encoding and should be * freed by the caller using g_free when no longer needed. The - * returned string is also guaranteed to be non-NULL and non-empty. + * returned string is also guaranteed to be non-%NULL and non-empty. * * Free-function: g_free * - * Returns: TRUE, if a value was copied, FALSE if the tag didn't exist in the + * Returns: %TRUE, if a value was copied, %FALSE if the tag didn't exist in the * given list. */ TAG_MERGE_FUNCS (string, gchar *, (*value != NULL)); @@ -1808,9 +1808,9 @@ TAG_MERGE_FUNCS (string, gchar *, (*value != NULL)); * * The resulting string in @value will be in UTF-8 encoding and doesn't need * to be freed by the caller. The returned string is also guaranteed to - * be non-NULL and non-empty. + * be non-%NULL and non-empty. * - * Returns: TRUE, if a value was set, FALSE if the tag didn't exist in the + * Returns: %TRUE, if a value was set, %FALSE if the tag didn't exist in the * given list. */ gboolean @@ -1842,8 +1842,8 @@ gst_tag_list_peek_string_index (const GstTagList * list, * * Free-function: g_date_free * - * Returns: TRUE, if a date was copied, FALSE if the tag didn't exist in the - * given list or if it was #NULL. + * Returns: %TRUE, if a date was copied, %FALSE if the tag didn't exist in the + * given list or if it was %NULL. */ gboolean gst_tag_list_get_date (const GstTagList * list, const gchar * tag, @@ -1875,8 +1875,8 @@ gst_tag_list_get_date (const GstTagList * list, const gchar * tag, * * Free-function: g_date_free * - * Returns: TRUE, if a value was copied, FALSE if the tag didn't exist in the - * given list or if it was #NULL. + * Returns: %TRUE, if a value was copied, %FALSE if the tag didn't exist in the + * given list or if it was %NULL. */ gboolean gst_tag_list_get_date_index (const GstTagList * list, @@ -1907,8 +1907,8 @@ gst_tag_list_get_date_index (const GstTagList * list, * * Free-function: gst_date_time_unref * - * Returns: TRUE, if a datetime was copied, FALSE if the tag didn't exist in - * the given list or if it was #NULL. + * Returns: %TRUE, if a datetime was copied, %FALSE if the tag didn't exist in + * the given list or if it was %NULL. */ gboolean gst_tag_list_get_date_time (const GstTagList * list, const gchar * tag, @@ -1943,8 +1943,8 @@ gst_tag_list_get_date_time (const GstTagList * list, const gchar * tag, * * Free-function: gst_date_time_unref * - * Returns: TRUE, if a value was copied, FALSE if the tag didn't exist in the - * given list or if it was #NULL. + * Returns: %TRUE, if a value was copied, %FALSE if the tag didn't exist in the + * given list or if it was %NULL. */ gboolean gst_tag_list_get_date_time_index (const GstTagList * list, @@ -1977,8 +1977,8 @@ gst_tag_list_get_date_time_index (const GstTagList * list, * * Free-function: gst_sample_unref * - * Returns: TRUE, if a sample was returned, FALSE if the tag didn't exist in - * the given list or if it was #NULL. + * Returns: %TRUE, if a sample was returned, %FALSE if the tag didn't exist in + * the given list or if it was %NULL. */ gboolean gst_tag_list_get_sample (const GstTagList * list, const gchar * tag, @@ -2013,8 +2013,8 @@ gst_tag_list_get_sample (const GstTagList * list, const gchar * tag, * * Free-function: gst_sample_unref * - * Returns: TRUE, if a sample was copied, FALSE if the tag didn't exist in the - * given list or if it was #NULL. + * Returns: %TRUE, if a sample was copied, %FALSE if the tag didn't exist in the + * given list or if it was %NULL. */ gboolean gst_tag_list_get_sample_index (const GstTagList * list, diff --git a/gst/gsttagsetter.c b/gst/gsttagsetter.c index 78f0c6a5c..b2955d6c3 100644 --- a/gst/gsttagsetter.c +++ b/gst/gsttagsetter.c @@ -200,7 +200,7 @@ gst_tag_setter_merge_tags (GstTagSetter * setter, const GstTagList * list, * @...: more tag / value pairs to set * * Adds the given tag / value pairs on the setter using the given merge mode. - * The list must be terminated with NULL. + * The list must be terminated with %NULL. */ void gst_tag_setter_add_tags (GstTagSetter * setter, GstTagMergeMode mode, @@ -224,7 +224,7 @@ gst_tag_setter_add_tags (GstTagSetter * setter, GstTagMergeMode mode, * @...: more tag / GValue pairs to set * * Adds the given tag / GValue pairs on the setter using the given merge mode. - * The list must be terminated with NULL. + * The list must be terminated with %NULL. */ void gst_tag_setter_add_tag_values (GstTagSetter * setter, GstTagMergeMode mode, @@ -248,7 +248,7 @@ gst_tag_setter_add_tag_values (GstTagSetter * setter, GstTagMergeMode mode, * @var_args: tag / value pairs to set * * Adds the given tag / value pairs on the setter using the given merge mode. - * The list must be terminated with NULL. + * The list must be terminated with %NULL. */ void gst_tag_setter_add_tag_valist (GstTagSetter * setter, GstTagMergeMode mode, @@ -278,7 +278,7 @@ gst_tag_setter_add_tag_valist (GstTagSetter * setter, GstTagMergeMode mode, * @var_args: tag / GValue pairs to set * * Adds the given tag / GValue pairs on the setter using the given merge mode. - * The list must be terminated with NULL. + * The list must be terminated with %NULL. */ void gst_tag_setter_add_tag_valist_values (GstTagSetter * setter, @@ -341,7 +341,7 @@ gst_tag_setter_add_tag_value (GstTagSetter * setter, * This function is not thread-safe. * * Returns: (transfer none): a current snapshot of the taglist used in the - * setter or NULL if none is used. + * setter or %NULL if none is used. */ const GstTagList * gst_tag_setter_get_tag_list (GstTagSetter * setter) diff --git a/gst/gsttask.c b/gst/gsttask.c index 4414f49e3..b562f6c2a 100644 --- a/gst/gsttask.c +++ b/gst/gsttask.c @@ -331,7 +331,7 @@ exit: GST_OBJECT_LOCK (task); } /* now we allow messing with the lock again by setting the running flag to - * FALSE. Together with the SIGNAL this is the sign for the _join() to + * %FALSE. Together with the SIGNAL this is the sign for the _join() to * complete. * Note that we still have not dropped the final ref on the task. We could * check here if there is a pending join() going on and drop the last ref diff --git a/gst/gsttaskpool.c b/gst/gsttaskpool.c index 31a06e1a1..d7ff3449c 100644 --- a/gst/gsttaskpool.c +++ b/gst/gsttaskpool.c @@ -224,7 +224,7 @@ gst_task_pool_cleanup (GstTaskPool * pool) * Start the execution of a new thread from @pool. * * Returns: (transfer none): a pointer that should be used for the - * gst_task_pool_join function. This pointer can be NULL, you must + * gst_task_pool_join function. This pointer can be %NULL, you must * check @error to detect errors. */ gpointer diff --git a/gst/gsttoc.c b/gst/gsttoc.c index 0d3d0258a..546a774d1 100644 --- a/gst/gsttoc.c +++ b/gst/gsttoc.c @@ -357,7 +357,7 @@ gst_toc_entry_find_sub_entry (const GstTocEntry * entry, const gchar * uid) * * Find #GstTocEntry with given @uid in the @toc. * - * Returns: (transfer none): #GstTocEntry with specified @uid from the @toc, or NULL if not found. + * Returns: (transfer none): #GstTocEntry with specified @uid from the @toc, or %NULL if not found. */ GstTocEntry * gst_toc_find_entry (const GstToc * toc, const gchar * uid) @@ -390,7 +390,7 @@ gst_toc_find_entry (const GstToc * toc, const gchar * uid) * * Copy #GstTocEntry with all subentries (deep copy). * - * Returns: newly allocated #GstTocEntry in case of success, NULL otherwise; + * Returns: newly allocated #GstTocEntry in case of success, %NULL otherwise; * free it when done with gst_toc_entry_unref(). */ static GstTocEntry * @@ -434,7 +434,7 @@ gst_toc_entry_copy (const GstTocEntry * entry) * * Copy #GstToc with all subentries (deep copy). * - * Returns: newly allocated #GstToc in case of success, NULL otherwise; + * Returns: newly allocated #GstToc in case of success, %NULL otherwise; * free it when done with gst_toc_unref(). */ static GstToc * diff --git a/gst/gsttocsetter.c b/gst/gsttocsetter.c index 222a4ed9a..42839d2f9 100644 --- a/gst/gsttocsetter.c +++ b/gst/gsttocsetter.c @@ -128,7 +128,7 @@ gst_toc_setter_reset (GstTocSetter * setter) * modified without making it writable first. * * - * Returns: (transfer full): TOC set, or NULL. Unref with gst_toc_unref() + * Returns: (transfer full): TOC set, or %NULL. Unref with gst_toc_unref() * when no longer needed */ GstToc * diff --git a/gst/gsttypefind.c b/gst/gsttypefind.c index 7e647ca19..1fcbea1ff 100644 --- a/gst/gsttypefind.c +++ b/gst/gsttypefind.c @@ -40,7 +40,7 @@ G_DEFINE_POINTER_TYPE (GstTypeFind, gst_type_find); /** * gst_type_find_register: - * @plugin: (allow-none): A #GstPlugin, or NULL for a static typefind function + * @plugin: (allow-none): A #GstPlugin, or %NULL for a static typefind function * @name: The name for registering * @rank: The rank (or importance) of this typefind function * @func: The #GstTypeFindFunction to use @@ -57,7 +57,7 @@ G_DEFINE_POINTER_TYPE (GstTypeFind, gst_type_find); * registering this function will be available for typefinding. * This function is typically called during an element's plugin initialization. * - * Returns: TRUE on success, FALSE otherwise + * Returns: %TRUE on success, %FALSE otherwise */ gboolean gst_type_find_register (GstPlugin * plugin, const gchar * name, guint rank, @@ -119,7 +119,7 @@ gst_type_find_register (GstPlugin * plugin, const gchar * name, guint rank, * the stream. The returned memory is valid until the typefinding function * returns and must not be freed. * - * Returns: (transfer none) (array length=size): the requested data, or NULL + * Returns: (transfer none) (array length=size): the requested data, or %NULL * if that data is not available. */ const guint8 * @@ -157,7 +157,7 @@ gst_type_find_suggest (GstTypeFind * find, guint probability, GstCaps * caps) * @find: The #GstTypeFind object the function was called with * @probability: The probability in percent that the suggestion is right * @media_type: the media type of the suggested caps - * @fieldname: (allow-none): first field of the suggested caps, or NULL + * @fieldname: (allow-none): first field of the suggested caps, or %NULL * @...: additional arguments to the suggested caps in the same format as the * arguments passed to gst_structure_new() (ie. triplets of field name, * field GType and field value) @@ -171,7 +171,7 @@ gst_type_find_suggest (GstTypeFind * find, guint probability, GstCaps * caps) * passing a #GstCaps argument you can create the caps on the fly in the same * way as you can with gst_caps_new_simple(). * - * Make sure you terminate the list of arguments with a NULL argument and that + * Make sure you terminate the list of arguments with a %NULL argument and that * the values passed have the correct type (in terms of width in bytes when * passed to the vararg function - this applies particularly to gdouble and * guint64 arguments). diff --git a/gst/gsttypefindfactory.c b/gst/gsttypefindfactory.c index b09d906ec..c216eb3b2 100644 --- a/gst/gsttypefindfactory.c +++ b/gst/gsttypefindfactory.c @@ -174,11 +174,11 @@ gst_type_find_factory_get_caps (GstTypeFindFactory * factory) * * Gets the extensions associated with a #GstTypeFindFactory. The returned * array should not be changed. If you need to change stuff in it, you should - * copy it using g_strdupv(). This function may return NULL to indicate + * copy it using g_strdupv(). This function may return %NULL to indicate * a 0-length list. * * Returns: (transfer none) (array zero-terminated=1) (element-type utf8): a - * NULL-terminated array of extensions associated with this factory + * %NULL-terminated array of extensions associated with this factory */ const gchar *const * gst_type_find_factory_get_extensions (GstTypeFindFactory * factory) @@ -225,7 +225,7 @@ gst_type_find_factory_call_function (GstTypeFindFactory * factory, * without typefind functions are a last-effort fallback mechanism to * e.g. assume a certain media type based on the file extension. * - * Returns: TRUE if the factory has a typefind functions set, otherwise FALSE + * Returns: %TRUE if the factory has a typefind functions set, otherwise %FALSE */ gboolean gst_type_find_factory_has_function (GstTypeFindFactory * factory) diff --git a/gst/gsturi.c b/gst/gsturi.c index ace3756d2..00a496f7a 100644 --- a/gst/gsturi.c +++ b/gst/gsturi.c @@ -301,7 +301,7 @@ gst_uri_protocol_check_internal (const gchar * uri, gchar ** endptr) * must consist of alphanumeric characters, '+', '-' and '.' and must * start with a alphabetic character. See RFC 3986 Section 3.1. * - * Returns: TRUE if the string is a valid protocol identifier, FALSE otherwise. + * Returns: %TRUE if the string is a valid protocol identifier, %FALSE otherwise. */ gboolean gst_uri_protocol_is_valid (const gchar * protocol) @@ -322,7 +322,7 @@ gst_uri_protocol_is_valid (const gchar * protocol) * Tests if the given string is a valid URI identifier. URIs start with a valid * scheme followed by ":" and maybe a string identifying the location. * - * Returns: TRUE if the string is a valid URI + * Returns: %TRUE if the string is a valid URI */ gboolean gst_uri_is_valid (const gchar * uri) @@ -395,7 +395,7 @@ gst_uri_has_protocol (const gchar * uri, const gchar * protocol) * * Free-function: g_free * - * Returns: (transfer full): the location for this URI. Returns NULL if the + * Returns: (transfer full): the location for this URI. Returns %NULL if the * URI isn't valid. If the URI does not contain a location, an empty * string is returned. */ @@ -442,8 +442,8 @@ gst_uri_get_location (const gchar * uri) * * Free-function: g_free * - * Returns: (transfer full): a new string for this URI. Returns NULL if the - * given URI protocol is not valid, or the given location is NULL. + * Returns: (transfer full): a new string for this URI. Returns %NULL if the + * given URI protocol is not valid, or the given location is %NULL. */ gchar * gst_uri_construct (const gchar * protocol, const gchar * location) @@ -533,7 +533,7 @@ get_element_factories_from_uri_protocol (const GstURIType type, * that a positive return value does not imply that a subsequent call to * gst_element_make_from_uri() is guaranteed to work. * - * Returns: TRUE + * Returns: %TRUE */ gboolean gst_uri_protocol_is_supported (const GstURIType type, const gchar * protocol) @@ -555,12 +555,12 @@ gst_uri_protocol_is_supported (const GstURIType type, const gchar * protocol) * gst_element_make_from_uri: * @type: Whether to create a source or a sink * @uri: URI to create an element for - * @elementname: (allow-none): Name of created element, can be NULL. - * @error: (allow-none): address where to store error information, or NULL. + * @elementname: (allow-none): Name of created element, can be %NULL. + * @error: (allow-none): address where to store error information, or %NULL. * * Creates an element for handling the given URI. * - * Returns: (transfer floating): a new element or NULL if none could be created + * Returns: (transfer floating): a new element or %NULL if none could be created */ GstElement * gst_element_make_from_uri (const GstURIType type, const gchar * uri, @@ -665,7 +665,7 @@ gst_uri_handler_get_uri_type (GstURIHandler * handler) * modified. * * Returns: (transfer none) (element-type utf8): the supported protocols. - * Returns NULL if the @handler isn't implemented properly, or the @handler + * Returns %NULL if the @handler isn't implemented properly, or the @handler * doesn't support any protocols. */ const gchar *const * @@ -693,7 +693,7 @@ gst_uri_handler_get_protocols (GstURIHandler * handler) * Gets the currently handled URI. * * Returns: (transfer full): the URI currently handled by the @handler. - * Returns NULL if there are no URI currently handled. The + * Returns %NULL if there are no URI currently handled. The * returned string must be freed with g_free() when no longer needed. */ gchar * @@ -719,11 +719,11 @@ gst_uri_handler_get_uri (GstURIHandler * handler) * @handler: A #GstURIHandler * @uri: URI to set * @error: (allow-none): address where to store a #GError in case of - * an error, or NULL + * an error, or %NULL * * Tries to set the URI of the given handler. * - * Returns: TRUE if the URI was set successfully, else FALSE. + * Returns: %TRUE if the URI was set successfully, else %FALSE. */ gboolean gst_uri_handler_set_uri (GstURIHandler * handler, const gchar * uri, @@ -839,7 +839,7 @@ file_path_contains_relatives (const gchar * path) /** * gst_filename_to_uri: * @filename: absolute or relative file name path - * @error: pointer to error, or NULL + * @error: pointer to error, or %NULL * * Similar to g_filename_to_uri(), but attempts to handle relative file paths * as well. Before converting @filename into an URI, it will be prefixed by diff --git a/gst/gstutils.c b/gst/gstutils.c index 867fd562a..d4bb78779 100644 --- a/gst/gstutils.c +++ b/gst/gstutils.c @@ -773,7 +773,7 @@ gst_element_create_all_pads (GstElement * element) * Retrieves a pad template from @element that is compatible with @compattempl. * Pads from compatible templates can be linked together. * - * Returns: (transfer none): a compatible #GstPadTemplate, or NULL if none + * Returns: (transfer none): a compatible #GstPadTemplate, or %NULL if none * was found. No unreferencing is necessary. */ GstPadTemplate * @@ -1505,10 +1505,10 @@ pad_link_maybe_ghosting (GstPad * src, GstPad * sink, GstPadLinkCheck flags) * gst_element_link_pads_full: * @src: a #GstElement containing the source pad. * @srcpadname: (allow-none): the name of the #GstPad in source element - * or NULL for any pad. + * or %NULL for any pad. * @dest: (transfer none): the #GstElement containing the destination pad. * @destpadname: (allow-none): the name of the #GstPad in destination element, - * or NULL for any pad. + * or %NULL for any pad. * @flags: the #GstPadLinkCheck to be performed when linking pads. * * Links the two named pads of the source and destination elements. @@ -1522,7 +1522,7 @@ pad_link_maybe_ghosting (GstPad * src, GstPad * sink, GstPadLinkCheck flags) * * This is a convenience function for gst_pad_link_full(). * - * Returns: TRUE if the pads could be linked, FALSE otherwise. + * Returns: %TRUE if the pads could be linked, %FALSE otherwise. */ gboolean gst_element_link_pads_full (GstElement * src, const gchar * srcpadname, @@ -1784,17 +1784,17 @@ gst_element_link_pads_full (GstElement * src, const gchar * srcpadname, * gst_element_link_pads: * @src: a #GstElement containing the source pad. * @srcpadname: (allow-none): the name of the #GstPad in source element - * or NULL for any pad. + * or %NULL for any pad. * @dest: (transfer none): the #GstElement containing the destination pad. * @destpadname: (allow-none): the name of the #GstPad in destination element, - * or NULL for any pad. + * or %NULL for any pad. * * Links the two named pads of the source and destination elements. * Side effect is that if one of the pads has no parent, it becomes a * child of the parent of the other element. If they have different * parents, the link fails. * - * Returns: TRUE if the pads could be linked, FALSE otherwise. + * Returns: %TRUE if the pads could be linked, %FALSE otherwise. */ gboolean gst_element_link_pads (GstElement * src, const gchar * srcpadname, @@ -1808,19 +1808,19 @@ gst_element_link_pads (GstElement * src, const gchar * srcpadname, * gst_element_link_pads_filtered: * @src: a #GstElement containing the source pad. * @srcpadname: (allow-none): the name of the #GstPad in source element - * or NULL for any pad. + * or %NULL for any pad. * @dest: (transfer none): the #GstElement containing the destination pad. * @destpadname: (allow-none): the name of the #GstPad in destination element - * or NULL for any pad. + * or %NULL for any pad. * @filter: (transfer none) (allow-none): the #GstCaps to filter the link, - * or #NULL for no filter. + * or %NULL for no filter. * * Links the two named pads of the source and destination elements. Side effect * is that if one of the pads has no parent, it becomes a child of the parent of * the other element. If they have different parents, the link fails. If @caps - * is not #NULL, makes sure that the caps of the link is a subset of @caps. + * is not %NULL, makes sure that the caps of the link is a subset of @caps. * - * Returns: TRUE if the pads could be linked, FALSE otherwise. + * Returns: %TRUE if the pads could be linked, %FALSE otherwise. */ gboolean gst_element_link_pads_filtered (GstElement * src, const gchar * srcpadname, @@ -1906,7 +1906,7 @@ gst_element_link_pads_filtered (GstElement * src, const gchar * srcpadname, * Make sure you have added your elements to a bin or pipeline with * gst_bin_add() before trying to link them. * - * Returns: TRUE if the elements could be linked, FALSE otherwise. + * Returns: %TRUE if the elements could be linked, %FALSE otherwise. */ gboolean gst_element_link (GstElement * src, GstElement * dest) @@ -1918,13 +1918,13 @@ gst_element_link (GstElement * src, GstElement * dest) * gst_element_link_many: * @element_1: (transfer none): the first #GstElement in the link chain. * @element_2: (transfer none): the second #GstElement in the link chain. - * @...: the NULL-terminated list of elements to link in order. + * @...: the %NULL-terminated list of elements to link in order. * * Chain together a series of elements. Uses gst_element_link(). * Make sure you have added your elements to a bin or pipeline with * gst_bin_add() before trying to link them. * - * Returns: TRUE on success, FALSE otherwise. + * Returns: %TRUE on success, %FALSE otherwise. */ gboolean gst_element_link_many (GstElement * element_1, GstElement * element_2, ...) @@ -1957,7 +1957,7 @@ gst_element_link_many (GstElement * element_1, GstElement * element_2, ...) * @src: a #GstElement containing the source pad. * @dest: (transfer none): the #GstElement containing the destination pad. * @filter: (transfer none) (allow-none): the #GstCaps to filter the link, - * or #NULL for no filter. + * or %NULL for no filter. * * Links @src to @dest using the given caps as filtercaps. * The link must be from source to @@ -1968,7 +1968,7 @@ gst_element_link_many (GstElement * element_1, GstElement * element_2, ...) * Make sure you have added your elements to a bin or pipeline with * gst_bin_add() before trying to link them. * - * Returns: TRUE if the pads could be linked, FALSE otherwise. + * Returns: %TRUE if the pads could be linked, %FALSE otherwise. */ gboolean gst_element_link_filtered (GstElement * src, GstElement * dest, @@ -2038,7 +2038,7 @@ free_src: * gst_element_unlink_many: * @element_1: (transfer none): the first #GstElement in the link chain. * @element_2: (transfer none): the second #GstElement in the link chain. - * @...: the NULL-terminated list of elements to unlink in order. + * @...: the %NULL-terminated list of elements to unlink in order. * * Unlinks a series of elements. Uses gst_element_unlink(). */ @@ -2134,7 +2134,7 @@ gst_element_unlink (GstElement * src, GstElement * dest) * @element: a #GstElement to invoke the position query on. * @format: the #GstFormat requested * @cur: (out) (allow-none): a location in which to store the current - * position, or NULL. + * position, or %NULL. * * Queries an element (usually top-level pipeline or playbin element) for the * stream position in nanoseconds. This will be a value between 0 and the @@ -2146,7 +2146,7 @@ gst_element_unlink (GstElement * src, GstElement * dest) * If one repeatedly calls this function one can also create a query and reuse * it in gst_element_query(). * - * Returns: TRUE if the query could be performed. + * Returns: %TRUE if the query could be performed. */ gboolean gst_element_query_position (GstElement * element, GstFormat format, @@ -2173,7 +2173,7 @@ gst_element_query_position (GstElement * element, GstFormat format, * gst_element_query_duration: * @element: a #GstElement to invoke the duration query on. * @format: the #GstFormat requested - * @duration: (out) (allow-none): A location in which to store the total duration, or NULL. + * @duration: (out) (allow-none): A location in which to store the total duration, or %NULL. * * Queries an element (usually top-level pipeline or playbin element) for the * total stream duration in nanoseconds. This query will only work once the @@ -2184,7 +2184,7 @@ gst_element_query_position (GstElement * element, GstFormat format, * message on the pipeline bus, in which case you should re-query the duration * using this function. * - * Returns: TRUE if the query could be performed. + * Returns: %TRUE if the query could be performed. */ gboolean gst_element_query_duration (GstElement * element, GstFormat format, @@ -2217,7 +2217,7 @@ gst_element_query_duration (GstElement * element, GstFormat format, * * Queries an element to convert @src_val in @src_format to @dest_format. * - * Returns: TRUE if the query could be performed. + * Returns: %TRUE if the query could be performed. */ gboolean gst_element_query_convert (GstElement * element, GstFormat src_format, @@ -2309,7 +2309,7 @@ gst_pad_use_fixed_caps (GstPad * pad) * @pad: a pad * * Gets the parent of @pad, cast to a #GstElement. If a @pad has no parent or - * its parent is not an element, return NULL. + * its parent is not an element, return %NULL. * * Returns: (transfer full): the parent of the pad. The caller has a * reference on the parent, so unref when you're finished with it. @@ -2336,7 +2336,7 @@ gst_pad_get_parent_element (GstPad * pad) * gst_object_default_error: * @source: the #GstObject that initiated the error. * @error: (in): the GError. - * @debug: (in) (allow-none): an additional debug information string, or NULL + * @debug: (in) (allow-none): an additional debug information string, or %NULL * * A default error function that uses g_printerr() to display the error message * and the optional debug sting.. @@ -2362,7 +2362,7 @@ gst_object_default_error (GstObject * source, const GError * error, * @element_1: (transfer full): the #GstElement element to add to the bin * @...: (transfer full): additional elements to add to the bin * - * Adds a NULL-terminated list of elements to a bin. This function is + * Adds a %NULL-terminated list of elements to a bin. This function is * equivalent to calling gst_bin_add() for each member of the list. The return * value of each gst_bin_add() is ignored. */ @@ -2389,7 +2389,7 @@ gst_bin_add_many (GstBin * bin, GstElement * element_1, ...) * gst_bin_remove_many: * @bin: a #GstBin * @element_1: (transfer none): the first #GstElement to remove from the bin - * @...: (transfer none): NULL-terminated list of elements to remove from the bin + * @...: (transfer none): %NULL-terminated list of elements to remove from the bin * * Remove a list of elements from a bin. This function is equivalent * to calling gst_bin_remove() with each member of the list. @@ -2443,7 +2443,7 @@ query_accept_caps_func (GstPad * pad, QueryAcceptCapsData * data) * that can handle any stream format, but requires caps that are acceptable for * all opposite pads. * - * Returns: TRUE if @query could be executed + * Returns: %TRUE if @query could be executed */ gboolean gst_pad_proxy_query_accept_caps (GstPad * pad, GstQuery * query) @@ -2511,7 +2511,7 @@ query_caps_func (GstPad * pad, QueryCapsData * data) * that can handle any stream format, but requires all its pads to have * the same caps. Two such elements are tee and adder. * - * Returns: TRUE if @query could be executed + * Returns: %TRUE if @query could be executed */ gboolean gst_pad_proxy_query_caps (GstPad * pad, GstQuery * query) @@ -2550,11 +2550,11 @@ gst_pad_proxy_query_caps (GstPad * pad, GstQuery * query) * gst_pad_query_position: * @pad: a #GstPad to invoke the position query on. * @format: the #GstFormat requested - * @cur: (out) (allow-none): A location in which to store the current position, or NULL. + * @cur: (out) (allow-none): A location in which to store the current position, or %NULL. * * Queries a pad for the stream position. * - * Returns: TRUE if the query could be performed. + * Returns: %TRUE if the query could be performed. */ gboolean gst_pad_query_position (GstPad * pad, GstFormat format, gint64 * cur) @@ -2579,11 +2579,11 @@ gst_pad_query_position (GstPad * pad, GstFormat format, gint64 * cur) * Must be a sink pad. * @format: the #GstFormat requested * @cur: (out) (allow-none): a location in which to store the current - * position, or NULL. + * position, or %NULL. * * Queries the peer of a given sink pad for the stream position. * - * Returns: TRUE if the query could be performed. + * Returns: %TRUE if the query could be performed. */ gboolean gst_pad_peer_query_position (GstPad * pad, GstFormat format, gint64 * cur) @@ -2607,11 +2607,11 @@ gst_pad_peer_query_position (GstPad * pad, GstFormat format, gint64 * cur) * @pad: a #GstPad to invoke the duration query on. * @format: the #GstFormat requested * @duration: (out) (allow-none): a location in which to store the total - * duration, or NULL. + * duration, or %NULL. * * Queries a pad for the total stream duration. * - * Returns: TRUE if the query could be performed. + * Returns: %TRUE if the query could be performed. */ gboolean gst_pad_query_duration (GstPad * pad, GstFormat format, gint64 * duration) @@ -2636,11 +2636,11 @@ gst_pad_query_duration (GstPad * pad, GstFormat format, gint64 * duration) * Must be a sink pad. * @format: the #GstFormat requested * @duration: (out) (allow-none): a location in which to store the total - * duration, or NULL. + * duration, or %NULL. * * Queries the peer pad of a given sink pad for the total stream duration. * - * Returns: TRUE if the query could be performed. + * Returns: %TRUE if the query could be performed. */ gboolean gst_pad_peer_query_duration (GstPad * pad, GstFormat format, gint64 * duration) @@ -2670,7 +2670,7 @@ gst_pad_peer_query_duration (GstPad * pad, GstFormat format, gint64 * duration) * * Queries a pad to convert @src_val in @src_format to @dest_format. * - * Returns: TRUE if the query could be performed. + * Returns: %TRUE if the query could be performed. */ gboolean gst_pad_query_convert (GstPad * pad, GstFormat src_format, gint64 src_val, @@ -2708,7 +2708,7 @@ gst_pad_query_convert (GstPad * pad, GstFormat src_format, gint64 src_val, * Queries the peer pad of a given sink pad to convert @src_val in @src_format * to @dest_format. * - * Returns: TRUE if the query could be performed. + * Returns: %TRUE if the query could be performed. */ gboolean gst_pad_peer_query_convert (GstPad * pad, GstFormat src_format, gint64 src_val, @@ -2733,14 +2733,14 @@ gst_pad_peer_query_convert (GstPad * pad, GstFormat src_format, gint64 src_val, /** * gst_pad_query_caps: * @pad: a #GstPad to get the capabilities of. - * @filter: (allow-none): suggested #GstCaps, or NULL + * @filter: (allow-none): suggested #GstCaps, or %NULL * * Gets the capabilities this pad can produce or consume. * Note that this method doesn't necessarily return the caps set by sending a * gst_event_new_caps() - use gst_pad_get_current_caps() for that instead. * gst_pad_query_caps returns all possible caps a pad can operate with, using * the pad's CAPS query function, If the query fails, this function will return - * @filter, if not #NULL, otherwise ANY. + * @filter, if not %NULL, otherwise ANY. * * When called on sinkpads @filter contains the caps that * upstream could produce in the order preferred by upstream. When @@ -2784,7 +2784,7 @@ gst_pad_query_caps (GstPad * pad, GstCaps * filter) /** * gst_pad_peer_query_caps: * @pad: a #GstPad to get the capabilities of. - * @filter: (allow-none): a #GstCaps filter, or NULL. + * @filter: (allow-none): a #GstCaps filter, or %NULL. * * Gets the capabilities of the peer connected to this pad. Similar to * gst_pad_query_caps(). @@ -2834,7 +2834,7 @@ gst_pad_peer_query_caps (GstPad * pad, GstCaps * filter) * * Check if the given pad accepts the caps. * - * Returns: TRUE if the pad can accept the caps. + * Returns: %TRUE if the pad can accept the caps. */ gboolean gst_pad_query_accept_caps (GstPad * pad, GstCaps * caps) @@ -2864,9 +2864,9 @@ gst_pad_query_accept_caps (GstPad * pad, GstCaps * caps) * @caps: a #GstCaps to check on the pad * * Check if the peer of @pad accepts @caps. If @pad has no peer, this function - * returns TRUE. + * returns %TRUE. * - * Returns: TRUE if the peer of @pad can accept the caps or @pad has no peer. + * Returns: %TRUE if the peer of @pad can accept the caps or @pad has no peer. */ gboolean gst_pad_peer_query_accept_caps (GstPad * pad, GstCaps * caps) @@ -2953,11 +2953,11 @@ element_find_unlinked_pad (GstElement * element, GstPadDirection direction) * * Recursively looks for elements with an unlinked pad of the given * direction within the specified bin and returns an unlinked pad - * if one is found, or NULL otherwise. If a pad is found, the caller + * if one is found, or %NULL otherwise. If a pad is found, the caller * owns a reference to it and should use gst_object_unref() on the * pad when it is not needed any longer. * - * Returns: (transfer full): unlinked pad of the given direction, or NULL. + * Returns: (transfer full): unlinked pad of the given direction, %NULL. */ GstPad * gst_bin_find_unlinked_pad (GstBin * bin, GstPadDirection direction) @@ -3005,7 +3005,7 @@ gst_bin_find_unlinked_pad (GstBin * bin, GstPadDirection direction) * @bin_description: command line describing the bin * @ghost_unlinked_pads: whether to automatically create ghost pads * for unlinked source or sink pads within the bin - * @err: where to store the error message in case of an error, or NULL + * @err: where to store the error message in case of an error, or %NULL * * This is a convenience wrapper around gst_parse_launch() to create a * #GstBin from a gst-launch-style pipeline description. See @@ -3036,7 +3036,7 @@ gst_parse_bin_from_description (const gchar * bin_description, * @context: (transfer none) (allow-none): a parse context allocated with * gst_parse_context_new(), or %NULL * @flags: parsing options, or #GST_PARSE_FLAG_NONE - * @err: where to store the error message in case of an error, or NULL + * @err: where to store the error message in case of an error, or %NULL * * This is a convenience wrapper around gst_parse_launch() to create a * #GstBin from a gst-launch-style pipeline description. See diff --git a/gst/gstvalue.c b/gst/gstvalue.c index 86f6154fc..a38cce03e 100644 --- a/gst/gstvalue.c +++ b/gst/gstvalue.c @@ -63,8 +63,8 @@ typedef gboolean (*GstValueUnionFunc) (GValue * dest, * * Used by gst_value_intersect() to perform intersection for a specific #GValue * type. If the intersection is non-empty, the result is - * placed in @dest and TRUE is returned. If the intersection is - * empty, @dest is unmodified and FALSE is returned. + * placed in @dest and %TRUE is returned. If the intersection is + * empty, @dest is unmodified and %FALSE is returned. * Register a new implementation with gst_value_register_intersect_func(). * * Returns: %TRUE if the values can intersect @@ -2893,7 +2893,7 @@ gst_string_take_and_wrap (gchar * s) * 0->3, y is copied unescaped. * * If \xyy is found where x is an octal number but y is not, an - * error is encountered and NULL is returned. + * error is encountered and %NULL is returned. * * the input string must be \0 terminated. */ @@ -4387,7 +4387,7 @@ gst_value_get_compare_func (const GValue * value1) * * Determines if @value1 and @value2 can be compared. * - * Returns: TRUE if the values can be compared + * Returns: %TRUE if the values can be compared */ gboolean gst_value_can_compare (const GValue * value1, const GValue * value2) @@ -4579,13 +4579,13 @@ gst_value_compare_with_func (const GValue * value1, const GValue * value2, * * Determines if @value1 and @value2 can be non-trivially unioned. * Any two values can be trivially unioned by adding both of them - * to a GstValueList. However, certain types have the possibility + * to a #GstValueList. However, certain types have the possibility * to be unioned in a simpler way. For example, an integer range * and an integer can be unioned if the integer is a subset of the * integer range. If there is the possibility that two values can - * be unioned, this function returns TRUE. + * be unioned, this function returns %TRUE. * - * Returns: TRUE if there is a function allowing the two values to + * Returns: %TRUE if there is a function allowing the two values to * be unioned. */ gboolean @@ -4620,7 +4620,7 @@ gst_value_can_union (const GValue * value1, const GValue * value2) * * Creates a GValue corresponding to the union of @value1 and @value2. * - * Returns: TRUE if the union succeeded. + * Returns: %TRUE if the union succeeded. */ gboolean gst_value_union (GValue * dest, const GValue * value1, const GValue * value2) @@ -4688,7 +4688,7 @@ gst_value_register_union_func (GType type1, GType type2, GstValueUnionFunc func) * Two values will produce a valid intersection if they have the same * type. * - * Returns: TRUE if the values can intersect + * Returns: %TRUE if the values can intersect */ gboolean gst_value_can_intersect (const GValue * value1, const GValue * value2) @@ -4730,16 +4730,16 @@ gst_value_can_intersect (const GValue * value1, const GValue * value2) /** * gst_value_intersect: * @dest: (out caller-allocates) (transfer full): a uninitialized #GValue that will hold the calculated - * intersection value. May be NULL if the resulting set if not needed. + * intersection value. May be %NULL if the resulting set if not needed. * @value1: a value to intersect * @value2: another value to intersect * * Calculates the intersection of two values. If the values have * a non-empty intersection, the value representing the intersection - * is placed in @dest, unless NULL. If the intersection is non-empty, + * is placed in @dest, unless %NULL. If the intersection is non-empty, * @dest is not modified. * - * Returns: TRUE if the intersection is non-empty + * Returns: %TRUE if the intersection is non-empty */ gboolean gst_value_intersect (GValue * dest, const GValue * value1, @@ -4817,7 +4817,7 @@ gst_value_register_intersect_func (GType type1, GType type2, /** * gst_value_subtract: * @dest: (out caller-allocates): the destination value for the result if the - * subtraction is not empty. May be NULL, in which case the resulting set + * subtraction is not empty. May be %NULL, in which case the resulting set * will not be computed, which can give a fair speedup. * @minuend: the value to subtract from * @subtrahend: the value to subtract @@ -4887,7 +4887,7 @@ gst_value_subtract (GValue * dest, const GValue * minuend, * * Checks if it's possible to subtract @subtrahend from @minuend. * - * Returns: TRUE if a subtraction is possible + * Returns: %TRUE if a subtraction is possible */ gboolean gst_value_can_subtract (const GValue * minuend, const GValue * subtrahend) @@ -5009,7 +5009,7 @@ gst_value_move (GValue * dest, GValue * src) * * Free-function: g_free * - * Returns: (transfer full): the serialization for @value or NULL if none exists + * Returns: (transfer full): the serialization for @value or %NULL if none exists */ gchar * gst_value_serialize (const GValue * value) @@ -5058,9 +5058,9 @@ gst_value_serialize (const GValue * value) * @src: string to deserialize * * Tries to deserialize a string into the type specified by the given GValue. - * If the operation succeeds, TRUE is returned, FALSE otherwise. + * If the operation succeeds, %TRUE is returned, %FALSE otherwise. * - * Returns: TRUE on success + * Returns: %TRUE on success */ gboolean gst_value_deserialize (GValue * dest, const gchar * src) @@ -5142,9 +5142,9 @@ gst_value_is_fixed (const GValue * value) * Fixate @src into a new value @dest. * For ranges, the first element is taken. For lists and arrays, the * first item is fixated and returned. - * If @src is already fixed, this function returns FALSE. + * If @src is already fixed, this function returns %FALSE. * - * Returns: true if @dest contains a fixated version of @src. + * Returns: %TRUE if @dest contains a fixated version of @src. */ gboolean gst_value_fixate (GValue * dest, const GValue * src) @@ -5348,7 +5348,7 @@ gst_value_get_fraction_denominator (const GValue * value) * Multiplies the two #GValue items containing a #GST_TYPE_FRACTION and sets * @product to the product of the two fractions. * - * Returns: FALSE in case of an error (like integer overflow), TRUE otherwise. + * Returns: %FALSE in case of an error (like integer overflow), %TRUE otherwise. */ gboolean gst_value_fraction_multiply (GValue * product, const GValue * factor1, @@ -5382,7 +5382,7 @@ gst_value_fraction_multiply (GValue * product, const GValue * factor1, * * Subtracts the @subtrahend from the @minuend and sets @dest to the result. * - * Returns: FALSE in case of an error (like integer overflow), TRUE otherwise. + * Returns: %FALSE in case of an error (like integer overflow), %TRUE otherwise. */ gboolean gst_value_fraction_subtract (GValue * dest, |