More docs for configuration options, add docs to gtk-doc.

Original commit message from CVS:
* docs/gst/gstreamer-sections.txt:
* gst/gstconfig.h.in:
More docs for configuration options, add docs to gtk-doc.
This commit is contained in:
Stefan Kost 2006-07-10 19:35:32 +00:00
parent c78bf00ce1
commit c687975a3c
3 changed files with 43 additions and 15 deletions

View file

@ -1,3 +1,9 @@
2006-07-10 Stefan Kost <ensonic@users.sf.net>
* docs/gst/gstreamer-sections.txt:
* gst/gstconfig.h.in:
More docs for configuration options, add docs to gtk-doc.
2006-07-10 Stefan Kost <ensonic@users.sf.net> 2006-07-10 Stefan Kost <ensonic@users.sf.net>
* gst/Makefile.am: * gst/Makefile.am:

View file

@ -365,8 +365,6 @@ gst_clock_return_get_type
<SECTION> <SECTION>
<FILE>gstconfig</FILE> <FILE>gstconfig</FILE>
<SUBSECTION Private>
GST_DISABLE_LOADSAVE_REGISTRY
GST_DISABLE_GST_DEBUG GST_DISABLE_GST_DEBUG
GST_DISABLE_LOADSAVE GST_DISABLE_LOADSAVE
GST_DISABLE_PARSE GST_DISABLE_PARSE
@ -377,6 +375,8 @@ GST_DISABLE_ENUMTYPES
GST_DISABLE_INDEX GST_DISABLE_INDEX
GST_DISABLE_PLUGIN GST_DISABLE_PLUGIN
GST_DISABLE_URI GST_DISABLE_URI
<SUBSECTION Private>
GST_DISABLE_LOADSAVE_REGISTRY
GST_HAVE_GLIB_2_8 GST_HAVE_GLIB_2_8
GST_PTR_FORMAT GST_PTR_FORMAT
GST_EXPORT GST_EXPORT

View file

@ -76,43 +76,65 @@
/***** disabling of subsystems *****/ /***** disabling of subsystems *****/
/* configures the inclusion of the debugging subsystem */ /**
* GST_DISABLE_GST_DEBUG:
*
* Configures the inclusion of the debugging subsystem
*/
@GST_DISABLE_GST_DEBUG_DEFINE@ @GST_DISABLE_GST_DEBUG_DEFINE@
/* configures the inclusion of the plugin graph xml-serialisation /**
* GST_DISABLE_LOADSAVE:
*
* Configures the inclusion of the plugin graph xml-serialisation
* (was used in 0.8 by gst-editor) * (was used in 0.8 by gst-editor)
*/ */
@GST_DISABLE_LOADSAVE_DEFINE@ @GST_DISABLE_LOADSAVE_DEFINE@
/* configures the inclusion of the gst-lauch parser */ /**
* GST_DISABLE_PARSE:
*
* Configures the inclusion of the gst-lauch parser
*/
@GST_DISABLE_PARSE_DEFINE@ @GST_DISABLE_PARSE_DEFINE@
/* configures the inclusion of a resource tracing facillity /**
* GST_DISABLE_TRACE:
*
* Configures the inclusion of a resource tracing facillity
* (seems to be unused) * (seems to be unused)
*/ */
@GST_DISABLE_TRACE_DEFINE@ @GST_DISABLE_TRACE_DEFINE@
/* configures the use of a memory tracer based on the resource tracer /**
* GST_DISABLE_ALLOC_TRACE:
*
* Configures the use of a memory tracer based on the resource tracer
* if TRACE is disabled, ALLOC_TRACE is disabled as well * if TRACE is disabled, ALLOC_TRACE is disabled as well
*/ */
@GST_DISABLE_ALLOC_TRACE_DEFINE@ @GST_DISABLE_ALLOC_TRACE_DEFINE@
/* configures the use of the plugin registry /**
* GST_DISABLE_REGISTRY:
*
* Configures the use of the plugin registry
* if one disables this, required plugins need to be loaded and registered * if one disables this, required plugins need to be loaded and registered
* manualy * manualy
*/ */
@GST_DISABLE_REGISTRY_DEFINE@ @GST_DISABLE_REGISTRY_DEFINE@
/* DOES NOT WORK */ /* FIXME: test and document these! */
/* Configure the use of glib enumtypes (useful for introspection)
* see http://bugzilla.gnome.org/show_bug.cgi?id=342564
*/
@GST_DISABLE_ENUMTYPES_DEFINE@ @GST_DISABLE_ENUMTYPES_DEFINE@
/* Configure the use of indizies for seeking
/* DOES NOT WORK */ * (not used in plugins right now)
*/
@GST_DISABLE_INDEX_DEFINE@ @GST_DISABLE_INDEX_DEFINE@
/* Configures the use of external plugins */
/* DOES NOT WORK */
@GST_DISABLE_PLUGIN_DEFINE@ @GST_DISABLE_PLUGIN_DEFINE@
/* Configures the use of uri-handlers */
/* DOES NOT WORK */
@GST_DISABLE_URI_DEFINE@ @GST_DISABLE_URI_DEFINE@
/* printf extension format */ /* printf extension format */