mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2024-12-23 08:46:40 +00:00
Code Issues 1 Projects Releases Wiki Activity

docs fixes: comment macros in templates, not in headers (stupid gtk-doc)

Browse source 
Original commit message from CVS:
docs fixes: comment macros in templates, not in headers (stupid gtk-doc)
This commit is contained in:
Benjamin Otte 2003-06-29 14:57:19 +00:00
parent 6b5d184d95
commit 1211e26e59
23 changed files with 201 additions and 256 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
docs/gst/tmpl/cothreads.sgml
View file

@ -38,12 +38,6 @@ The cothread state structure
@stack_size:
@magic_number:
<!-- ##### STRUCT cothread_context ##### -->
<para>
The cothread context structure
</para>
<!-- ##### USER_FUNCTION cothread_func ##### -->
<para>
the function that will be called when the cothread starts. The function
@ -56,6 +50,17 @@ it.
@Returns: a return code
<!-- ##### STRUCT cothread_context ##### -->
<para>
The cothread context structure
</para>
@cothreads:
@main:
@current:
@mutex:
@gst_thread:
<!-- ##### MACRO COTHREAD_STARTED ##### -->
<para>
Indicates the cothread is started.

1
docs/gst/tmpl/gst.sgml
View file

@ -98,6 +98,7 @@ pipeline</ulink> and Microsoft's DirectShow for some background.
@argc:
@argv:
@popt_options:
<!-- # Unused Parameters # -->
@Returns:

1
docs/gst/tmpl/gstatomic.sgml
View file

@ -25,6 +25,7 @@ A structure that contains an integer that can be modified
atomically.
</para>
@counter:
@lock:
<!-- ##### FUNCTION gst_atomic_int_init ##### -->

8
docs/gst/tmpl/gstbin.sgml
View file

@ -91,14 +91,6 @@ gst_bin_set_pre_iterate_function() and gst_bin_set_post_iterate_function().
@Returns:
<!-- ##### MACRO gst_bin_destroy ##### -->
<para>
Free the memory allocated by this bin
</para>
@bin: the bin to free
<!-- ##### FUNCTION gst_bin_add ##### -->
<para>

10
docs/gst/tmpl/gstbuffer.sgml
View file

@ -260,6 +260,7 @@ The basic structure of a buffer.
@size:
@maxsize:
@timestamp:
@duration:
@offset:
@pool:
@pool_private:
@ -354,15 +355,6 @@ Copies the given buffer using the copy function of the parent GstData structure.
@Returns: a new #GstBuffer copy of the buffer.
<!-- ##### MACRO gst_buffer_needs_copy_on_write ##### -->
<para>
Queries if a copy needs to be ade of the buffer in order to safely write
to its data.
</para>
@buf: The buffer to query.
<!-- ##### MACRO gst_buffer_copy_on_write ##### -->
<para>
This function returns a buffer that is safe to write to.

9
docs/gst/tmpl/gstbufferpool.sgml
View file

@ -245,12 +245,3 @@ Free the given pool. This is dangerous, use gst_buffer_pool_unref() instead.
@pool:
<!-- ##### MACRO gst_buffer_pool_needs_copy_on_write ##### -->
<para>
Checks if a copy needs to be made of the bufferpool before it can
safely be modified.
</para>
@pool: The pool to query

10
docs/gst/tmpl/gstcaps.sgml
View file

@ -163,7 +163,7 @@ The gstcaps structure
Flags for this caps.
</para>
@GST_CAPS_FIXED: flag indicating the caps has no variable properties
@GST_CAPS_UNUSED:
@GST_CAPS_FLOATING: the caps is not owned by anyone
<!-- ##### MACRO GST_CAPS_FLAGS ##### -->
@ -278,14 +278,6 @@ The name used for tracing
@Returns:
<!-- ##### FUNCTION gst_caps_destroy ##### -->
<para>
</para>
@caps:
<!-- ##### FUNCTION gst_caps_ref ##### -->
<para>

76
docs/gst/tmpl/gstconfig.sgml
View file

