From e112dce520994522b360aa942e5bf54d310fd5d2 Mon Sep 17 00:00:00 2001 From: Thomas Vander Stichele Date: Tue, 29 Nov 2005 19:34:24 +0000 Subject: [PATCH] docs/: moving documentation from core to lib Original commit message from CVS: * docs/gst/gstreamer-docs.sgml: * docs/gst/gstreamer-sections.txt: * docs/libs/gstreamer-libs-docs.sgml: * docs/libs/gstreamer-libs-sections.txt: moving documentation from core to lib --- ChangeLog | 8 + docs/gst/gstreamer-docs.sgml | 43 ----- docs/gst/gstreamer-sections.txt | 251 -------------------------- docs/libs/gstreamer-libs-docs.sgml | 55 ++++++ docs/libs/gstreamer-libs-sections.txt | 246 +++++++++++++++++++++++++ 5 files changed, 309 insertions(+), 294 deletions(-) diff --git a/ChangeLog b/ChangeLog index ab78ada47b..e9fedf12cc 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,11 @@ +2005-11-29 Thomas Vander Stichele + + * docs/gst/gstreamer-docs.sgml: + * docs/gst/gstreamer-sections.txt: + * docs/libs/gstreamer-libs-docs.sgml: + * docs/libs/gstreamer-libs-sections.txt: + moving documentation from core to lib + 2005-11-29 Thomas Vander Stichele * check/Makefile.am: diff --git a/docs/gst/gstreamer-docs.sgml b/docs/gst/gstreamer-docs.sgml index bf5fc00d26..8418d0c7ea 100644 --- a/docs/gst/gstreamer-docs.sgml +++ b/docs/gst/gstreamer-docs.sgml @@ -8,7 +8,6 @@ - - - GStreamer Base and Utillity Classes - - libgstbase-&GST_MAJORMINOR;.so provides some base classes to be extended - by elements and utillity classes that are most useful for plugin developers. - - - &GstBaseSrc; - &GstBaseSink; - &GstBaseTransform; - &GstPushSrc; - - &GstAdapter; - &GstCollectPads; - - - - - - GStreamer Network Classes - - libgstnet-&GST_MAJORMINOR;.so provides network elements and objects. - - - &GstNetClientClock; - &GstNetTimePacket; - &GstNetTimeProvider; - - - Object Hierarchy &gstreamer-tree-index; diff --git a/docs/gst/gstreamer-sections.txt b/docs/gst/gstreamer-sections.txt index d7b520cc75..a460da9324 100644 --- a/docs/gst/gstreamer-sections.txt +++ b/docs/gst/gstreamer-sections.txt @@ -246,49 +246,6 @@ gst_caps_flags_get_type gst_caps_get_type - -
-gstcheck -GstCheck - -ASSERT_BUFFER_REFCOUNT -ASSERT_CAPS_REFCOUNT -ASSERT_CRITICAL -ASSERT_WARNING -ASSERT_MINI_OBJECT_REFCOUNT -ASSERT_OBJECT_REFCOUNT -ASSERT_OBJECT_REFCOUNT_BETWEEN -MAIN_INIT -MAIN_START_THREADS -MAIN_START_THREAD_FUNCTION -MAIN_START_THREAD_FUNCTIONS -MAIN_STOP_THREADS -MAIN_SYNCHRONIZE -THREAD_START -THREAD_STARTED -THREAD_SWITCH -THREAD_SYNCHRONIZE -THREAD_TEST_RUNNING -GST_START_TEST -GST_END_TEST - -fail_unless_equals_int -fail_unless_equals_string -fail_unless_equals_uint64 -fail_unless_message_error - -gst_check_chain_func -gst_check_init -gst_check_message_error -gst_check_setup_element -gst_check_setup_sink_pad -gst_check_setup_src_pad -gst_check_teardown_element -gst_check_teardown_sink_pad -gst_check_teardown_src_pad -
- -
gstchildproxy GstChildProxy @@ -2242,214 +2199,6 @@ GST_TYPE_XML gst_xml_get_type
- -# base classes - -
-gstadapter -GstAdapter -gst/base/gstadapter.h -GstAdapter -gst_adapter_new -gst_adapter_clear -gst_adapter_push -gst_adapter_peek -gst_adapter_flush -gst_adapter_available -gst_adapter_available_fast -gst_adapter_take - -GstAdapterClass -GST_ADAPTER -GST_IS_ADAPTER -GST_TYPE_ADAPTER -GST_ADAPTER_CLASS -GST_IS_ADAPTER_CLASS -GST_ADAPTER_GET_CLASS - -gst_adapter_get_type -
- - -
-gstbasesrc -GstBaseSrc -gst/base/gstbasesrc.h -GstBaseSrc -GstBaseSrcFlags - -gst_base_src_is_live -gst_base_src_set_live - -GST_BASE_SRC_PAD - -GstBaseSrcClass -GST_BASE_SRC -GST_BASE_SRC_CAST -GST_IS_BASE_SRC -GST_TYPE_BASE_SRC -GST_BASE_SRC_CLASS -GST_IS_BASE_SRC_CLASS -GST_BASE_SRC_GET_CLASS - -gst_base_src_get_type -
- - -
-gstbasesink -GstBaseSink -gst/base/gstbasesink.h -GstBaseSink - -GST_BASE_SINK_PAD - - -GstBaseSinkClass -GST_BASE_SINK -GST_BASE_SINK_CAST -GST_IS_BASE_SINK -GST_TYPE_BASE_SINK -GST_BASE_SINK_CLASS -GST_IS_BASE_SINK_CLASS -GST_BASE_SINK_GET_CLASS - -gst_base_sink_get_type -
- - -
-gstbasetransform -GstBaseTransform -gst/base/gstbasetransform.h -GstBaseTransform - -gst_base_transform_is_passthrough -gst_base_transform_set_passthrough -gst_base_transform_is_in_place -gst_base_transform_set_in_place - -GST_BASE_TRANSFORM_SINK_NAME -GST_BASE_TRANSFORM_SRC_NAME - - -GstBaseTransformClass -GST_BASE_TRANSFORM -GST_IS_BASE_TRANSFORM -GST_TYPE_BASE_TRANSFORM -GST_BASE_TRANSFORM_CLASS -GST_IS_BASE_TRANSFORM_CLASS -GST_BASE_TRANSFORM_GET_CLASS - -gst_base_transform_get_type -
- - -
-gstcollectpads -GstCollectPads -gst/base/gstcollectpads.h -GstCollectData -GstCollectPads -GstCollectPadsFunction -gst_collect_pads_new -gst_collect_pads_set_function -gst_collect_pads_add_pad -gst_collect_pads_remove_pad -gst_collect_pads_is_active -gst_collect_pads_collect -gst_collect_pads_collect_range -gst_collect_pads_start -gst_collect_pads_stop -gst_collect_pads_peek -gst_collect_pads_pop -gst_collect_pads_available -gst_collect_pads_read -gst_collect_pads_flush - -GstCollectPadsClass -GST_COLLECT_PADS -GST_IS_COLLECT_PADS -GST_TYPE_COLLECT_PADS -GST_COLLECT_PADS_CLASS -GST_IS_COLLECT_PADS_CLASS -GST_COLLECT_PADS_GET_CLASS - -gst_collect_pads_get_type -GST_COLLECT_PADS_BROADCAST -GST_COLLECT_PADS_GET_COND -GST_COLLECT_PADS_SIGNAL -GST_COLLECT_PADS_WAIT -
- - -
-gstpushsrc -GstPushSrc -gst/base/gstpushsrc.h -GstPushSrc - -GstPushSrcClass -GST_PUSH_SRC -GST_IS_PUSH_SRC -GST_TYPE_PUSH_SRC -GST_PUSH_SRC_CLASS -GST_IS_PUSH_SRC_CLASS -GST_PUSH_SRC_GET_CLASS - -gst_push_src_get_type -
- -# net - -
-gstnetclientclock -GstNetClientClock -gst/net/gstnet.h -GstNetClientClock -gst_net_client_clock_new - -GstNetClientClockClass -GST_NET_CLIENT_CLOCK -GST_IS_NET_CLIENT_CLOCK -GST_TYPE_NET_CLIENT_CLOCK -GST_NET_CLIENT_CLOCK_CLASS -GST_IS_NET_CLIENT_CLOCK_CLASS - -gst_net_client_clock_get_type -
- -
-gstnettimepacket -GstNetTimePacket -gst/net/gstnet.h -GstNetTimePacket -GST_NET_TIME_PACKET_SIZE -gst_net_time_packet_new -gst_net_time_packet_receive -gst_net_time_packet_send -gst_net_time_packet_serialize - - -
- -
-gstnettimeprovider -GstNetTimeProvider -gst/net/gstnet.h -GstNetTimeProvider -gst_net_time_provider_new - -GstNetTimeProviderClass -GST_NET_TIME_PROVIDER -GST_IS_NET_TIME_PROVIDER -GST_TYPE_NET_TIME_PROVIDER -GST_NET_TIME_PROVIDER_CLASS -GST_IS_NET_TIME_PROVIDER_CLASS - -gst_net_time_provider_get_type -
- # elements
diff --git a/docs/libs/gstreamer-libs-docs.sgml b/docs/libs/gstreamer-libs-docs.sgml index 2b4a8fdb23..6559b41748 100644 --- a/docs/libs/gstreamer-libs-docs.sgml +++ b/docs/libs/gstreamer-libs-docs.sgml @@ -3,11 +3,26 @@ "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [ %version-entities; + + + + + + + + + + + + + + + @@ -30,12 +45,52 @@ &GstDataProtocol; + + GStreamer Base and Utillity Classes + + libgstbase-&GST_MAJORMINOR;.so provides some base classes to be extended + by elements and utillity classes that are most useful for plugin developers. + + + &GstBaseSrc; + &GstBaseSink; + &GstBaseTransform; + &GstPushSrc; + + &GstAdapter; + &GstCollectPads; + + + gstcontrol &GstController; &GstControllerGObject; + + GStreamer Network Classes + + libgstnet-&GST_MAJORMINOR;.so provides network elements and objects. + + + &GstNetClientClock; + &GstNetTimePacket; + &GstNetTimeProvider; + + + + GStreamer Check Unit Testing + + libgstcheck-&GST_MAJORMINOR;.so provides functionality for writing + unit tests that use the check framework. + + + &GstCheck; + + + + diff --git a/docs/libs/gstreamer-libs-sections.txt b/docs/libs/gstreamer-libs-sections.txt index bd4ecd3abe..7a811e71c1 100644 --- a/docs/libs/gstreamer-libs-sections.txt +++ b/docs/libs/gstreamer-libs-sections.txt @@ -94,3 +94,249 @@ gst_object_get_value_array
+# base classes + +
+gstadapter +GstAdapter +gst/base/gstadapter.h +GstAdapter +gst_adapter_new +gst_adapter_clear +gst_adapter_push +gst_adapter_peek +gst_adapter_flush +gst_adapter_available +gst_adapter_available_fast +gst_adapter_take + +GstAdapterClass +GST_ADAPTER +GST_IS_ADAPTER +GST_TYPE_ADAPTER +GST_ADAPTER_CLASS +GST_IS_ADAPTER_CLASS +GST_ADAPTER_GET_CLASS + +gst_adapter_get_type +
+ + +
+gstbasesrc +GstBaseSrc +gst/base/gstbasesrc.h +GstBaseSrc +GstBaseSrcFlags + +gst_base_src_is_live +gst_base_src_set_live + +GST_BASE_SRC_PAD + +GstBaseSrcClass +GST_BASE_SRC +GST_BASE_SRC_CAST +GST_IS_BASE_SRC +GST_TYPE_BASE_SRC +GST_BASE_SRC_CLASS +GST_IS_BASE_SRC_CLASS +GST_BASE_SRC_GET_CLASS + +gst_base_src_get_type +
+ + +
+gstbasesink +GstBaseSink +gst/base/gstbasesink.h +GstBaseSink + +GST_BASE_SINK_PAD + + +GstBaseSinkClass +GST_BASE_SINK +GST_BASE_SINK_CAST +GST_IS_BASE_SINK +GST_TYPE_BASE_SINK +GST_BASE_SINK_CLASS +GST_IS_BASE_SINK_CLASS +GST_BASE_SINK_GET_CLASS + +gst_base_sink_get_type +
+ + +
+gstbasetransform +GstBaseTransform +gst/base/gstbasetransform.h +GstBaseTransform + +gst_base_transform_is_passthrough +gst_base_transform_set_passthrough +gst_base_transform_is_in_place +gst_base_transform_set_in_place + +GST_BASE_TRANSFORM_SINK_NAME +GST_BASE_TRANSFORM_SRC_NAME + + +GstBaseTransformClass +GST_BASE_TRANSFORM +GST_IS_BASE_TRANSFORM +GST_TYPE_BASE_TRANSFORM +GST_BASE_TRANSFORM_CLASS +GST_IS_BASE_TRANSFORM_CLASS +GST_BASE_TRANSFORM_GET_CLASS + +gst_base_transform_get_type +
+ + +
+gstcollectpads +GstCollectPads +gst/base/gstcollectpads.h +GstCollectData +GstCollectPads +GstCollectPadsFunction +gst_collect_pads_new +gst_collect_pads_set_function +gst_collect_pads_add_pad +gst_collect_pads_remove_pad +gst_collect_pads_is_active +gst_collect_pads_collect +gst_collect_pads_collect_range +gst_collect_pads_start +gst_collect_pads_stop +gst_collect_pads_peek +gst_collect_pads_pop +gst_collect_pads_available +gst_collect_pads_read +gst_collect_pads_flush + +GstCollectPadsClass +GST_COLLECT_PADS +GST_IS_COLLECT_PADS +GST_TYPE_COLLECT_PADS +GST_COLLECT_PADS_CLASS +GST_IS_COLLECT_PADS_CLASS +GST_COLLECT_PADS_GET_CLASS + +gst_collect_pads_get_type +GST_COLLECT_PADS_BROADCAST +GST_COLLECT_PADS_GET_COND +GST_COLLECT_PADS_SIGNAL +GST_COLLECT_PADS_WAIT +
+ + +
+gstpushsrc +GstPushSrc +gst/base/gstpushsrc.h +GstPushSrc + +GstPushSrcClass +GST_PUSH_SRC +GST_IS_PUSH_SRC +GST_TYPE_PUSH_SRC +GST_PUSH_SRC_CLASS +GST_IS_PUSH_SRC_CLASS +GST_PUSH_SRC_GET_CLASS + +gst_push_src_get_type +
+ +# net + +
+gstnetclientclock +GstNetClientClock +gst/net/gstnet.h +GstNetClientClock +gst_net_client_clock_new + +GstNetClientClockClass +GST_NET_CLIENT_CLOCK +GST_IS_NET_CLIENT_CLOCK +GST_TYPE_NET_CLIENT_CLOCK +GST_NET_CLIENT_CLOCK_CLASS +GST_IS_NET_CLIENT_CLOCK_CLASS + +gst_net_client_clock_get_type +
+ +
+gstnettimepacket +GstNetTimePacket +gst/net/gstnet.h +GstNetTimePacket +GST_NET_TIME_PACKET_SIZE +gst_net_time_packet_new +gst_net_time_packet_receive +gst_net_time_packet_send +gst_net_time_packet_serialize + + +
+ +
+gstnettimeprovider +GstNetTimeProvider +gst/net/gstnet.h +GstNetTimeProvider +gst_net_time_provider_new + +GstNetTimeProviderClass +GST_NET_TIME_PROVIDER +GST_IS_NET_TIME_PROVIDER +GST_TYPE_NET_TIME_PROVIDER +GST_NET_TIME_PROVIDER_CLASS +GST_IS_NET_TIME_PROVIDER_CLASS + +gst_net_time_provider_get_type +
+
+gstcheck +GstCheck + +ASSERT_BUFFER_REFCOUNT +ASSERT_CAPS_REFCOUNT +ASSERT_CRITICAL +ASSERT_WARNING +ASSERT_MINI_OBJECT_REFCOUNT +ASSERT_OBJECT_REFCOUNT +ASSERT_OBJECT_REFCOUNT_BETWEEN +MAIN_INIT +MAIN_START_THREADS +MAIN_START_THREAD_FUNCTION +MAIN_START_THREAD_FUNCTIONS +MAIN_STOP_THREADS +MAIN_SYNCHRONIZE +THREAD_START +THREAD_STARTED +THREAD_SWITCH +THREAD_SYNCHRONIZE +THREAD_TEST_RUNNING +GST_START_TEST +GST_END_TEST + +fail_unless_equals_int +fail_unless_equals_string +fail_unless_equals_uint64 +fail_unless_message_error + +gst_check_chain_func +gst_check_init +gst_check_message_error +gst_check_setup_element +gst_check_setup_sink_pad +gst_check_setup_src_pad +gst_check_teardown_element +gst_check_teardown_sink_pad +gst_check_teardown_src_pad +