From 219c0c1947b097770489c17ac47478ef20e50e50 Mon Sep 17 00:00:00 2001 From: Stefan Kost Date: Tue, 30 Aug 2005 08:17:48 +0000 Subject: [PATCH] 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 --- ChangeLog | 12 +++++++++ docs/gst/gstreamer-sections.txt | 4 +-- docs/gst/tmpl/.gitignore | 2 ++ docs/gst/tmpl/gstcompat.sgml | 21 --------------- docs/gst/tmpl/gstconfig.sgml | 42 ----------------------------- gst/check/gstcheck.c | 7 +++++ gst/gstcompat.h | 9 ++++++- gst/gstconfig.h.in | 48 +++++++++++++++++++++++++++++++-- libs/gst/check/gstcheck.c | 7 +++++ 9 files changed, 84 insertions(+), 68 deletions(-) delete mode 100644 docs/gst/tmpl/gstcompat.sgml delete mode 100644 docs/gst/tmpl/gstconfig.sgml diff --git a/ChangeLog b/ChangeLog index 05c7ed81b9..090d67c1bf 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,15 @@ +2005-08-30 Stefan Kost + + * 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 * docs/gst/tmpl/.cvsignore: diff --git a/docs/gst/gstreamer-sections.txt b/docs/gst/gstreamer-sections.txt index ed501ba325..6d0b20fbad 100644 --- a/docs/gst/gstreamer-sections.txt +++ b/docs/gst/gstreamer-sections.txt @@ -243,6 +243,7 @@ gst_caps_get_type
gstcheck GstCheck + 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 - -
@@ -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 diff --git a/docs/gst/tmpl/.gitignore b/docs/gst/tmpl/.gitignore index 3fdc0525c3..9ac1756f37 100644 --- a/docs/gst/tmpl/.gitignore +++ b/docs/gst/tmpl/.gitignore @@ -12,6 +12,8 @@ gstcaps.sgml gstcheck.sgml gstclock.sgml gstcollectpads.sgml +gstcompat.sgml +gstconfig.sgml gstevent.sgml gstfakesrc.sgml gstfakesink.sgml diff --git a/docs/gst/tmpl/gstcompat.sgml b/docs/gst/tmpl/gstcompat.sgml deleted file mode 100644 index 402c11c1d2..0000000000 --- a/docs/gst/tmpl/gstcompat.sgml +++ /dev/null @@ -1,21 +0,0 @@ - -GstCompat - - -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. - - - - - - - - - - diff --git a/docs/gst/tmpl/gstconfig.sgml b/docs/gst/tmpl/gstconfig.sgml deleted file mode 100644 index 5c5437149d..0000000000 --- a/docs/gst/tmpl/gstconfig.sgml +++ /dev/null @@ -1,42 +0,0 @@ - -GstConfig - - -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 -<gst/gst.h>. You can check this if you do subsystem-specific stuff. - -Doing subsystem specific things - -&hash;ifndef GST_DISABLE_GST_DEBUG -/* do stuff specific to the debugging subsystem */ -&hash;endif /* GST_DISABLE_GST_DEBUG */ - - - - - - - - - - - - diff --git a/gst/check/gstcheck.c b/gst/check/gstcheck.c index e3a1a844fb..ab850a8ab3 100644 --- a/gst/check/gstcheck.c +++ b/gst/check/gstcheck.c @@ -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" diff --git a/gst/gstcompat.h b/gst/gstcompat.h index 513f4398f8..cf2d898484 100644 --- a/gst/gstcompat.h +++ b/gst/gstcompat.h @@ -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__ diff --git a/gst/gstconfig.h.in b/gst/gstconfig.h.in index d4125ec43a..519d7be737 100644 --- a/gst/gstconfig.h.in +++ b/gst/gstconfig.h.in @@ -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 + * 2004,2005 Wim Taymans + * + * 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 + * <gst/gst.h>. You can check this if you do subsystem-specific stuff. + * + * Doing subsystem specific things + * + * &hash;ifndef GST_DISABLE_GST_DEBUG + * // do stuff specific to the debugging subsystem + * &hash;endif // GST_DISABLE_GST_DEBUG + * + * + */ #ifndef __GST_CONFIG_H__ #define __GST_CONFIG_H__ diff --git a/libs/gst/check/gstcheck.c b/libs/gst/check/gstcheck.c index e3a1a844fb..ab850a8ab3 100644 --- a/libs/gst/check/gstcheck.c +++ b/libs/gst/check/gstcheck.c @@ -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"