@ -37,7 +37,21 @@ If a subsystem is disabled in GStreamer, a value is defined in
</para>
<!-- ##### MACRO GST_DISABLE_LOADSAVE_REGISTRY ##### -->
<!-- ##### MACRO GST_DISABLE_ALLOC_TRACE ##### -->
<para>
</para>
<!-- ##### MACRO GST_DISABLE_AUTOPLUG ##### -->
<para>
</para>
<!-- ##### MACRO GST_DISABLE_ENUMTYPES ##### -->
<para>
</para>
@ -52,6 +66,13 @@ If this is defined, the <link linkend="gstreamer-gstinfo">debugging subsystem
<!-- ##### MACRO GST_DISABLE_INDEX ##### -->
<para>
</para>
<!-- ##### MACRO GST_DISABLE_LOADSAVE ##### -->
<para>
@ -59,14 +80,7 @@ If this is defined, the <link linkend="gstreamer-gstinfo">debugging subsystem
<!-- ##### MACRO GST_DISABLE_TYPEFIND ##### -->
<para>
</para>
<!-- ##### MACRO GST_DISABLE_AUTOPLUG ##### -->
<!-- ##### MACRO GST_DISABLE_LOADSAVE_REGISTRY ##### -->
<para>
</para>
@ -80,6 +94,13 @@ If this is defined, the <link linkend="gstreamer-gstinfo">debugging subsystem
<!-- ##### MACRO GST_DISABLE_PLUGIN ##### -->
<para>
</para>
<!-- ##### MACRO GST_DISABLE_TRACE ##### -->
<para>
@ -87,35 +108,7 @@ If this is defined, the <link linkend="gstreamer-gstinfo">debugging subsystem
<!-- ##### MACRO GST_DISABLE_ALLOC_TRACE ##### -->
<para>
</para>
<!-- ##### MACRO GST_DISABLE_REGISTRY ##### -->
<para>
</para>
<!-- ##### MACRO GST_DISABLE_ENUMTYPES ##### -->
<para>
</para>
<!-- ##### MACRO GST_DISABLE_INDEX ##### -->
<para>
</para>
<!-- ##### MACRO GST_DISABLE_PLUGIN ##### -->
<!-- ##### MACRO GST_DISABLE_TYPEFIND ##### -->
<para>
</para>
@ -129,3 +122,10 @@ If this is defined, the <link linkend="gstreamer-gstinfo">debugging subsystem
<!-- ##### MACRO GST_DISABLE_REGISTRY ##### -->
<para>
</para>

17
docs/gst/tmpl/gstdata.sgml
View file

@ -113,14 +113,6 @@ Various flags that can be set on a GstData
@GST_DATA_READONLY: The data is readonly
@GST_DATA_FLAG_LAST: Subclasses can add additional flags starting from this offset
<!-- ##### MACRO GST_DATA_IS_READONLY ##### -->
<para>
Query if the GstData is READONLY
</para>
@data: The data to query
<!-- ##### MACRO GST_DATA_REFCOUNT ##### -->
<para>
Get access to the refcount field of the GstData
@ -191,15 +183,6 @@ Get access to the free function of the data
@Returns:
<!-- ##### FUNCTION gst_data_needs_copy_on_write ##### -->
<para>
</para>
@data:
@Returns:
<!-- ##### FUNCTION gst_data_copy_on_write ##### -->
<para>

12
docs/gst/tmpl/gstelement.sgml
View file

@ -71,16 +71,6 @@ The element object
</para>
<!-- ##### MACRO gst_element_destroy ##### -->
<para>
Destroys the element (without taking the refcount into account).
An application programmer should use #gst_object_unref instead to dispose
of an element he doesn't need anymore.
</para>
@element: a #GstElement to destroy
<!-- ##### MACRO gst_element_get_name ##### -->
<para>
Gets the name of the element.
@ -870,6 +860,8 @@ This enum defines the standard flags that an element may have.
@GST_ELEMENT_USE_THREADSAFE_PROPERTIES:
@GST_ELEMENT_SCHEDULER_PRIVATE1:
@GST_ELEMENT_SCHEDULER_PRIVATE2:
@GST_ELEMENT_LOCKED_STATE:
@GST_ELEMENT_ERROR:
@GST_ELEMENT_FLAG_LAST:
<!-- ##### MACRO GST_ELEMENT_IS_THREAD_SUGGESTED ##### -->

1
docs/gst/tmpl/gstevent.sgml
View file

@ -37,7 +37,6 @@ The different major types of events.
@GST_EVENT_FLUSH: a flush event.
@GST_EVENT_EMPTY: an empty event.
@GST_EVENT_DISCONTINUOUS: a discontinuous event to indicate the stream has a discontinuity.
@GST_EVENT_NEW_MEDIA: a new media stream is started
@GST_EVENT_QOS: a quality of service event
@GST_EVENT_SEEK: a seek event.
@GST_EVENT_SEEK_SEGMENT: a segment seek with start and stop position

2
docs/gst/tmpl/gstformat.sgml
View file

