docs/gst/gstreamer-sections.txt: ultral33t func10ns deserve to appear in the docs actualy

Original commit message from CVS:
* docs/gst/gstreamer-sections.txt:
ultral33t func10ns deserve to appear in the docs actualy
* docs/gst/tmpl/.cvsignore:
* docs/gst/tmpl/gstcompat.sgml:
* docs/gst/tmpl/gstconfig.sgml:
* gst/check/gstcheck.c:
* gst/gstcompat.h:
* gst/gstconfig.h.in:
inlined more docs
This commit is contained in:
Stefan Kost 2005-08-30 08:17:48 +00:00
parent ba327dcf92
commit 219c0c1947
9 changed files with 84 additions and 68 deletions

View file

@ -1,3 +1,15 @@
2005-08-30 Stefan Kost <ensonic@users.sf.net>
* docs/gst/gstreamer-sections.txt:
ultral33t func10ns deserve to appear in the docs actualy
* docs/gst/tmpl/.cvsignore:
* docs/gst/tmpl/gstcompat.sgml:
* docs/gst/tmpl/gstconfig.sgml:
* gst/check/gstcheck.c:
* gst/gstcompat.h:
* gst/gstconfig.h.in:
inlined more docs
2005-08-30 Stefan Kost <ensonic@users.sf.net>
* docs/gst/tmpl/.cvsignore:

View file

@ -243,6 +243,7 @@ gst_caps_get_type
<SECTION>
<FILE>gstcheck</FILE>
<TITLE>GstCheck</TITLE>
<SUBSECTION Private>
ASSERT_BUFFER_REFCOUNT
ASSERT_CAPS_REFCOUNT
ASSERT_CRITICAL
@ -277,8 +278,6 @@ gst_check_setup_src_pad
gst_check_teardown_element
gst_check_teardown_sink_pad
gst_check_teardown_src_pad
<SUBSECTION Private>
</SECTION>
@ -2058,6 +2057,7 @@ gst_flow_get_name
gst_print_element_args
gst_print_pad_caps
gst_util_dump_mem
gst_util_uint64_scale
gst_util_set_object_arg
gst_util_set_value_from_string
<SUBSECTION Private>

View file

@ -12,6 +12,8 @@ gstcaps.sgml
gstcheck.sgml
gstclock.sgml
gstcollectpads.sgml
gstcompat.sgml
gstconfig.sgml
gstevent.sgml
gstfakesrc.sgml
gstfakesink.sgml

View file

@ -1,21 +0,0 @@
<!-- ##### SECTION Title ##### -->
GstCompat
<!-- ##### SECTION Short_Description ##### -->
Deprecated API entries.
<!-- ##### SECTION Long_Description ##### -->
<para>
Please do not use these in new code.
These symbols are only available by defining GST_DISABLE_DEPRECATED.
This can be done in CFLAGS for compiling old code.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->

View file

@ -1,42 +0,0 @@
<!-- ##### SECTION Title ##### -->
GstConfig
<!-- ##### SECTION Short_Description ##### -->
Configuration options
<!-- ##### SECTION Long_Description ##### -->
<para>
This describes the configuration options for GStreamer. When building
GStreamer there are a lot of parts (known internally as "subsystems" ) that can
be disabled for various reasons. The most common reasons are speed and size,
which is important because GStreamer is designed to run on embedded systems.
</para>
<para>
If a subsystem is disabled, most of this changes are done in an API compatible
way, so you don't need to adapt your code in most cases. It is never done in an
ABI compatible way though. So if you want to disable a suybsystem, you have to
rebuild all programs depending on GStreamer, too.
</para>
<para>
If a subsystem is disabled in GStreamer, a value is defined in
&lt;gst/gst.h&gt;. You can check this if you do subsystem-specific stuff.
<example>
<title>Doing subsystem specific things</title>
<programlisting>
&hash;ifndef GST_DISABLE_GST_DEBUG
/* do stuff specific to the debugging subsystem */
&hash;endif /* GST_DISABLE_GST_DEBUG */
</programlisting>
</example>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->

View file

@ -19,6 +19,13 @@
* Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA.
*/
/**
* SECTION:gstcheck
* @short_description: Common code for GStreamer unittests
*
* These macros and functions are for internal use of the unittests found inside
* the 'check' directories of various GStreamer packages.
*/
#include "gstcheck.h"

View file

@ -19,7 +19,14 @@
* Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA.
*/
/**
* SECTION:gstcompat
* @short_description: Deprecated API entries
*
* Please do not use these in new code.
* These symbols are only available by defining GST_DISABLE_DEPRECATED.
* This can be done in CFLAGS for compiling old code.
*/
/* API compatibility stuff */
#ifndef __GSTCOMPAT_H__

View file

@ -1,5 +1,49 @@
/* This header interprets the various GST_* macros that are typically *
* provided by the gstreamer-config or gstreamer.pc files. */
/* GStreamer
* Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
* 2004,2005 Wim Taymans <wim@fluendo.com>
*
* gstconfig.h: GST_DISABLE_* macros for build configuration
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Library General Public License for more details.
*
* You should have received a copy of the GNU Library General Public
* License along with this library; if not, write to the
* Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA.
*/
/**
* SECTION:gstconfig
* @short_description: Build configuration options
*
* This describes the configuration options for GStreamer. When building
* GStreamer there are a lot of parts (known internally as "subsystems" ) that can
* be disabled for various reasons. The most common reasons are speed and size,
* which is important because GStreamer is designed to run on embedded systems.
*
* If a subsystem is disabled, most of this changes are done in an API compatible
* way, so you don't need to adapt your code in most cases. It is never done in an
* ABI compatible way though. So if you want to disable a suybsystem, you have to
* rebuild all programs depending on GStreamer, too.
*
* If a subsystem is disabled in GStreamer, a value is defined in
* &lt;gst/gst.h&gt;. You can check this if you do subsystem-specific stuff.
* <example>
* <title>Doing subsystem specific things</title>
* <programlisting>
* &hash;ifndef GST_DISABLE_GST_DEBUG
* // do stuff specific to the debugging subsystem
* &hash;endif // GST_DISABLE_GST_DEBUG
* </programlisting>
* </example>
*/
#ifndef __GST_CONFIG_H__
#define __GST_CONFIG_H__

View file

@ -19,6 +19,13 @@
* Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA.
*/
/**
* SECTION:gstcheck
* @short_description: Common code for GStreamer unittests
*
* These macros and functions are for internal use of the unittests found inside
* the 'check' directories of various GStreamer packages.
*/
#include "gstcheck.h"