From f0ab7ce1bffa1e0abae51702897725c1a4ea5ea8 Mon Sep 17 00:00:00 2001
From: =?utf8?q?Olivier=20Cr=C3=AAte?= <olivier.crete@collabora.com>
Date: Thu, 14 Feb 2013 13:38:07 -0500
Subject: [PATCH] docs: Generate docs for GstRTSPAddressPool

---
 docs/libs/gst-rtsp-server-docs.sgml    |  1 +
 docs/libs/gst-rtsp-server-sections.txt | 22 ++++++++++++++++++++++
 gst/rtsp-server/rtsp-address-pool.c    |  4 ++++
 gst/rtsp-server/rtsp-address-pool.h    |  1 +
 4 files changed, 28 insertions(+)

diff --git a/docs/libs/gst-rtsp-server-docs.sgml b/docs/libs/gst-rtsp-server-docs.sgml
index 5e02299..4f19697 100644
--- a/docs/libs/gst-rtsp-server-docs.sgml
+++ b/docs/libs/gst-rtsp-server-docs.sgml
@@ -25,6 +25,7 @@
     <xi:include href="xml/rtsp-server.xml"/>
     <xi:include href="xml/rtsp-session-pool.xml"/>
     <xi:include href="xml/rtsp-session.xml"/>
+    <xi:include href="xml/rtsp-address-pool.xml"/>
   </chapter>
 
   <!-- <chapter> -->
diff --git a/docs/libs/gst-rtsp-server-sections.txt b/docs/libs/gst-rtsp-server-sections.txt
index 0122798..7bb58df 100644
--- a/docs/libs/gst-rtsp-server-sections.txt
+++ b/docs/libs/gst-rtsp-server-sections.txt
@@ -353,3 +353,25 @@ GST_TYPE_RTSP_STREAM_TRANSPORT
 gst_rtsp_stream_transport_get_type
 </SECTION>
 
+<SECTION>
+<FILE>rtsp-address-pool</FILE>
+<TITLE>GstRTSPAddressPool</TITLE>
+GstRTSPAddressPool
+gst_rtsp_address_pool_new
+gst_rtsp_address_pool_add_range
+gst_rtsp_address_pool_clear
+gst_rtsp_address_pool_dump
+gst_rtsp_address_pool_acquire_address
+gst_rtsp_address_pool_reserve_address
+<SUBSECTION Standard>
+GstRTSPAddressPoolClass
+GstRTSPAddressPoolPrivate
+gst_rtsp_address_get_type
+gst_rtsp_address_pool_get_type
+<SUBSECTION Private>
+GstRTSPAddress
+GstRTSPAddressClass
+GstRTSPAddressFlags
+gst_rtsp_address_copy
+gst_rtsp_address_free
+</SECTION>
diff --git a/gst/rtsp-server/rtsp-address-pool.c b/gst/rtsp-server/rtsp-address-pool.c
index 54fe834..b064cf7 100644
--- a/gst/rtsp-server/rtsp-address-pool.c
+++ b/gst/rtsp-server/rtsp-address-pool.c
@@ -372,6 +372,8 @@ split_range (GstRTSPAddressPool * pool, AddrRange * range, guint skip_addr,
  * allocation. @n_ports consecutive ports will be allocated of which the first
  * one can be found in @port.
  *
+ * This function should only be used internally.
+ *
  * Returns: a #GstRTSPAddress that should be freed with gst_rtsp_address_free
  *   after use or %NULL when no address could be acquired.
  */
@@ -540,6 +542,8 @@ gst_rtsp_address_pool_dump (GstRTSPAddressPool * pool)
  * ports will be allocated of which the first one can be found in
  * @port.
  *
+ * This function should only be used internally.
+ *
  * Returns: a #GstRTSPAddress that should be freed with gst_rtsp_address_free
  *   after use or %NULL when no address could be acquired.
  */
diff --git a/gst/rtsp-server/rtsp-address-pool.h b/gst/rtsp-server/rtsp-address-pool.h
index 2f7a80a..001b397 100644
--- a/gst/rtsp-server/rtsp-address-pool.h
+++ b/gst/rtsp-server/rtsp-address-pool.h
@@ -67,6 +67,7 @@ typedef enum {
  * GstRTSPAddressPool:
  * @parent: the parent GObject
  *
+ * An address pool, all member are prive
  */
 struct _GstRTSPAddressPool {
   GObject       parent;
-- 
2.7.4