@ -26,8 +26,6 @@ Standard predefined formats
@GST_FORMAT_TIME: time in nanoseconds
@GST_FORMAT_BUFFERS: buffers
@GST_FORMAT_PERCENT: percentage of stream
@GST_FORMAT_UNITS: frames for video, samples for audio, other definitions as
defined by the media type.
<!-- ##### MACRO GST_FORMAT_PERCENT_MAX ##### -->
<para>

76
docs/gst/tmpl/gstinfo.sgml
View file

@ -461,13 +461,32 @@ default. If you want to define a default category, do it like this:
<!-- ##### MACRO GST_CAT_LEVEL_LOG ##### -->
<para>
GST_CAT_LEVEL_LOG:
Outputs a debugging message. This is the most general macro for outputting
debugging messages. You will probably want to use one of the ones described
below.
</para>
@cat:
@level:
@object:
@...:
@cat: category to use
@level: the severity of the message
@object: the #GObject the message belongs to or NULL if none
@...: A printf-style message to output
<!-- ##### MACRO GST_INFO ##### -->
<para>
Output an informational message in the default category.
</para>
@...: printf-style message to output
<!-- ##### MACRO GST_DEBUG ##### -->
<para>
Output a debugging message in the default category.
</para>
@...: printf-style message to output
<!-- ##### MACRO GST_CAT_ERROR_OBJECT ##### -->
@ -539,24 +558,6 @@ Output a warning message in the given category.
@...: printf-style message to output
<!-- ##### MACRO GST_CAT_INFO ##### -->
<para>
Output an informational message in the given category.
</para>
@cat: category to use
@...: printf-style message to output
<!-- ##### MACRO GST_CAT_DEBUG ##### -->
<para>
Output a debuggign message in the given category.
</para>
@cat: category to use
@...: printf-style message to output
<!-- ##### MACRO GST_CAT_LOG ##### -->
<para>
Output a logging message in the given category.
@ -629,19 +630,21 @@ Output a warning message in the default category.
@...: printf-style message to output
<!-- ##### MACRO GST_INFO ##### -->
<!-- ##### MACRO GST_CAT_INFO ##### -->
<para>
Output an informational message in the default category.
Output an informational message in the given category.
</para>
@cat: category to use
@...: printf-style message to output
<!-- ##### MACRO GST_DEBUG ##### -->
<!-- ##### MACRO GST_CAT_DEBUG ##### -->
<para>
Output a debugging message in the default category.
Output a debuggign message in the given category.
</para>
@cat: category to use
@...: printf-style message to output
@ -655,15 +658,26 @@ Output a logging message in the default category.
<!-- ##### MACRO GST_DEBUG_FUNCPTR ##### -->
<para>
Register a pointer to a function with its name, so it can later be used by
GST_DEBUG_FUNCPTR_NAME().
</para>
@ptr:
@ptr: The function to register
Returns: The ptr to the function.
<!-- ##### MACRO GST_DEBUG_FUNCPTR_NAME ##### -->
<para>
Retrieves the name of the function, if it was previously registered with
GST_DEBUG_FUNCPTR(). If not, it returns a description of the pointer.
<note>
<para>
Make sure you free the string after use.
</para>
</note>
</para>
@ptr:
@ptr: pointer to the function
Returns: The name of the function

8
docs/gst/tmpl/gstobject.sgml
View file

@ -229,14 +229,6 @@ Check if the object has been destroyed.
@object: the object
<!-- ##### FUNCTION gst_object_destroy ##### -->
<para>
</para>
@object: the object
<!-- ##### FUNCTION gst_object_save_thyself ##### -->
<para>

8
docs/gst/tmpl/gstpad.sgml
View file

@ -409,14 +409,6 @@ Flags for the pad.
@Returns:
<!-- ##### MACRO gst_pad_destroy ##### -->
<para>
Destroy the pad.
</para>
@pad: the pad to destroy
<!-- ##### FUNCTION gst_pad_new_from_template ##### -->
<para>

3
docs/gst/tmpl/gstparse.sgml
View file

@ -53,6 +53,9 @@ The parsing errors.
@GST_PARSE_ERROR_NO_SUCH_ELEMENT: The pipeline description contains a non existing element
@GST_PARSE_ERROR_NO_SUCH_PROPERTY: The pipeline description contains a non existing element property
@GST_PARSE_ERROR_LINK: A pad link could not be made
@GST_PARSE_ERROR_COULD_NOT_SET_PROPERTY:
@GST_PARSE_ERROR_EMPTY_BIN:
@GST_PARSE_ERROR_EMPTY:
<!-- ##### MACRO GST_PARSE_ERROR ##### -->
<para>

8
docs/gst/tmpl/gstpipeline.sgml
View file

