From e56b667c00f440c3f428c9209fd02f4c7afd7497 Mon Sep 17 00:00:00 2001 From: Stefan Kost Date: Wed, 3 Nov 2004 09:21:01 +0000 Subject: [PATCH] added some more docs, removed two obsolete defines Original commit message from CVS: added some more docs, removed two obsolete defines --- ChangeLog | 12 ++++++++++++ docs/gst/gstreamer-sections.txt | 6 +++--- docs/gst/tmpl/gstcaps.sgml | 11 ++++++----- docs/gst/tmpl/gsterror.sgml | 14 +++++++++----- docs/gst/tmpl/gstinfo.sgml | 17 ----------------- docs/gst/tmpl/gstmacros.sgml | 21 --------------------- docs/gst/tmpl/gstutils.sgml | 7 ------- docs/random/ensonic/interfaces.txt | 6 +++++- gst/gstinfo.h | 2 -- 9 files changed, 35 insertions(+), 61 deletions(-) diff --git a/ChangeLog b/ChangeLog index fbaf6a22c7..d0dd56cbc4 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,15 @@ +2004-11-03 Stefan Kost + + * docs/gst/gstreamer-sections.txt: + * docs/gst/tmpl/gstcaps.sgml: + * docs/gst/tmpl/gsterror.sgml: + * docs/gst/tmpl/gstinfo.sgml: + * docs/gst/tmpl/gstmacros.sgml: + * docs/gst/tmpl/gstutils.sgml: + * docs/random/ensonic/interfaces.txt: + * gst/gstinfo.h: + added some more docs, removed two obsolete defines + 2004-11-02 Kjartan Maraas reviewed by: Wim Taymans, Ronald Bultje. diff --git a/docs/gst/gstreamer-sections.txt b/docs/gst/gstreamer-sections.txt index ce0166b1fa..54d9808d0c 100644 --- a/docs/gst/gstreamer-sections.txt +++ b/docs/gst/gstreamer-sections.txt @@ -869,8 +869,6 @@ GST_DEBUG_FUNCPTR GST_DEBUG_FUNCPTR_NAME gst_debug_set_log_function gst_debug_reset_log_function -gst_debug_category_set_threshold_for_name -gst_debug_category_unset_threshold_for_name gst_debug_print_stack_trace GST_TIME_FORMAT GST_TIME_ARGS @@ -904,6 +902,7 @@ gst_implements_interface_get_type
gstmacros GstMacros + GST_GNUC_CONSTRUCTOR GST_INLINE_FUNC GST_CAN_INLINE @@ -1792,7 +1791,6 @@ GST_BOILERPLATE_FULL GST_BOILERPLATE GST_CALL_PARENT GST_CALL_PARENT_WITH_DEFAULT -GST_HAVE_UNALIGNED_ACCESS GST_READ_UINT8 GST_READ_UINT16_LE GST_READ_UINT16_BE @@ -1807,6 +1805,8 @@ GST_WRITE_UINT32_LE GST_WRITE_UINT32_BE GST_WRITE_UINT64_LE GST_WRITE_UINT64_BE + +GST_HAVE_UNALIGNED_ACCESS
diff --git a/docs/gst/tmpl/gstcaps.sgml b/docs/gst/tmpl/gstcaps.sgml index 3877371850..39812d240e 100644 --- a/docs/gst/tmpl/gstcaps.sgml +++ b/docs/gst/tmpl/gstcaps.sgml @@ -57,10 +57,11 @@ templates. - +Convinience macro that checks if the number of structures in the gives caps is +exactly one. -@caps: +@caps: the #GstCaps instance to check @@ -73,11 +74,11 @@ templates. - +Convinience macro for prining out the contents of caps with GST_DEBUG(). -@string: -@caps: +@string: a string the should be prepend to the caps data. +@caps: the caps to print diff --git a/docs/gst/tmpl/gsterror.sgml b/docs/gst/tmpl/gsterror.sgml index 888b33ec59..9fa9b39de2 100644 --- a/docs/gst/tmpl/gsterror.sgml +++ b/docs/gst/tmpl/gsterror.sgml @@ -16,7 +16,7 @@ Categorized error messages - +Core errors are anything that can go wrong in or using the core GStreamer library @GST_CORE_ERROR_FAILED: @@ -35,7 +35,7 @@ Categorized error messages - +Library errors are for errors from the library being used by elements initializing, closing, ... @GST_LIBRARY_ERROR_FAILED: @@ -48,7 +48,9 @@ Categorized error messages - +Resource errors are for anything external used by an element: +memory, files, network connections, process space, ... +They're typically used by source and sink elements @GST_RESOURCE_ERROR_FAILED: @@ -68,7 +70,9 @@ Categorized error messages - +Stream errors are for anything related to the stream being processed: +format errors, media type errors, ... +They're typically used by decoders, demuxers, converters, ... @GST_STREAM_ERROR_FAILED: @@ -114,7 +118,7 @@ Categorized error messages - +Generates an human readable error message out of an errno number. diff --git a/docs/gst/tmpl/gstinfo.sgml b/docs/gst/tmpl/gstinfo.sgml index d877e51721..be07e23962 100644 --- a/docs/gst/tmpl/gstinfo.sgml +++ b/docs/gst/tmpl/gstinfo.sgml @@ -701,23 +701,6 @@ Returns: The name of the function @void: - - - - - -@name: -@level: - - - - - - - -@name: - - diff --git a/docs/gst/tmpl/gstmacros.sgml b/docs/gst/tmpl/gstmacros.sgml index ced3888fa3..49b0cc647f 100644 --- a/docs/gst/tmpl/gstmacros.sgml +++ b/docs/gst/tmpl/gstmacros.sgml @@ -14,24 +14,3 @@ various portabillity helper macros - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/gst/tmpl/gstutils.sgml b/docs/gst/tmpl/gstutils.sgml index 980fc8ae26..44b2c6dae0 100644 --- a/docs/gst/tmpl/gstutils.sgml +++ b/docs/gst/tmpl/gstutils.sgml @@ -106,13 +106,6 @@ various utility functions @def_return: - - - - - - - diff --git a/docs/random/ensonic/interfaces.txt b/docs/random/ensonic/interfaces.txt index 035f55fddf..275e1505b0 100644 --- a/docs/random/ensonic/interfaces.txt +++ b/docs/random/ensonic/interfaces.txt @@ -56,7 +56,11 @@ $Id$ - question - should this be aware of instruments (voice-groups) - no, instruments should auto-generate those - + * GST_TYPE_QUALITY_VS_SPEED + - get the name of a property that can be used to switch between + - a fast version for e.g. realtime usage + - a slower version with higher precission that can be used for off-line + rendering * new interfaces for audio applications * GST_TYPE_MUSIC_GENERATOR - add hints so that application can use a element as an instrument diff --git a/gst/gstinfo.h b/gst/gstinfo.h index 17db990a54..0916cbe8d8 100644 --- a/gst/gstinfo.h +++ b/gst/gstinfo.h @@ -614,8 +614,6 @@ G_CONST_RETURN gchar * #define gst_debug_reset_log_function(void) /* NOP */ #define gst_debug_set_default_threshold(level) /* NOP */ #define gst_debug_get_default_threshold() (GST_LEVEL_NONE) -#define gst_debug_category_set_threshold_for_name(name, level) /* NOP */ -#define gst_debug_category_unset_threshold_for_name(name) /* NOP */ #define gst_debug_level_get_name(level) ("NONE") #define gst_debug_add_log_function(func,data) (FALSE)