Commit 8ce063f7 authored by David Schleef's avatar David Schleef

docs/gst/Makefile.am: Disable a bunch of headers from being scanned

Original commit message from CVS:
* docs/gst/Makefile.am:  Disable a bunch of headers from being scanned
* docs/gst/gstreamer-docs.sgml:  More hacking
* docs/gst/gstreamer-sections.txt:
* docs/gst/tmpl/cothreads_compat.sgml:
* docs/gst/tmpl/gstcaps.sgml:
* docs/gst/tmpl/gstclock.sgml:
* docs/gst/tmpl/gstelement.sgml:
* docs/gst/tmpl/gstevent.sgml:
* docs/gst/tmpl/gstpad.sgml:
* docs/gst/tmpl/gstutils.sgml:
* docs/gst/tmpl/gstxml.sgml:
* docs/gst/tmpl/gthread-cothreads.sgml:
* docs/random/ds/0.9-suggested-changes:
* gst/elements/gstfakesink.h: doc fixes
* gst/elements/gstfakesrc.h: doc fixes
* gst/gstcaps.c: doc fixes
* gst/gstcaps.h: doc fixes
* gst/gstelement.c: doc fixes
* gst/gstelement.h: doc fixes
* gst/gstindex.c: doc fixes
* gst/gstinfo.c: doc fixes
* gst/gstpad.c: doc fixes
* gst/gstpad.h: doc fixes
* gst/gstplugin.c: doc fixes
* gst/gsttypefind.h: doc fixes
* gst/gsturi.c: doc fixes
* gst/gstvalue.c: doc fixes
parent f8d4198b
2004-03-29 David Schleef <ds@schleef.org>
* docs/gst/Makefile.am: Disable a bunch of headers from being scanned
* docs/gst/gstreamer-docs.sgml: More hacking
* docs/gst/gstreamer-sections.txt:
* docs/gst/tmpl/cothreads_compat.sgml:
* docs/gst/tmpl/gstcaps.sgml:
* docs/gst/tmpl/gstclock.sgml:
* docs/gst/tmpl/gstelement.sgml:
* docs/gst/tmpl/gstevent.sgml:
* docs/gst/tmpl/gstpad.sgml:
* docs/gst/tmpl/gstutils.sgml:
* docs/gst/tmpl/gstxml.sgml:
* docs/gst/tmpl/gthread-cothreads.sgml:
* docs/random/ds/0.9-suggested-changes:
* gst/elements/gstfakesink.h: doc fixes
* gst/elements/gstfakesrc.h: doc fixes
* gst/gstcaps.c: doc fixes
* gst/gstcaps.h: doc fixes
* gst/gstelement.c: doc fixes
* gst/gstelement.h: doc fixes
* gst/gstindex.c: doc fixes
* gst/gstinfo.c: doc fixes
* gst/gstpad.c: doc fixes
* gst/gstpad.h: doc fixes
* gst/gstplugin.c: doc fixes
* gst/gsttypefind.h: doc fixes
* gst/gsturi.c: doc fixes
* gst/gstvalue.c: doc fixes
2004-03-29 Colin Walters <walters@redhat.com>
* gst/registries/gstxmlregistry.c (get_time)
......
......@@ -64,7 +64,34 @@ CFILE_GLOB=$(DOC_SOURCE_DIR)/*.c
# $(top_builddir)/gst/schedulers/libgstbasicomegascheduler.la
# Header files to ignore when scanning.
IGNORE_HFILES=
IGNORE_HFILES= \
gettext.h \
gst-i18n-lib.h \
gst-i18n-app.h \
gst_private.h \
gstatomic_impl.h \
gstdata_private.h \
gstarch.h \
cothreads.h \
schedulers/cothreads_compat.h \
schedulers/gthread-cothreads.h \
parse/types.h \
elements/gstaggregator.h \
elements/gstbufferstore.h \
elements/gstfakesink.h \
elements/gstfakesrc.h \
elements/gstfdsink.h \
elements/gstfdsrc.h \
elements/gstfilesink.h \
elements/gstfilesrc.h \
elements/gstidentity.h \
elements/gstmd5sink.h \
elements/gstmultifilesrc.h \
elements/gstpipefilter.h \
elements/gstshaper.h \
elements/gststatistics.h \
elements/gsttee.h \
elements/gsttypefind.h
# Images to copy into HTML directory.
HTML_IMAGES =
......
......@@ -47,7 +47,6 @@
<!-- these are elements without API docs
<!ENTITY GstQueue SYSTEM "xml/gstqueue.xml">
-->
<!ENTITY cothreads SYSTEM "xml/cothreads.xml">
<!ENTITY GstAggregator SYSTEM "xml/gstaggregator.xml">
<!ENTITY GstFakeSrc SYSTEM "xml/gstfakesrc.xml">
......@@ -125,7 +124,6 @@ with some more specialized elements.</para>
<para>
</para>
&cothreads;
&GstAtomic;
&GstMemChunk;
......
......@@ -174,6 +174,7 @@ gst_clock_reset
gst_clock_handle_discont
gst_clock_get_time
gst_clock_get_event_time
gst_clock_get_event_time_delay
gst_clock_get_next_id
gst_clock_new_single_shot_id
gst_clock_new_periodic_id
......@@ -307,6 +308,7 @@ gst_element_clock_wait
gst_element_get_time
gst_element_wait
gst_element_set_time
gst_element_set_time_delay
gst_element_adjust_time
gst_element_is_indexable
gst_element_set_index
......@@ -394,6 +396,7 @@ GST_ELEMENT_GET_CLASS
<SECTION>
<FILE>gstevent</FILE>
GstEventType
GST_EVENT_ANY
GST_EVENT_TRACE_NAME
GST_EVENT_TYPE
GST_EVENT_TIMESTAMP
......@@ -1465,32 +1468,6 @@ GST_XML_REGISTRY_CLASS
GST_IS_XML_REGISTRY_CLASS
</SECTION>
<SECTION>
<FILE>cothreads</FILE>
cothread_state
cothread_context
cothread_func
COTHREAD_STARTED
COTHREAD_DESTROYED
cothread_context_init
cothread_context_free
cothread_context_set_data
cothread_context_get_data
cothread_create
cothread_free
cothread_setfunc
cothread_stop
cothread_switch
cothread_set_private
cothread_get_private
cothread_lock
cothread_trylock
cothread_unlock
cothread_main
cothread_current_main
cothread_current
</SECTION>
<SECTION>
<FILE>gst</FILE>
gst_init
......@@ -1504,46 +1481,6 @@ gst_main
gst_main_quit
</SECTION>
<SECTION>
<FILE>gst_private</FILE>
GST_CAT_GST_INIT
GST_CAT_COTHREADS
GST_CAT_COTHREAD_SWITCH
GST_CAT_AUTOPLUG
GST_CAT_AUTOPLUG_ATTEMPT
GST_CAT_PARENTAGE
GST_CAT_STATES
GST_CAT_PLANNING
GST_CAT_SCHEDULING
GST_CAT_DATAFLOW
GST_CAT_BUFFER
GST_CAT_CAPS
GST_CAT_CLOCK
GST_CAT_ELEMENT_PADS
GST_CAT_PADS
GST_CAT_PIPELINE
GST_CAT_PLUGIN_LOADING
GST_CAT_PLUGIN_INFO
GST_CAT_PROPERTIES
GST_CAT_THREAD
GST_CAT_XML
GST_CAT_NEGOTIATION
GST_CAT_REFCOUNTING
GST_CAT_ERROR_SYSTEM
GST_CAT_EVENT
GST_CAT_PARAMS
GST_CAT_CALL_TRACE
</SECTION>
<SECTION>
<FILE>gstarch</FILE>
GST_ARCH_SET_SP
GST_ARCH_CALL
GST_ARCH_SETUP_STACK
GST_ARCH_PRESETJMP
USE_MAKECONTEXT
</SECTION>
<SECTION>
<FILE>gstatomic</FILE>
gst_vgint
......@@ -1557,14 +1494,6 @@ gst_atomic_int_inc
gst_atomic_int_dec_and_test
</SECTION>
<SECTION>
<FILE>gstatomic_impl</FILE>
SMP_LOCK
SMP_SYNC
SMP_ISYNC
PPC405_ERR77
</SECTION>
<SECTION>
<FILE>gstenumtypes</FILE>
gst_object_flags_get_type
......@@ -1696,10 +1625,6 @@ GstCPUFlags
gst_cpu_get_flags
</SECTION>
<SECTION>
<FILE>gstdata_private</FILE>
</SECTION>
<SECTION>
<FILE>gstfilter</FILE>
GstFilterFunc
......@@ -2080,20 +2005,6 @@ GST_VERSION_MICRO
gst_version
</SECTION>
<SECTION>
<FILE>gettext</FILE>
gettext
dgettext
dcgettext
ngettext
dngettext
dcngettext
textdomain
bindtextdomain
bind_textdomain_codeset
gettext_noop
</SECTION>
<SECTION>
<FILE>gsterror</FILE>
GstCoreError
......@@ -2114,18 +2025,6 @@ gst_resource_error_quark
gst_library_error_quark
</SECTION>
<SECTION>
<FILE>gst-i18n-app</FILE>
_
N_
</SECTION>
<SECTION>
<FILE>gst-i18n-lib</FILE>
_
N_
</SECTION>
<SECTION>
<FILE>gstsearchfuncs</FILE>
GST_AUTOPLUG_MAX_COST
......@@ -2161,6 +2060,7 @@ gst_parse_chain_free
<SECTION>
<FILE>cothreads_compat</FILE>
COTHREADS_TYPE
COTHREADS_NAME
COTHREADS_NAME_CAPITAL
cothread
......@@ -2180,6 +2080,7 @@ do_cothread_get_main
<SECTION>
<FILE>gthread-cothreads</FILE>
COTHREADS_TYPE
COTHREADS_NAME
COTHREADS_NAME_CAPITAL
cothread_func
......@@ -2190,5 +2091,6 @@ do_cothread_lock
do_cothread_unlock
do_cothread_get_current
do_cothread_get_main
do_cothread_setfunc
</SECTION>
......@@ -14,6 +14,13 @@ cothreads_compat
</para>
<!-- ##### MACRO COTHREADS_TYPE ##### -->
<para>
</para>
<!-- ##### MACRO COTHREADS_NAME ##### -->
<para>
......
......@@ -170,8 +170,10 @@ Structure describing sets of media formats
</para>
@caps:
@static_caps:
@Returns:
<!-- # Unused Parameters # -->
@caps:
<!-- ##### FUNCTION gst_caps_append ##### -->
......@@ -188,8 +190,10 @@ Structure describing sets of media formats
</para>
@caps1:
@caps:
@structure:
<!-- # Unused Parameters # -->
@caps1:
<!-- ##### FUNCTION gst_caps_split_one ##### -->
......
......@@ -329,6 +329,16 @@ Get the clock flags
@Returns:
<!-- ##### FUNCTION gst_clock_get_event_time_delay ##### -->
<para>
</para>
@clock:
@delay:
@Returns:
<!-- ##### FUNCTION gst_clock_get_next_id ##### -->
<para>
......
......@@ -591,6 +591,16 @@ Sets the parent of an element.
@time:
<!-- ##### FUNCTION gst_element_set_time_delay ##### -->
<para>
</para>
@element:
@time:
@delay:
<!-- ##### FUNCTION gst_element_adjust_time ##### -->
<para>
......@@ -1175,10 +1185,12 @@ Sets the parent of an element.
</para>
@plugin:
@elementname:
@name:
@rank:
@type:
@Returns:
<!-- # Unused Parameters # -->
@elementname:
<!-- ##### FUNCTION gst_element_factory_find ##### -->
......
......@@ -50,6 +50,13 @@ The different major types of events.
@GST_EVENT_NAVIGATION:
@GST_EVENT_TAG:
<!-- ##### MACRO GST_EVENT_ANY ##### -->
<para>
</para>
<!-- ##### MACRO GST_EVENT_TRACE_NAME ##### -->
<para>
The name used for memory allocation tracing
......
......@@ -1048,6 +1048,8 @@ Check if the properties of the padtemplate are fixed
</para>
@pad:
@bufalloc:
<!-- # Unused Parameters # -->
@bufferalloc:
......@@ -1718,8 +1720,10 @@ Remove the probe from the pad
</para>
@templ:
@pad_template:
@Returns:
<!-- # Unused Parameters # -->
@templ:
<!-- ##### FUNCTION gst_pad_template_get_caps ##### -->
......
......@@ -70,6 +70,56 @@ Some convenience functions
@type:
@type_as_function:
@parent_type:
@\
parent_type_macro:
@\
parent_type_macro:
@\
parent_type_macro:
@\
parent_type_macro:
@\
parent_type_macro:
@\
parent_type_macro:
@\
parent_type_macro:
@\
parent_type_macro:
@\
parent_type_macro:
@\
parent_type_macro:
@\
parent_type_macro:
@\
parent_type_macro:
@\
parent_type_macro:
@\
parent_type_macro:
@\
parent_type_macro:
@\
parent_type_macro:
@\
parent_type_macro:
@\
parent_type_macro:
@\
parent_type_macro:
@\
parent_type_macro:
@\
parent_type_macro:
@\
parent_type_macro:
@\
parent_type_macro:
@\
parent_type_macro:
@\
parent_type_macro:
@\
parent_type_macro:
@\
......
......@@ -115,6 +115,10 @@ GstXML
</para>
@:
@:
@:
@gstxml: the object which received the signal.
@arg1:
@arg2:
......@@ -124,7 +128,7 @@ GstXML
</para>
@:
@:
@:
@gstxml: the object which received the signal.
@arg1:
@arg2:
......@@ -14,6 +14,13 @@ gthread-cothreads
</para>
<!-- ##### MACRO COTHREADS_TYPE ##### -->
<para>
</para>
<!-- ##### MACRO COTHREADS_NAME ##### -->
<para>
......@@ -33,9 +40,12 @@ gthread-cothreads
</para>
@Varargs:
@Param2:
@Returns:
<!-- # Unused Parameters # -->
@argc:
@argv:
@Returns:
<!-- ##### TYPEDEF cothread ##### -->
......@@ -99,3 +109,15 @@ gthread-cothreads
@context:
<!-- ##### MACRO do_cothread_setfunc ##### -->
<para>
</para>
@cothread:
@context:
@func:
@argc:
@argv:
......@@ -34,6 +34,8 @@ API:
- caps should have a flag on fields to indicate that the field is optional
- remove gst_pad_select() and add gst_pad_pull_many(), which pulls one
buffer from one of many pads
caps:
......
......@@ -47,7 +47,7 @@ typedef enum {
FAKESINK_STATE_ERROR_PAUSED_PLAYING,
FAKESINK_STATE_ERROR_PLAYING_PAUSED,
FAKESINK_STATE_ERROR_PAUSED_READY,
FAKESINK_STATE_ERROR_READY_NULL,
FAKESINK_STATE_ERROR_READY_NULL
} GstFakeSinkStateError;
typedef struct _GstFakeSink GstFakeSink;
......
......@@ -42,7 +42,7 @@ typedef enum {
typedef enum {
FAKESRC_DATA_ALLOCATE = 1,
FAKESRC_DATA_SUBBUFFER,
FAKESRC_DATA_SUBBUFFER
} GstFakeSrcDataType;
typedef enum {
......
......@@ -107,6 +107,7 @@ gst_caps_new_any (void)
/**
* gst_caps_new_simple:
* @media_type: the media type of the structure
* @fieldname: first field to set
* @...: additional arguments
*
* Creates a new #GstCaps that contains one #GstStructure. The
......@@ -161,7 +162,7 @@ gst_caps_new_full (GstStructure * struct1, ...)
/**
* gst_caps_new_full_valist:
* @struct1: the first structure to add
* @structure: the first structure to add
* @var_args: additional structures to add
*
* Creates a new #GstCaps and adds all the structures listed as
......@@ -310,7 +311,7 @@ gst_caps_append (GstCaps * caps1, GstCaps * caps2)
* @caps: the #GstCaps that will be appended to
* @structure: the #GstStructure to append
*
* Appends @structure to @caps1. The structure is not copied; @caps1
* Appends @structure to @caps. The structure is not copied; @caps
* becomes the owner of @structure.
*/
void
......@@ -1164,7 +1165,7 @@ gst_caps_from_string_inplace (GstCaps * caps, const gchar * string)
/**
* gst_caps_from_string:
* @caps: a string to convert to #GstCaps
* @string: a string to convert to #GstCaps
*
* Converts @caps from a string representation.
*
......
......@@ -81,12 +81,12 @@ GstCaps * gst_caps_new_full_valist (GstStru
va_list var_args);
GstCaps * gst_caps_copy (const GstCaps *caps);
void gst_caps_free (GstCaps *caps);
G_CONST_RETURN GstCaps * gst_static_caps_get (GstStaticCaps *caps);
G_CONST_RETURN GstCaps * gst_static_caps_get (GstStaticCaps *static_caps);
/* manipulation */
void gst_caps_append (GstCaps *caps1,
GstCaps *caps2);
void gst_caps_append_structure (GstCaps *caps1,
void gst_caps_append_structure (GstCaps *caps,
GstStructure *structure);
GstCaps * gst_caps_split_one (GstCaps *caps);
int gst_caps_get_size (const GstCaps *caps);
......
......@@ -931,7 +931,7 @@ gst_element_set_time_delay (GstElement * element, GstClockTime time,
/**
* gst_element_adjust_time:
* @element: element to adjust time on
* @difference: difference to adjust
* @diff: difference to adjust
*
* Adjusts the current time of the element by the specified difference. This
* function can be used when handling discont events. You can only call this
......@@ -2446,8 +2446,11 @@ _gst_element_error_printf (const gchar * format, ...)
* @code: the error code belonging to the domain
* @message: an allocated message to be used as a replacement for the default
* message connected to code, or NULL
* debug: an allocated debug message to be used as a replacement for the
* @debug: an allocated debug message to be used as a replacement for the
* default debugging information, or NULL
* @file: source filename
* @function: source function
* @line: source line
*
* Signals an error condition on an element.
* This function is used internally by elements.
......
......@@ -433,7 +433,7 @@ struct _GstElementFactoryClass {
GType gst_element_factory_get_type (void);
gboolean gst_element_register (GstPlugin *plugin,
const gchar *elementname,
const gchar *name,
guint rank,
GType type);
......
......@@ -412,6 +412,8 @@ gst_index_set_resolver (GstIndex * index,
* @entry: the entry to copy
*
* Copies an entry and returns the result.
*
* Returns:
*/
GstIndexEntry *
gst_index_entry_copy (GstIndexEntry * entry)
......
......@@ -319,6 +319,8 @@ gst_debug_log_valist (GstDebugCategory * category, GstDebugLevel level,
*