@ -36,11 +36,3 @@ The pipeline object
@Returns:
<!-- ##### MACRO gst_pipeline_destroy ##### -->
<para>
Destroys the pipeline.
</para>
@pipeline: #GstPipeline to destroy

27
docs/gst/tmpl/gstprops.sgml
View file

@ -326,14 +326,6 @@ The name used for tracing memory allocations.
@Returns:
<!-- ##### FUNCTION gst_props_destroy ##### -->
<para>
</para>
@props:
<!-- ##### FUNCTION gst_props_ref ##### -->
<para>
@ -440,16 +432,6 @@ The name used for tracing memory allocations.
@Returns:
<!-- ##### FUNCTION gst_props_has_property ##### -->
<para>
</para>
@props:
@name:
@Returns:
<!-- ##### FUNCTION gst_props_has_fixed_property ##### -->
<para>
@ -582,6 +564,14 @@ The name used for tracing memory allocations.
@Returns:
<!-- ##### FUNCTION gst_props_entry_get_type ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION gst_props_entry_get_boolean ##### -->
<para>
@ -678,7 +668,6 @@ The name used for tracing memory allocations.
</para>
@entry:
@Returns:

115
docs/gst/tmpl/gstreamer-unused.sgml
View file

@ -256,26 +256,6 @@ GstCacheFactory
GstColorSpace
<!-- ##### SECTION ./tmpl/gstconfig.sgml:Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION ./tmpl/gstconfig.sgml:See_Also ##### -->
<para>
</para>
<!-- ##### SECTION ./tmpl/gstconfig.sgml:Short_Description ##### -->
<!-- ##### SECTION ./tmpl/gstconfig.sgml:Title ##### -->
gstconfig
<!-- ##### SECTION ./tmpl/gstdata_private.sgml:Long_Description ##### -->
<para>
@ -1783,6 +1763,13 @@ A flag indicating that SSE instructions are supported.
</para>
<!-- ##### MACRO GST_DATA_IS_READONLY ##### -->
<para>
Query if the GstData is READONLY
</para>
@data: The data to query
<!-- ##### MACRO GST_DATA_REFCOUNT_READ ##### -->
<para>
Read the current refcount value into the specified value
@ -1848,12 +1835,6 @@ to the current function, i.e. "('element')"
@format: printf-style format string
@args...: printf arguments
<!-- ##### MACRO GST_DISABLE_LOADSAVE_REGISTRY ##### -->
<para>
</para>
<!-- ##### MACRO GST_DISKSRC ##### -->
<para>
@ -7264,6 +7245,13 @@ must be defined to activate the tracing functionality.
@bin:
<!-- ##### MACRO gst_bin_destroy ##### -->
<para>
Free the memory allocated by this bin
</para>
@bin: the bin to free
<!-- ##### VARIABLE gst_bin_details ##### -->
<para>
@ -7373,6 +7361,14 @@ must be defined to activate the tracing functionality.
@buffer:
@Returns:
<!-- ##### MACRO gst_buffer_needs_copy_on_write ##### -->
<para>
Queries if a copy needs to be ade of the buffer in order to safely write
to its data.
</para>
@buf: The buffer to query.
<!-- ##### FUNCTION gst_buffer_pool_destroy ##### -->
<para>
@ -7388,6 +7384,14 @@ must be defined to activate the tracing functionality.
@pool:
@buffer:
<!-- ##### MACRO gst_buffer_pool_needs_copy_on_write ##### -->
<para>
Checks if a copy needs to be made of the bufferpool before it can
safely be modified.
</para>
@pool: The pool to query
<!-- ##### FUNCTION gst_buffer_pool_new_buffer ##### -->
<para>
@ -7693,6 +7697,13 @@ must be defined to activate the tracing functionality.
@resolver:
@user_data:
<!-- ##### FUNCTION gst_caps_destroy ##### -->
<para>
</para>
@caps:
<!-- ##### FUNCTION gst_caps_list_check_compatibility ##### -->
<para>
@ -7896,6 +7907,14 @@ must be defined to activate the tracing functionality.
@Returns:
<!-- ##### FUNCTION gst_data_needs_copy_on_write ##### -->
<para>
</para>
@data:
@Returns:
<!-- ##### FUNCTION gst_debug_print_stack_trace ##### -->
<para>
@ -7962,6 +7981,15 @@ must be defined to activate the tracing functionality.
@c:
@d:
<!-- ##### MACRO gst_element_destroy ##### -->
<para>
Destroys the element (without taking the refcount into account).
An application programmer should use #gst_object_unref instead to dispose
of an element he doesn't need anymore.
</para>
@element: a #GstElement to destroy
<!-- ##### MACRO gst_element_disconnect ##### -->
<para>
@ -8683,6 +8711,13 @@ Create new meta data.
@meta:
<!-- ##### FUNCTION gst_object_destroy ##### -->
<para>
</para>
@object: the object
<!-- ##### FUNCTION gst_object_flags_get_type ##### -->
<para>
@ -8729,6 +8764,13 @@ Create new meta data.
@b:
@c:
<!-- ##### MACRO gst_pad_destroy ##### -->
<para>
Destroy the pad.
</para>
@pad: the pad to destroy
<!-- ##### FUNCTION gst_pad_direction_get_type ##### -->
<para>
@ -9105,6 +9147,13 @@ Call the EOS function of the pad
@Returns:
<!-- ##### MACRO gst_pipeline_destroy ##### -->
<para>
Destroys the pipeline.
</para>
@pipeline: #GstPipeline to destroy
<!-- ##### VARIABLE gst_pipeline_details ##### -->
<para>
@ -9273,6 +9322,13 @@ Call the EOS function of the pad
</para>
<!-- ##### FUNCTION gst_props_destroy ##### -->
<para>
</para>
@props:
<!-- ##### FUNCTION gst_props_get_boolean ##### -->
<para>
@ -9509,6 +9565,13 @@ Call the EOS function of the pad
@sched:
<!-- ##### MACRO gst_scheduler_destroy ##### -->
<para>
Destroy the scheduler
</para>
@sched: The scheduler to destroy.
<!-- ##### FUNCTION gst_scheduler_disable_element ##### -->
<para>

