From 1211e26e593c3df2cc58dcd05c4742b3f115b244 Mon Sep 17 00:00:00 2001 From: Benjamin Otte Date: Sun, 29 Jun 2003 14:57:19 +0000 Subject: [PATCH] docs fixes: comment macros in templates, not in headers (stupid gtk-doc) Original commit message from CVS: docs fixes: comment macros in templates, not in headers (stupid gtk-doc) --- docs/gst/tmpl/cothreads.sgml | 17 ++-- docs/gst/tmpl/gst.sgml | 1 + docs/gst/tmpl/gstatomic.sgml | 1 + docs/gst/tmpl/gstbin.sgml | 8 -- docs/gst/tmpl/gstbuffer.sgml | 10 +-- docs/gst/tmpl/gstbufferpool.sgml | 9 --- docs/gst/tmpl/gstcaps.sgml | 10 +-- docs/gst/tmpl/gstconfig.sgml | 76 +++++++++--------- docs/gst/tmpl/gstdata.sgml | 17 ---- docs/gst/tmpl/gstelement.sgml | 12 +-- docs/gst/tmpl/gstevent.sgml | 1 - docs/gst/tmpl/gstformat.sgml | 2 - docs/gst/tmpl/gstinfo.sgml | 76 ++++++++++-------- docs/gst/tmpl/gstobject.sgml | 8 -- docs/gst/tmpl/gstpad.sgml | 8 -- docs/gst/tmpl/gstparse.sgml | 3 + docs/gst/tmpl/gstpipeline.sgml | 8 -- docs/gst/tmpl/gstprops.sgml | 27 ++----- docs/gst/tmpl/gstreamer-unused.sgml | 115 +++++++++++++++++++++------- docs/gst/tmpl/gstscheduler.sgml | 8 -- docs/gst/tmpl/gstthread.sgml | 2 +- docs/gst/tmpl/gstxml.sgml | 4 - gst/gstinfo.h | 34 -------- 23 files changed, 201 insertions(+), 256 deletions(-) diff --git a/docs/gst/tmpl/cothreads.sgml b/docs/gst/tmpl/cothreads.sgml index c69db192ee..fb1d1a52de 100644 --- a/docs/gst/tmpl/cothreads.sgml +++ b/docs/gst/tmpl/cothreads.sgml @@ -38,12 +38,6 @@ The cothread state structure @stack_size: @magic_number: - - -The cothread context structure - - - the function that will be called when the cothread starts. The function @@ -56,6 +50,17 @@ it. @Returns: a return code + + +The cothread context structure + + +@cothreads: +@main: +@current: +@mutex: +@gst_thread: + Indicates the cothread is started. diff --git a/docs/gst/tmpl/gst.sgml b/docs/gst/tmpl/gst.sgml index c6bf6a11db..0aa658138f 100644 --- a/docs/gst/tmpl/gst.sgml +++ b/docs/gst/tmpl/gst.sgml @@ -98,6 +98,7 @@ pipeline and Microsoft's DirectShow for some background. @argc: @argv: @popt_options: + @Returns: diff --git a/docs/gst/tmpl/gstatomic.sgml b/docs/gst/tmpl/gstatomic.sgml index 79380e6a99..502e939ae7 100644 --- a/docs/gst/tmpl/gstatomic.sgml +++ b/docs/gst/tmpl/gstatomic.sgml @@ -25,6 +25,7 @@ A structure that contains an integer that can be modified atomically. +@counter: @lock: diff --git a/docs/gst/tmpl/gstbin.sgml b/docs/gst/tmpl/gstbin.sgml index 96f7b179f7..985b02b417 100644 --- a/docs/gst/tmpl/gstbin.sgml +++ b/docs/gst/tmpl/gstbin.sgml @@ -91,14 +91,6 @@ gst_bin_set_pre_iterate_function() and gst_bin_set_post_iterate_function(). @Returns: - - -Free the memory allocated by this bin - - -@bin: the bin to free - - diff --git a/docs/gst/tmpl/gstbuffer.sgml b/docs/gst/tmpl/gstbuffer.sgml index 4aa55b0fc7..824c1e5b1e 100644 --- a/docs/gst/tmpl/gstbuffer.sgml +++ b/docs/gst/tmpl/gstbuffer.sgml @@ -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. - - -Queries if a copy needs to be ade of the buffer in order to safely write -to its data. - - -@buf: The buffer to query. - - This function returns a buffer that is safe to write to. diff --git a/docs/gst/tmpl/gstbufferpool.sgml b/docs/gst/tmpl/gstbufferpool.sgml index 5072f9f903..53a0ce99f5 100644 --- a/docs/gst/tmpl/gstbufferpool.sgml +++ b/docs/gst/tmpl/gstbufferpool.sgml @@ -245,12 +245,3 @@ Free the given pool. This is dangerous, use gst_buffer_pool_unref() instead. @pool: - - -Checks if a copy needs to be made of the bufferpool before it can -safely be modified. - - -@pool: The pool to query - - diff --git a/docs/gst/tmpl/gstcaps.sgml b/docs/gst/tmpl/gstcaps.sgml index 6673aae877..0b7c1e5385 100644 --- a/docs/gst/tmpl/gstcaps.sgml +++ b/docs/gst/tmpl/gstcaps.sgml @@ -163,7 +163,7 @@ The gstcaps structure Flags for this caps. -@GST_CAPS_FIXED: flag indicating the caps has no variable properties +@GST_CAPS_UNUSED: @GST_CAPS_FLOATING: the caps is not owned by anyone @@ -278,14 +278,6 @@ The name used for tracing @Returns: - - - - - -@caps: - - diff --git a/docs/gst/tmpl/gstconfig.sgml b/docs/gst/tmpl/gstconfig.sgml index fab53c4419..26c2e33861 100644 --- a/docs/gst/tmpl/gstconfig.sgml +++ b/docs/gst/tmpl/gstconfig.sgml @@ -37,7 +37,21 @@ If a subsystem is disabled in GStreamer, a value is defined in - + + + + + + + + + + + + + + + @@ -52,6 +66,13 @@ If this is defined, the debugging subsystem + + + + + + + @@ -59,14 +80,7 @@ If this is defined, the debugging subsystem - - - - - - - - + @@ -80,6 +94,13 @@ If this is defined, the debugging subsystem + + + + + + + @@ -87,35 +108,7 @@ If this is defined, the debugging subsystem - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + @@ -129,3 +122,10 @@ If this is defined, the debugging subsystem + + + + + + + diff --git a/docs/gst/tmpl/gstdata.sgml b/docs/gst/tmpl/gstdata.sgml index a2570a2626..16aced475e 100644 --- a/docs/gst/tmpl/gstdata.sgml +++ b/docs/gst/tmpl/gstdata.sgml @@ -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 - - -Query if the GstData is READONLY - - -@data: The data to query - - Get access to the refcount field of the GstData @@ -191,15 +183,6 @@ Get access to the free function of the data @Returns: - - - - - -@data: -@Returns: - - diff --git a/docs/gst/tmpl/gstelement.sgml b/docs/gst/tmpl/gstelement.sgml index 8800f9554f..6e40541ecd 100644 --- a/docs/gst/tmpl/gstelement.sgml +++ b/docs/gst/tmpl/gstelement.sgml @@ -71,16 +71,6 @@ The element object - - -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. - - -@element: a #GstElement to destroy - - 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: diff --git a/docs/gst/tmpl/gstevent.sgml b/docs/gst/tmpl/gstevent.sgml index 421c7631cc..7e8fe534e9 100644 --- a/docs/gst/tmpl/gstevent.sgml +++ b/docs/gst/tmpl/gstevent.sgml @@ -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 diff --git a/docs/gst/tmpl/gstformat.sgml b/docs/gst/tmpl/gstformat.sgml index 3d7c6d9d05..6b21fedbdd 100644 --- a/docs/gst/tmpl/gstformat.sgml +++ b/docs/gst/tmpl/gstformat.sgml @@ -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. diff --git a/docs/gst/tmpl/gstinfo.sgml b/docs/gst/tmpl/gstinfo.sgml index 5efd90917f..e2650f43c2 100644 --- a/docs/gst/tmpl/gstinfo.sgml +++ b/docs/gst/tmpl/gstinfo.sgml @@ -461,13 +461,32 @@ default. If you want to define a default category, do it like this: - +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. -@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 + + + + +Output an informational message in the default category. + + +@...: printf-style message to output + + + + +Output a debugging message in the default category. + + +@...: printf-style message to output @@ -539,24 +558,6 @@ Output a warning message in the given category. @...: printf-style message to output - - -Output an informational message in the given category. - - -@cat: category to use -@...: printf-style message to output - - - - -Output a debuggign message in the given category. - - -@cat: category to use -@...: printf-style message to output - - 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 - + -Output an informational message in the default category. +Output an informational message in the given category. +@cat: category to use @...: printf-style message to output - + -Output a debugging message in the default category. +Output a debuggign message in the given category. +@cat: category to use @...: printf-style message to output @@ -655,15 +658,26 @@ Output a logging message in the default category. - +Register a pointer to a function with its name, so it can later be used by +GST_DEBUG_FUNCPTR_NAME(). -@ptr: +@ptr: The function to register +Returns: The ptr 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. + + +Make sure you free the string after use. + + -@ptr: +@ptr: pointer to the function +Returns: The name of the function + + diff --git a/docs/gst/tmpl/gstobject.sgml b/docs/gst/tmpl/gstobject.sgml index c1e9adc03b..52616a2215 100644 --- a/docs/gst/tmpl/gstobject.sgml +++ b/docs/gst/tmpl/gstobject.sgml @@ -229,14 +229,6 @@ Check if the object has been destroyed. @object: the object - - - - - -@object: the object - - diff --git a/docs/gst/tmpl/gstpad.sgml b/docs/gst/tmpl/gstpad.sgml index a376fbe751..11acfd6a33 100644 --- a/docs/gst/tmpl/gstpad.sgml +++ b/docs/gst/tmpl/gstpad.sgml @@ -409,14 +409,6 @@ Flags for the pad. @Returns: - - -Destroy the pad. - - -@pad: the pad to destroy - - diff --git a/docs/gst/tmpl/gstparse.sgml b/docs/gst/tmpl/gstparse.sgml index 416c892ac8..bcaffe3b00 100644 --- a/docs/gst/tmpl/gstparse.sgml +++ b/docs/gst/tmpl/gstparse.sgml @@ -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: diff --git a/docs/gst/tmpl/gstpipeline.sgml b/docs/gst/tmpl/gstpipeline.sgml index a07b2dafe2..ce9c33cc36 100644 --- a/docs/gst/tmpl/gstpipeline.sgml +++ b/docs/gst/tmpl/gstpipeline.sgml @@ -36,11 +36,3 @@ The pipeline object @Returns: - - -Destroys the pipeline. - - -@pipeline: #GstPipeline to destroy - - diff --git a/docs/gst/tmpl/gstprops.sgml b/docs/gst/tmpl/gstprops.sgml index 24e1c95b45..0e1f8bdbf7 100644 --- a/docs/gst/tmpl/gstprops.sgml +++ b/docs/gst/tmpl/gstprops.sgml @@ -326,14 +326,6 @@ The name used for tracing memory allocations. @Returns: - - - - - -@props: - - @@ -440,16 +432,6 @@ The name used for tracing memory allocations. @Returns: - - - - - -@props: -@name: -@Returns: - - @@ -582,6 +564,14 @@ The name used for tracing memory allocations. @Returns: + + + + + +@Returns: + + @@ -678,7 +668,6 @@ The name used for tracing memory allocations. -@entry: @Returns: diff --git a/docs/gst/tmpl/gstreamer-unused.sgml b/docs/gst/tmpl/gstreamer-unused.sgml index 4fc1913469..2b293643a2 100644 --- a/docs/gst/tmpl/gstreamer-unused.sgml +++ b/docs/gst/tmpl/gstreamer-unused.sgml @@ -256,26 +256,6 @@ GstCacheFactory GstColorSpace - - - - - - - - - - - - - - - - - -gstconfig - - @@ -1783,6 +1763,13 @@ A flag indicating that SSE instructions are supported. + + +Query if the GstData is READONLY + + +@data: The data to query + 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 - - - - - - @@ -7264,6 +7245,13 @@ must be defined to activate the tracing functionality. @bin: + + +Free the memory allocated by this bin + + +@bin: the bin to free + @@ -7373,6 +7361,14 @@ must be defined to activate the tracing functionality. @buffer: @Returns: + + +Queries if a copy needs to be ade of the buffer in order to safely write +to its data. + + +@buf: The buffer to query. + @@ -7388,6 +7384,14 @@ must be defined to activate the tracing functionality. @pool: @buffer: + + +Checks if a copy needs to be made of the bufferpool before it can +safely be modified. + + +@pool: The pool to query + @@ -7693,6 +7697,13 @@ must be defined to activate the tracing functionality. @resolver: @user_data: + + + + + +@caps: + @@ -7896,6 +7907,14 @@ must be defined to activate the tracing functionality. @Returns: + + + + + +@data: +@Returns: + @@ -7962,6 +7981,15 @@ must be defined to activate the tracing functionality. @c: @d: + + +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. + + +@element: a #GstElement to destroy + @@ -8683,6 +8711,13 @@ Create new meta data. @meta: + + + + + +@object: the object + @@ -8729,6 +8764,13 @@ Create new meta data. @b: @c: + + +Destroy the pad. + + +@pad: the pad to destroy + @@ -9105,6 +9147,13 @@ Call the EOS function of the pad @Returns: + + +Destroys the pipeline. + + +@pipeline: #GstPipeline to destroy + @@ -9273,6 +9322,13 @@ Call the EOS function of the pad + + + + + +@props: + @@ -9509,6 +9565,13 @@ Call the EOS function of the pad @sched: + + +Destroy the scheduler + + +@sched: The scheduler to destroy. + diff --git a/docs/gst/tmpl/gstscheduler.sgml b/docs/gst/tmpl/gstscheduler.sgml index dad4afb33d..bbcc721065 100644 --- a/docs/gst/tmpl/gstscheduler.sgml +++ b/docs/gst/tmpl/gstscheduler.sgml @@ -49,14 +49,6 @@ Flags for the scheduler @GST_SCHEDULER_FLAG_LAST: subclasses can start numbering their flags starting from here. - - -Destroy the scheduler - - -@sched: The scheduler to destroy. - - diff --git a/docs/gst/tmpl/gstthread.sgml b/docs/gst/tmpl/gstthread.sgml index ab78f0827b..6d7021906d 100644 --- a/docs/gst/tmpl/gstthread.sgml +++ b/docs/gst/tmpl/gstthread.sgml @@ -23,9 +23,9 @@ A Thread can act as a toplevel bin as it has its own scheduler. Thread flags: -@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 diff --git a/docs/gst/tmpl/gstxml.sgml b/docs/gst/tmpl/gstxml.sgml index 73bfbd51f8..32d00bc1f9 100644 --- a/docs/gst/tmpl/gstxml.sgml +++ b/docs/gst/tmpl/gstxml.sgml @@ -110,10 +110,6 @@ All GstElements can be serialized to an XML presentation and subsequently loaded -@: -@: -@: - @gstxml: the object which received the signal. @arg1: @arg2: diff --git a/gst/gstinfo.h b/gst/gstinfo.h index 08f54cec81..8364bdac91 100644 --- a/gst/gstinfo.h +++ b/gst/gstinfo.h @@ -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. - * - * - * Make sure you free the string after use. - * - * - * - * Returns: The name of the function - */ #define GST_DEBUG_FUNCPTR_NAME(ptr) _gst_debug_nameof_funcptr((void *)ptr) #else /* GST_DISABLE_GST_DEBUG */