doc: Add GstNtpPacket to the doc
authorNicolas Dufresne <nicolas.dufresne@collabora.co.uk>
Sat, 13 Jun 2015 18:21:41 +0000 (14:21 -0400)
committerNicolas Dufresne <nicolas.dufresne@collabora.co.uk>
Sat, 13 Jun 2015 18:21:41 +0000 (14:21 -0400)
docs/libs/gstreamer-libs-docs.sgml
docs/libs/gstreamer-libs-sections.txt
libs/gst/net/gstntppacket.c

index 406d6064e9baac01132738294499569ccfbe325a..675c8a9ae4d3bcba249fc2d3d521c3364cccb521 100644 (file)
@@ -77,6 +77,7 @@
       <xi:include href="xml/gstnettimepacket.xml" />
       <xi:include href="xml/gstnettimeprovider.xml" />
       <xi:include href="xml/gstptpclock.xml" />
+      <xi:include href="xml/gstntppacket.xml" />
     </chapter>
 
     <chapter id="gstreamer-check">
index 5e8357d5b204639a296ac3fcec3bb7a35ad4cac4..f31f2e337cb45811a7aea8c6ea11fcd52158f441 100644 (file)
@@ -953,6 +953,22 @@ GST_IS_NET_TIME_PROVIDER_CLASS
 gst_net_time_provider_get_type
 </SECTION>
 
+<SECTION>
+<FILE>gstntppacket</FILE>
+<TITLE>GstNtpPacket</TITLE>
+GstNtpPacket
+gst_ntp_packet_new
+gst_ntp_packet_copy
+gst_ntp_packet_free
+gst_ntp_packet_serialize
+gst_ntp_packet_receive
+gst_ntp_packet_send
+GST_NTP_ERROR
+GST_NTP_PACKET_SIZE
+<SUBSECTION Private>
+gst_ntp_packet_get_type
+</SECTION>
+
 <SECTION>
 <FILE>gstptpclock</FILE>
 <TITLE>GstPtpClock</TITLE>
@@ -962,7 +978,7 @@ gst_ptp_deinit
 gst_ptp_is_initialized
 gst_ptp_is_supported
 
-GstPtpClock
+/GstPtpClock
 gst_ptp_clock_new
 
 gst_ptp_statistics_callback_add
index 699f72bb856221d3d54d2cc23d2d2025f0a79883..e9d77b0ae2a4167516bd05977b4578ba44875859 100644 (file)
@@ -23,7 +23,7 @@
  * SECTION:gstntppacket
  * @short_description: Helper structure to construct clock packets used
  *                     by network clocks for NTPv4.
- * @see_also: #GstClock, #GstNetClientClock, #GstNtpProvider
+ * @see_also: #GstClock, #GstNetClientClock, #GstNtpClock
  *
  * Various functions for receiving, sending an serializing #GstNtpPacket
  * structures.
@@ -79,6 +79,7 @@ gst_clock_time_to_ntp_timestamp_fraction (GstClockTime gst)
 /**
  * gst_ntp_packet_new:
  * @buffer: (array): a buffer from which to construct the packet, or NULL
+ * @error: a #GError
  *
  * Creates a new #GstNtpPacket from a buffer received over the network. The
  * caller is responsible for ensuring that @buffer is at least