8
docs/gst/tmpl/gstscheduler.sgml
View file

@ -49,14 +49,6 @@ Flags for the scheduler
@GST_SCHEDULER_FLAG_LAST: subclasses can start numbering their flags starting
from here.
<!-- ##### MACRO gst_scheduler_destroy ##### -->
<para>
Destroy the scheduler
</para>
@sched: The scheduler to destroy.
<!-- ##### FUNCTION gst_scheduler_setup ##### -->
<para>

2
docs/gst/tmpl/gstthread.sgml
View file

@ -23,9 +23,9 @@ A Thread can act as a toplevel bin as it has its own scheduler.
Thread flags:
</para>
@GST_THREAD_STATE_STARTED: The thread is started
@GST_THREAD_STATE_SPINNING: The thread is runnning
@GST_THREAD_STATE_REAPING: The thread is ending.
@GST_THREAD_MUTEX_LOCKED:
@GST_THREAD_FLAG_LAST: subclass use this to start their enumeration
<!-- ##### STRUCT GstThread ##### -->

4
docs/gst/tmpl/gstxml.sgml
View file

@ -110,10 +110,6 @@ All GstElements can be serialized to an XML presentation and subsequently loaded
</para>
@:
@:
@:
@gstxml: the object which received the signal.
@arg1:
@arg2:

34
gst/gstinfo.h
View file

@ -276,17 +276,6 @@ gchar * gst_debug_construct_term_color (guint colorinfo);
extern GstDebugCategory * GST_CAT_DEFAULT;
/**
* GST_CAT_LEVEL_LOG:
* @cat: category to use
* @level: the severity of the message
* @object: 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
* debugging messages. You will probably want to use one of the ones described
* below.
*/
#ifdef G_HAVE_ISO_VARARGS
#define GST_CAT_LEVEL_LOG(cat,level,object,...) G_STMT_START{ \
if (gst_debug_is_active ()) { \
@ -389,30 +378,7 @@ void* _gst_debug_register_funcptr (void * ptr,
gchar * ptrname);
gchar* _gst_debug_nameof_funcptr (void * ptr);
/**
* GST_DEBUG_FUNCPTR:
* @ptr: The function to register
*
* Register a pointer to a function with its name, so it can later be used by
* GST_DEBUG_FUNCPTR_NAME().
*
* Returns: The ptr to the function.
*/
#define GST_DEBUG_FUNCPTR(ptr) (_gst_debug_register_funcptr((void *)(ptr), #ptr) , ptr)
/**
* GST_DEBUG_FUNCPTR_NAME:
* @ptr: pointer to the function
*
* Retrieves the name of the function, if it was previously registered with
* GST_DEBUG_FUNCPTR(). If not, it returns a description of the pointer.
* <note>
* <para>
* Make sure you free the string after use.
* </para>
* </note>
*
* Returns: The name of the function
*/
#define GST_DEBUG_FUNCPTR_NAME(ptr) _gst_debug_nameof_funcptr((void *)ptr)
#else /* GST_DISABLE_GST_DEBUG */