diff --git a/ChangeLog b/ChangeLog index 72da4bb733..03bfc50f19 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,13 @@ +2005-11-23 Wim Taymans + + * docs/gst/gstreamer-sections.txt: + * gst/glib-compat.c: + * gst/gsttagsetter.c: + * gst/gstvalue.c: + * gst/net/gstnetclientclock.c: + * gst/net/gstnettimepacket.h: + Doc updates. + 2005-11-23 Thomas Vander Stichele * docs/faq/using.xml: diff --git a/docs/gst/gstreamer-sections.txt b/docs/gst/gstreamer-sections.txt index 55abfd83d3..4fe3ebd9ef 100644 --- a/docs/gst/gstreamer-sections.txt +++ b/docs/gst/gstreamer-sections.txt @@ -32,7 +32,6 @@ sync_cond thread_list -
gstbin GstBin @@ -352,8 +351,6 @@ GST_CLOCK_BROADCAST GST_CLOCK_COND GST_CLOCK_TIMED_WAIT GST_CLOCK_WAIT -GST_CLOCK_SLAVE_LOCK -GST_CLOCK_SLAVE_UNLOCK gst_clock_add_observation gst_clock_set_master gst_clock_get_master @@ -389,6 +386,8 @@ GST_TYPE_CLOCK_FLAGS GST_TYPE_CLOCK_RETURN GST_TYPE_CLOCK_TIME +GST_CLOCK_SLAVE_LOCK +GST_CLOCK_SLAVE_UNLOCK gst_clock_get_type gst_clock_entry_type_get_type gst_clock_flags_get_type @@ -401,9 +400,11 @@ gst_clock_return_get_type GstCompat +g_mkdir_with_parents +gst_flags_get_first_value +g_value_dup_gst_object
-
gstconfig @@ -1664,7 +1665,6 @@ gst_segment_clip gst_segment_init gst_segment_new gst_segment_free -gst_segment_get_type gst_segment_set_duration gst_segment_set_last_stop gst_segment_set_newsegment @@ -1673,6 +1673,7 @@ gst_segment_to_running_time gst_segment_to_stream_time GST_TYPE_SEGMENT +gst_segment_get_type
diff --git a/gst/glib-compat.c b/gst/glib-compat.c index b06955ceb8..905862b491 100644 --- a/gst/glib-compat.c +++ b/gst/glib-compat.c @@ -141,9 +141,18 @@ g_mkdir_with_parents (const gchar * pathname, int mode) #endif -/* This version is copied from GLib 2.8. +/** + * gst_flags_get_first_value: + * @flags_class: a #GFlagsClass + * @value: the value + * + * Returns the first GFlagsValue which is set in value. + * + * This version is copied from GLib 2.8. * In GLib 2.6, it didn't check for a flag value being NULL, hence it * hits an infinite loop in our flags serialize function + * + * Returns: the first GFlagsValue which is set in value, or NULL if none is set. */ GFlagsValue * gst_flags_get_first_value (GFlagsClass * flags_class, guint value) @@ -172,6 +181,16 @@ gst_flags_get_first_value (GFlagsClass * flags_class, guint value) /* Adapted from g_value_dup_object to use gst_object_ref */ #include "gstobject.h" +/** + * g_value_dup_gst_object: + * @value: the #GstObject value to dup + * + * Get the contents of a G_TYPE_OBJECT derived GValue, increasing its reference count. + * This function exists because of unsafe reference counting in old glib versions. + * + * Returns: object content of value, should be unreferenced with gst_object_unref() + * when no longer needed. + */ GObject * g_value_dup_gst_object (const GValue * value) { diff --git a/gst/gsttagsetter.c b/gst/gsttagsetter.c index d28352afde..2e8d563eb5 100644 --- a/gst/gsttagsetter.c +++ b/gst/gsttagsetter.c @@ -180,7 +180,7 @@ gst_tag_setter_add_tag_values (GstTagSetter * setter, GstTagMergeMode mode, } /** - * gst_tag_setter_tag_add_valist: + * gst_tag_setter_add_tag_valist: * @setter: a #GstTagSetter * @mode: the mode to use * @tag: tag to set diff --git a/gst/gstvalue.c b/gst/gstvalue.c index 7e070010c5..3799ab23ad 100644 --- a/gst/gstvalue.c +++ b/gst/gstvalue.c @@ -1032,6 +1032,17 @@ gst_value_set_fraction_range (GValue * value, const GValue * start, g_value_copy (end, &vals[1]); } +/** + * gst_value_set_fraction_range_full: + * @value: a GValue initialized to GST_TYPE_FRACTION_RANGE + * @numerator_start: the numerator start of the range + * @denominator_start: the denominator start of the range + * @numerator_end: the numerator end of the range + * @denominator_end: the denominator end of the range + * + * Sets @value to the range specified by @numerator_start/@denominator_start + * and @numerator_end/@denominator_end. + */ void gst_value_set_fraction_range_full (GValue * value, int numerator_start, int denominator_start, diff --git a/gst/net/gstnetclientclock.c b/gst/net/gstnetclientclock.c index 47b2dd841b..20e883ea2e 100644 --- a/gst/net/gstnetclientclock.c +++ b/gst/net/gstnetclientclock.c @@ -496,6 +496,20 @@ gst_net_client_clock_stop (GstNetClientClock * self) } } +/** + * gst_net_client_clock_new: + * @name: a name for the clock + * @remote_address: the address of the remote clock provider + * @remote_port: the port of the remote clock provider + * @base_time: initial time of the clock + * + * Create a new #GstNetClientClock that will report the time + * provided by the #GstNetClockProvider on @remote_address and + * @remote_port. + * + * Returns: a new #GstClock that receives a time from the remote + * clock. + */ GstClock * gst_net_client_clock_new (gchar * name, const gchar * remote_address, gint remote_port, GstClockTime base_time) diff --git a/gst/net/gstnettimepacket.h b/gst/net/gstnettimepacket.h index 10a0d163d1..3a92a0232c 100644 --- a/gst/net/gstnettimepacket.h +++ b/gst/net/gstnettimepacket.h @@ -33,10 +33,22 @@ G_BEGIN_DECLS #include #include +/** + * GST_NET_TIME_PACKET_SIZE: + * + * The size of the packets sent between network clocks. + */ #define GST_NET_TIME_PACKET_SIZE 16 typedef struct _GstNetTimePacket GstNetTimePacket; +/** + * GstNetTimePacket: + * @local_time: the local time when this packet was sent + * @remote_time: the remote time observation + * + * Content of a #GstNetTimePacket. + */ struct _GstNetTimePacket { GstClockTime local_time; GstClockTime remote_time; diff --git a/libs/gst/net/gstnetclientclock.c b/libs/gst/net/gstnetclientclock.c index 47b2dd841b..20e883ea2e 100644 --- a/libs/gst/net/gstnetclientclock.c +++ b/libs/gst/net/gstnetclientclock.c @@ -496,6 +496,20 @@ gst_net_client_clock_stop (GstNetClientClock * self) } } +/** + * gst_net_client_clock_new: + * @name: a name for the clock + * @remote_address: the address of the remote clock provider + * @remote_port: the port of the remote clock provider + * @base_time: initial time of the clock + * + * Create a new #GstNetClientClock that will report the time + * provided by the #GstNetClockProvider on @remote_address and + * @remote_port. + * + * Returns: a new #GstClock that receives a time from the remote + * clock. + */ GstClock * gst_net_client_clock_new (gchar * name, const gchar * remote_address, gint remote_port, GstClockTime base_time) diff --git a/libs/gst/net/gstnettimepacket.h b/libs/gst/net/gstnettimepacket.h index 10a0d163d1..3a92a0232c 100644 --- a/libs/gst/net/gstnettimepacket.h +++ b/libs/gst/net/gstnettimepacket.h @@ -33,10 +33,22 @@ G_BEGIN_DECLS #include #include +/** + * GST_NET_TIME_PACKET_SIZE: + * + * The size of the packets sent between network clocks. + */ #define GST_NET_TIME_PACKET_SIZE 16 typedef struct _GstNetTimePacket GstNetTimePacket; +/** + * GstNetTimePacket: + * @local_time: the local time when this packet was sent + * @remote_time: the remote time observation + * + * Content of a #GstNetTimePacket. + */ struct _GstNetTimePacket { GstClockTime local_time; GstClockTime remote_time;