diff options
author | Sebastian Rasmussen <sebras@hotmail.com> | 2013-11-30 12:15:37 +0100 |
---|---|---|
committer | Tim-Philipp Müller <tim@centricular.com> | 2013-12-03 00:11:59 +0000 |
commit | 49950e57ad5f6eadbbe9d45d0ab3f7f7b4ce7577 (patch) | |
tree | 0346c295824129307404ddc89714c5d09e66a36f | |
parent | b40fa2b8c3485a8374186ca047622ab518e09485 (diff) |
docs: add missing docs, fixing doc errors
* add many missing declarations to sections
* GstController has been removed, update docs
* skip GstIndex when generating documentation
* rephrase so gtkdoc doesn't imagine return value
* add missing argument description for gst_context_new()
* document GstOutputSelectorPadNegotiationMode and move to header-file
https://bugzilla.gnome.org/show_bug.cgi?id=719614
-rw-r--r-- | docs/gst/gstreamer-sections.txt | 23 | ||||
-rw-r--r-- | docs/libs/Makefile.am | 1 | ||||
-rw-r--r-- | docs/libs/gstreamer-libs-sections.txt | 66 | ||||
-rw-r--r-- | docs/plugins/gstreamer-plugins-sections.txt | 3 | ||||
-rw-r--r-- | gst/gstcontext.c | 1 | ||||
-rw-r--r-- | gst/gstcontrolsource.c | 4 | ||||
-rw-r--r-- | gst/gstcontrolsource.h | 1 | ||||
-rw-r--r-- | gst/gstobject.c | 4 | ||||
-rw-r--r-- | gst/gstpad.h | 6 | ||||
-rw-r--r-- | gst/gstvalue.c | 3 | ||||
-rw-r--r-- | plugins/elements/gstoutputselector.c | 6 | ||||
-rw-r--r-- | plugins/elements/gstoutputselector.h | 19 |
12 files changed, 119 insertions, 18 deletions
diff --git a/docs/gst/gstreamer-sections.txt b/docs/gst/gstreamer-sections.txt index 1e7357fc4..40666189c 100644 --- a/docs/gst/gstreamer-sections.txt +++ b/docs/gst/gstreamer-sections.txt @@ -198,6 +198,7 @@ gst_buffer_get_sizes_range gst_buffer_resize_range gst_buffer_resize gst_buffer_set_size +gst_buffer_get_max_memory gst_buffer_peek_memory @@ -281,6 +282,7 @@ GstMetaTransformCopy GST_META_TRANSFORM_IS_COPY gst_meta_api_type_register gst_meta_api_type_has_tag +gst_meta_api_type_get_tags GST_META_TAG_MEMORY GST_META_TAG_MEMORY_STR gst_meta_register @@ -458,6 +460,9 @@ gst_caps_intersect_mode_get_type <FILE>gstcapsfeatures</FILE> <TITLE>GstCapsFeatures</TITLE> GstCapsFeatures +GST_CAPS_FEATURES_ANY +GST_CAPS_FEATURES_MEMORY_SYSTEM_MEMORY +GST_CAPS_FEATURE_MEMORY_SYSTEM_MEMORY gst_caps_features_new gst_caps_features_new_empty gst_caps_features_new_any @@ -509,6 +514,7 @@ gst_sample_get_segment gst_sample_new gst_sample_ref gst_sample_unref +gst_sample_copy <SUBSECTION Standard> GST_IS_SAMPLE GST_SAMPLE @@ -713,6 +719,7 @@ GST_CONTROL_BINDING_CLASS GST_IS_CONTROL_BINDING_CLASS GST_CONTROL_BINDING_GET_CLASS GST_TYPE_CONTROL_BINDING +GST_CONTROL_BINDING_PSPEC <SUBSECTION Private> GstControlBindingConvert gst_control_binding_get_type @@ -1055,6 +1062,7 @@ gst_event_parse_gap gst_event_new_stream_start gst_event_parse_stream_start +GstStreamFlags gst_event_set_stream_flags gst_event_parse_stream_flags gst_event_set_group_id @@ -1117,6 +1125,7 @@ GST_TYPE_SEEK_TYPE GST_TYPE_SEEK_FLAGS GST_TYPE_QOS_TYPE GST_TYPE_EVENT_TYPE_FLAGS +GST_TYPE_STREAM_FLAGS <SUBSECTION Private> GST_EVENT_TYPE_SHIFT GST_EVENT_MAX_STICKY @@ -1131,6 +1140,7 @@ gst_seek_type_get_type gst_seek_flags_get_type gst_qos_type_get_type gst_event_type_flags_get_type +gst_stream_flags_get_type </SECTION> <SECTION> @@ -1209,6 +1219,7 @@ gst_ghost_pad_get_type GstDebugLevel GST_LEVEL_DEFAULT GstDebugColorFlags +GstDebugColorMode GstDebugCategory GstDebugGraphDetails GST_STR_NULL @@ -1295,6 +1306,7 @@ gst_debug_bin_to_dot_file gst_debug_bin_to_dot_file_with_ts <SUBSECTION Standard> GST_TYPE_DEBUG_COLOR_FLAGS +GST_TYPE_DEBUG_COLOR_MODE GST_TYPE_DEBUG_LEVEL GST_TYPE_DEBUG_GRAPH_DETAILS <SUBSECTION Private> @@ -1304,6 +1316,7 @@ GST_DEBUG_FORMAT_MASK GstDebugFuncPtr GstDebugMessage gst_debug_color_flags_get_type +gst_debug_color_mode_get_type gst_debug_level_get_type gst_debug_graph_details_get_type GST_CAT_LEVEL_LOG_valist @@ -2121,6 +2134,8 @@ GstPluginDesc GstPluginInitFunc GstPluginInitFullFunc GST_PLUGIN_DEFINE +GST_PLUGIN_STATIC_DECLARE +GST_PLUGIN_STATIC_REGISTER GST_LICENSE_UNKNOWN GstPluginFilter gst_plugin_get_name @@ -2343,6 +2358,8 @@ gst_query_parse_nth_buffering_range gst_query_new_uri gst_query_parse_uri gst_query_set_uri +gst_query_parse_uri_redirection +gst_query_set_uri_redirection gst_query_new_allocation gst_query_parse_allocation @@ -2420,6 +2437,8 @@ gst_registry_feature_filter gst_registry_find_plugin gst_registry_find_feature gst_registry_lookup_feature +gst_registry_add_path +gst_registry_get_path_list gst_registry_scan_path gst_registry_lookup gst_registry_remove_feature @@ -2659,6 +2678,8 @@ GST_TAG_DEVICE_MODEL GST_TAG_APPLICATION_NAME GST_TAG_APPLICATION_DATA GST_TAG_IMAGE_ORIENTATION +GST_TAG_PUBLISHER +GST_TAG_INTERPRETED_BY gst_tag_register gst_tag_register_static @@ -3163,6 +3184,7 @@ GST_TYPE_LIST GST_VALUE_HOLDS_ARRAY GST_TYPE_ARRAY gst_value_list_append_value +gst_value_list_append_and_take_value gst_value_list_prepend_value gst_value_list_concat gst_value_list_merge @@ -3242,6 +3264,7 @@ gst_value_intersect gst_value_can_intersect gst_value_is_subset gst_value_array_append_value +gst_value_array_append_and_take_value gst_value_array_get_size gst_value_array_get_value gst_value_array_prepend_value diff --git a/docs/libs/Makefile.am b/docs/libs/Makefile.am index a8837f415..889b3a4b5 100644 --- a/docs/libs/Makefile.am +++ b/docs/libs/Makefile.am @@ -44,6 +44,7 @@ IGNORE_HFILES = \ gstinterpolationcontrolsourceprivate.h \ gstlfocontrolsourceprivate.h \ gstgetbits_inl.h \ + gstindex.h \ dp-private.h # Images to copy into HTML directory. diff --git a/docs/libs/gstreamer-libs-sections.txt b/docs/libs/gstreamer-libs-sections.txt index bbf7332f7..f16744cb1 100644 --- a/docs/libs/gstreamer-libs-sections.txt +++ b/docs/libs/gstreamer-libs-sections.txt @@ -76,6 +76,8 @@ GST_TIMED_VALUE_CONTROL_SOURCE_CLASS GST_IS_TIMED_VALUE_CONTROL_SOURCE_CLASS GST_TIMED_VALUE_CONTROL_SOURCE_GET_CLASS GST_TYPE_TIMED_VALUE_CONTROL_SOURCE +GST_TIMED_VALUE_CONTROL_SOURCE_LOCK +GST_TIMED_VALUE_CONTROL_SOURCE_UNLOCK <SUBSECTION Private> gst_timed_value_control_source_get_type </SECTION> @@ -130,6 +132,7 @@ gst_lfo_waveform_get_type <INCLUDE>libs/controller/gsttriggercontrolsource.h</INCLUDE> GstTriggerControlSource gst_trigger_control_source_new +GST_TYPE_TRIGGER_WAVEFORM <SUBSECTION Standard> GstTriggerControlSourceClass GstTriggerControlSourcePrivate @@ -161,9 +164,12 @@ gst_adapter_available gst_adapter_available_fast gst_adapter_take gst_adapter_take_buffer +gst_adapter_take_buffer_fast gst_adapter_take_list gst_adapter_prev_pts gst_adapter_prev_dts +gst_adapter_prev_pts_at_offset +gst_adapter_prev_dts_at_offset gst_adapter_masked_scan_uint32 gst_adapter_masked_scan_uint32_peek <SUBSECTION Standard> @@ -194,6 +200,9 @@ gst_base_parse_set_syncable gst_base_parse_set_has_timing_info gst_base_parse_set_frame_rate gst_base_parse_set_latency +gst_base_parse_set_infer_ts +gst_base_parse_set_pts_interpolation +gst_base_parse_set_ts_at_offset gst_base_parse_convert_default gst_base_parse_add_index_entry @@ -236,6 +245,8 @@ GstBaseSrcClass GstBaseSrcFlags gst_base_src_wait_playing +gst_base_src_start_wait +gst_base_src_start_complete gst_base_src_is_live gst_base_src_set_live gst_base_src_set_format @@ -249,8 +260,12 @@ gst_base_src_new_seamless_segment gst_base_src_set_caps gst_base_src_get_allocator gst_base_src_get_buffer_pool +gst_base_src_is_async +gst_base_src_set_async GST_BASE_SRC_PAD +GST_BASE_SRC_IS_STARTED +GST_BASE_SRC_IS_STARTING <SUBSECTION Standard> GstBaseSrcPrivate GST_BASE_SRC @@ -274,6 +289,7 @@ GstBaseSinkClass gst_base_sink_query_latency gst_base_sink_get_latency gst_base_sink_do_preroll +gst_base_sink_wait gst_base_sink_wait_preroll gst_base_sink_wait_clock gst_base_sink_wait_eos @@ -296,6 +312,10 @@ gst_base_sink_set_blocksize gst_base_sink_get_blocksize gst_base_sink_get_throttle_time gst_base_sink_set_throttle_time +gst_base_sink_set_max_bitrate +gst_base_sink_get_max_bitrate +gst_base_sink_set_last_sample_enabled +gst_base_sink_is_last_sample_enabled GST_BASE_SINK_PAD GST_BASE_SINK_GET_PREROLL_COND @@ -307,6 +327,7 @@ GST_BASE_SINK_PREROLL_TIMED_WAIT GST_BASE_SINK_PREROLL_TRYLOCK GST_BASE_SINK_PREROLL_UNLOCK GST_BASE_SINK_PREROLL_WAIT +GST_BASE_SINK_PREROLL_WAIT_UNTIL <SUBSECTION Standard> GST_BASE_SINK @@ -342,6 +363,8 @@ gst_base_transform_suggest gst_base_transform_reconfigure gst_base_transform_get_allocator gst_base_transform_get_buffer_pool +gst_base_transform_reconfigure_sink +gst_base_transform_reconfigure_src GST_BASE_TRANSFORM_SINK_NAME GST_BASE_TRANSFORM_SRC_NAME @@ -626,6 +649,9 @@ gst_byte_writer_put_string_utf8 gst_byte_writer_put_data gst_byte_writer_fill +gst_byte_writer_put_buffer +gst_byte_writer_put_buffer_unchecked + gst_byte_writer_put_int8_unchecked gst_byte_writer_put_int16_be_unchecked gst_byte_writer_put_int16_le_unchecked @@ -666,9 +692,11 @@ GstCollectData GstCollectDataDestroyNotify GstCollectPadsBufferFunction +GstCollectPadsClipFunction GstCollectPadsCompareFunction GstCollectPadsEventFunction -GstCollectPadsClipFunction +GstCollectPadsFlushFunction +GstCollectPadsQueryFunction GstCollectPadsFunction GstCollectPadsStateFlags @@ -699,15 +727,26 @@ gst_collect_pads_read gst_collect_pads_read_buffer gst_collect_pads_take_buffer +gst_collect_pads_clip_running_time + +gst_collect_pads_query_default + +gst_collect_pads_event_default +gst_collect_pads_src_event_default + gst_collect_pads_set_buffer_function +gst_collect_pads_set_clip_function gst_collect_pads_set_compare_function gst_collect_pads_set_event_function -gst_collect_pads_set_clip_function +gst_collect_pads_set_flush_function +gst_collect_pads_set_query_function gst_collect_pads_set_flushing gst_collect_pads_set_function gst_collect_pads_set_waiting <SUBSECTION Standard> GstCollectPadsClass +GstCollectPadsPrivate +GstCollectDataPrivate GST_COLLECT_PADS GST_COLLECT_PADS_CLASS GST_TYPE_COLLECT_PADS @@ -763,6 +802,7 @@ gst_data_queue_new gst_data_queue_push gst_data_queue_push_force gst_data_queue_pop +gst_data_queue_peek gst_data_queue_flush gst_data_queue_set_flushing gst_data_queue_drop_head @@ -772,6 +812,7 @@ gst_data_queue_get_level gst_data_queue_limits_changed <SUBSECTION Standard> GstDataQueueClass +GstDataQueuePrivate GST_DATA_QUEUE GST_IS_DATA_QUEUE GST_TYPE_DATA_QUEUE @@ -800,6 +841,22 @@ gst_queue_array_find # net <SECTION> +<FILE>gstnetaddressmeta</FILE> +<TITLE>GstNetAddressMeta</TITLE> +<INCLUDE>gst/net/gstnetaddressmeta.h</INCLUDE> +GstNetAddressMeta +gst_buffer_add_net_address_meta +gst_buffer_get_net_address_meta +gst_net_address_meta_get_info +<SUBSECTION Standard> +GST_NET_ADDRESS_META_API_TYPE +GST_NET_ADDRESS_META_INFO +<SUBSECTION Private> +gst_net_address_meta_api_get_type +</SECTION> + + +<SECTION> <FILE>gstnetclientclock</FILE> <TITLE>GstNetClientClock</TITLE> <INCLUDE>gst/net/gstnet.h</INCLUDE> @@ -825,11 +882,14 @@ gst_net_client_clock_get_type GstNetTimePacket GST_NET_TIME_PACKET_SIZE gst_net_time_packet_new +gst_net_time_packet_copy +gst_net_time_packet_free gst_net_time_packet_receive gst_net_time_packet_send gst_net_time_packet_serialize <SUBSECTION Standard> <SUBSECTION Private> +gst_net_time_packet_get_type socklen_t </SECTION> @@ -1019,6 +1079,7 @@ tcase_add_loop_test tcase_add_loop_test_raise_signal tcase_add_test tcase_add_test_raise_signal +tcase_skip_broken_test teardown_messaging tr_create tr_fprint @@ -1047,6 +1108,7 @@ GstStreamConsistency gst_consistency_checker_new gst_consistency_checker_reset gst_consistency_checker_free +gst_consistency_checker_add_pad </SECTION> <SECTION> diff --git a/docs/plugins/gstreamer-plugins-sections.txt b/docs/plugins/gstreamer-plugins-sections.txt index e862a13f7..83e085792 100644 --- a/docs/plugins/gstreamer-plugins-sections.txt +++ b/docs/plugins/gstreamer-plugins-sections.txt @@ -144,6 +144,7 @@ gst_identity_get_type <FILE>element-input-selector</FILE> <TITLE>input-selector</TITLE> GstInputSelector +GstInputSelectorSyncMode <SUBSECTION Standard> GstInputSelectorClass GST_INPUT_SELECTOR @@ -170,6 +171,7 @@ GstQueueClass GST_QUEUE GST_IS_QUEUE GST_QUEUE_CLASS +GST_QUEUE_CAST GST_IS_QUEUE_CLASS GST_TYPE_QUEUE <SUBSECTION Private> @@ -215,6 +217,7 @@ gst_multi_queue_get_type <FILE>element-output-selector</FILE> <TITLE>output-selector</TITLE> GstOutputSelector +GstOutputSelectorPadNegotiationMode <SUBSECTION Standard> GstOutputSelectorClass GST_OUTPUT_SELECTOR diff --git a/gst/gstcontext.c b/gst/gstcontext.c index 949896885..0bf7c5ff4 100644 --- a/gst/gstcontext.c +++ b/gst/gstcontext.c @@ -141,6 +141,7 @@ gst_context_init (GstContext * context) /** * gst_context_new: + * @context_type: Context type * @persistent: Persistent context * * Create a new context. diff --git a/gst/gstcontrolsource.c b/gst/gstcontrolsource.c index c7b134d10..02926f3f7 100644 --- a/gst/gstcontrolsource.c +++ b/gst/gstcontrolsource.c @@ -25,8 +25,8 @@ * @short_description: base class for control source sources * * The #GstControlSource is a base class for control value sources that could - * be used by #GstController to get timestamp-value pairs. A control source - * essentially is a function over time, returning gloat values between 0.0 and 1.0. + * be used to get timestamp-value pairs. A control source essentially is a + * function over time, returning float values between 0.0 and 1.0. * * A #GstControlSource is used by first getting an instance of a specific * control-source, creating a binding for the control-source to the target property diff --git a/gst/gstcontrolsource.h b/gst/gstcontrolsource.h index b0cd92a5a..655205b5a 100644 --- a/gst/gstcontrolsource.h +++ b/gst/gstcontrolsource.h @@ -113,7 +113,6 @@ struct _GstControlSource { /** * GstControlSourceClass: * @parent_class: Parent class - * @bind: Class method for binding the #GstControlSource to a specific GParamSpec * * The class structure of #GstControlSource. */ diff --git a/gst/gstobject.c b/gst/gstobject.c index 24c3fa076..dae18712c 100644 --- a/gst/gstobject.c +++ b/gst/gstobject.c @@ -1136,8 +1136,8 @@ gst_object_set_control_bindings_disabled (GstObject * object, gboolean disabled) * @disabled: boolean that specifies whether to disable the controller * or not. * - * This function is used to disable the #GstController on a property for - * some time, i.e. gst_controller_sync_values() will do nothing for the + * This function is used to disable the control bindings on a property for + * some time, i.e. gst_object_sync_values() will do nothing for the * property. */ void diff --git a/gst/gstpad.h b/gst/gstpad.h index 04c2094d2..a784835af 100644 --- a/gst/gstpad.h +++ b/gst/gstpad.h @@ -503,7 +503,7 @@ typedef enum * @GST_PAD_PROBE_DROP: drop data in data probes. For push mode this means that * the data item is not sent downstream. For pull mode, it means that the * data item is not passed upstream. In both cases, this result code - * returns #GST_FLOW_OK or %TRUE to the caller. + * means that #GST_FLOW_OK or %TRUE is returned to the caller. * @GST_PAD_PROBE_REMOVE: remove probe * @GST_PAD_PROBE_PASS: pass the data item in the block probe and block on * the next item @@ -611,8 +611,8 @@ typedef gboolean (*GstPadStickyEventsForeachFunction) (GstPad *pad, GstEvent ** * reconfiguration happened. * @GST_PAD_FLAG_PENDING_EVENTS: the pad has pending events * @GST_PAD_FLAG_FIXED_CAPS: the pad is using fixed caps this means that once the - * caps are set on the pad, the caps query function only - * returns those caps. + * caps are set on the pad, the caps query function will only + * return those caps. * @GST_PAD_FLAG_PROXY_CAPS: the default event and query handler will forward * all events and queries to the internally linked pads * instead of discarding them. diff --git a/gst/gstvalue.c b/gst/gstvalue.c index ad9b353cf..2a5821e7e 100644 --- a/gst/gstvalue.c +++ b/gst/gstvalue.c @@ -4666,8 +4666,7 @@ gst_value_register_union_func (GType type1, GType type2, GstValueUnionFunc func) * * Determines if intersecting two values will produce a valid result. * Two values will produce a valid intersection if they have the same - * type, or if there is a method (registered by - * gst_value_register_intersect_func()) to calculate the intersection. + * type. * * Returns: TRUE if the values can intersect */ diff --git a/plugins/elements/gstoutputselector.c b/plugins/elements/gstoutputselector.c index 531c3d924..2f5b341d3 100644 --- a/plugins/elements/gstoutputselector.c +++ b/plugins/elements/gstoutputselector.c @@ -47,12 +47,6 @@ GST_STATIC_PAD_TEMPLATE ("src_%u", GST_PAD_REQUEST, GST_STATIC_CAPS_ANY); -enum GstOutputSelectorPadNegotiationMode -{ - GST_OUTPUT_SELECTOR_PAD_NEGOTIATION_MODE_NONE, - GST_OUTPUT_SELECTOR_PAD_NEGOTIATION_MODE_ALL, - GST_OUTPUT_SELECTOR_PAD_NEGOTIATION_MODE_ACTIVE -}; #define GST_TYPE_OUTPUT_SELECTOR_PAD_NEGOTIATION_MODE (gst_output_selector_pad_negotiation_mode_get_type()) static GType gst_output_selector_pad_negotiation_mode_get_type (void) diff --git a/plugins/elements/gstoutputselector.h b/plugins/elements/gstoutputselector.h index 360e16e0c..c39c5b159 100644 --- a/plugins/elements/gstoutputselector.h +++ b/plugins/elements/gstoutputselector.h @@ -61,6 +61,25 @@ struct _GstOutputSelectorClass { GstElementClass parent_class; }; +/** + * GstOutputSelectorPadNegotiationMode: + * @GST_OUTPUT_SELECTOR_PAD_NEGOTIATION_MODE_NONE: don't propagate the input + * stream. + * @GST_OUTPUT_SELECTOR_PAD_NEGOTIATION_MODE_ALL: direct input stream to all + * output pads. + * @GST_OUTPUT_SELECTOR_PAD_NEGOTIATION_MODE_ACTIVE: direct input stream to the + * currently active output pad as described by the #GstOutputSelector:active-pad + * property. + * + * To what output pad the input stream should be directed. + */ +typedef enum +{ + GST_OUTPUT_SELECTOR_PAD_NEGOTIATION_MODE_NONE, + GST_OUTPUT_SELECTOR_PAD_NEGOTIATION_MODE_ALL, + GST_OUTPUT_SELECTOR_PAD_NEGOTIATION_MODE_ACTIVE +} GstOutputSelectorPadNegotiationMode; + G_GNUC_INTERNAL GType gst_output_selector_get_type (void); G_END_DECLS |