mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2024-09-27 14:31:01 +00:00
Code Issues 1 Projects Releases Wiki Activity

added some more docs, removed two obsolete defines

Browse source 
Original commit message from CVS:
added some more docs, removed two obsolete defines
This commit is contained in:
Stefan Kost 2004-11-03 09:21:01 +00:00
parent 6d42edd550
commit e56b667c00
9 changed files with 35 additions and 61 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
ChangeLog
View file

@ -1,3 +1,15 @@
2004-11-03 Stefan Kost <ensonic@users.sf.net>
* 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 <as at gnome.org>
reviewed by: Wim Taymans, Ronald Bultje.

6
docs/gst/gstreamer-sections.txt
View file

@ -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
<SECTION>
<FILE>gstmacros</FILE>
<TITLE>GstMacros</TITLE>
<SUBSECTION Private>
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
<SUBSECTION Private>
GST_HAVE_UNALIGNED_ACCESS
</SECTION>
<SECTION>

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

@ -57,10 +57,11 @@ templates.
<!-- ##### MACRO GST_CAPS_IS_SIMPLE ##### -->
<para>
Convinience macro that checks if the number of structures in the gives caps is
exactly one.
</para>
@caps:
@caps: the #GstCaps instance to check
<!-- ##### MACRO gst_caps_is_simple ##### -->
@ -73,11 +74,11 @@ templates.
<!-- ##### MACRO GST_DEBUG_CAPS ##### -->
<para>
Convinience macro for prining out the contents of caps with GST_DEBUG().
</para>
@string:
@caps:
@string: a string the should be prepend to the caps data.
@caps: the caps to print
<!-- ##### MACRO GST_STATIC_CAPS ##### -->

14
docs/gst/tmpl/gsterror.sgml
View file

@ -16,7 +16,7 @@ Categorized error messages
<!-- ##### ENUM GstCoreError ##### -->
<para>
Core errors are anything that can go wrong in or using the core GStreamer library
</para>
@GST_CORE_ERROR_FAILED:
@ -35,7 +35,7 @@ Categorized error messages
<!-- ##### ENUM GstLibraryError ##### -->
<para>
Library errors are for errors from the library being used by elements initializing, closing, ...
</para>
@GST_LIBRARY_ERROR_FAILED:
@ -48,7 +48,9 @@ Categorized error messages
<!-- ##### ENUM GstResourceError ##### -->
<para>
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
</para>
@GST_RESOURCE_ERROR_FAILED:
@ -68,7 +70,9 @@ Categorized error messages
<!-- ##### ENUM GstStreamError ##### -->
<para>
Stream errors are for anything related to the stream being processed:
format errors, media type errors, ...
They're typically used by decoders, demuxers, converters, ...
</para>
@GST_STREAM_ERROR_FAILED:
@ -114,7 +118,7 @@ Categorized error messages
<!-- ##### MACRO GST_ERROR_SYSTEM ##### -->
<para>
Generates an human readable error message out of an errno number.
</para>

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

@ -701,23 +701,6 @@ Returns: The name of the function
@void:
<!-- ##### MACRO gst_debug_category_set_threshold_for_name ##### -->
<para>
</para>
@name:
@level:
<!-- ##### MACRO gst_debug_category_unset_threshold_for_name ##### -->
<para>
</para>
@name:
<!-- ##### FUNCTION gst_debug_print_stack_trace ##### -->
<para>

21
docs/gst/tmpl/gstmacros.sgml
View file

@ -14,24 +14,3 @@ various portabillity helper macros
</para>
<!-- ##### MACRO GST_GNUC_CONSTRUCTOR ##### -->
<para>
</para>
<!-- ##### MACRO GST_INLINE_FUNC ##### -->
<para>
</para>
<!-- ##### MACRO GST_CAN_INLINE ##### -->
<para>
</para>

7
docs/gst/tmpl/gstutils.sgml
View file

@ -106,13 +106,6 @@ various utility functions
@def_return:
<!-- ##### MACRO GST_HAVE_UNALIGNED_ACCESS ##### -->
<para>
</para>
<!-- ##### MACRO GST_READ_UINT8 ##### -->
<para>

6
docs/random/ensonic/interfaces.txt
View file

@ -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

2
gst/gstinfo.h
View file

@ -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)